public interface DynamicClient
Modifier and Type | Interface and Description |
---|---|
static class |
DynamicClient.Status
Status codes to handle error conditions with dynamically registered clients.
|
Modifier and Type | Method and Description |
---|---|
DynamicClient.Status |
addClientMetadataValues(String key,
List<String> values)
Set a new client metadata value.
|
void |
generateSecret(int length)
Generate a random alphanumeric secret to be used for authentication.
|
String |
getCibaDeliveryMode()
Returns the CIBA token delivery mode.
|
String |
getCibaNotificationEndpoint()
Returns the CIBA notification endpoint.
|
String |
getCibaRequestObjectSigningAlgorithm()
Returns the allowed CIBA Request Object signing algorithm.
|
String |
getClientAuthenticationType()
Returns the specified
ClientAuthType as a String . |
String |
getClientCertIssuerDn()
Returns the allowed Issuer DN of the client's certificate used for authentication.
|
String |
getClientCertSubjectDn()
Returns the allowed Subject DN of the client's certificate used for authentication.
|
String |
getClientId()
Returns the ID of the client.
|
Set<String> |
getClientMetadataKeys()
Returns a
Set of metadata keys containing both internal keys and defined extended metadata. |
List<String> |
getClientMetadataValues(String key)
Returns client metadata values for a given key.
|
Set<String> |
getGrantTypes()
Returns the client's allowed
Set of grant types. |
String |
getIdTokenContentEncryptionAlgorithm()
Returns the client's ID Token content encryption algorithm.
|
String |
getIdTokenEncryptionAlgorithm()
Returns the client's ID Token encryption algorithm.
|
String |
getIdTokenSigningAlgorithm()
Returns the client's ID Token signing algorithm.
|
String |
getJwks()
Returns the client's JWKS for JWT validation.
|
String |
getJwksUrl()
Returns the client's JWKS URL for JWT validation.
|
String |
getLogoUrl()
Returns the client's logo URL.
|
String |
getName()
Returns the name of client.
|
List<String> |
getRedirectUris()
Returns the client's
List of redirect URIs. |
String |
getRequestObjectSigningAlgorithm()
Returns the allowed Request Object signing algorithm.
|
List<String> |
getRestrictedResponseTypes()
Returns the client's restricted response types
|
List<String> |
getScopes()
Returns the client's
List of scopes. |
String |
getSecret()
Returns the client's secret used for authentication.
|
String |
getSectorIdentifierUri()
Returns the Sector Identifier URI.
|
String |
getSoftwareStatement()
Returns the software statement of the client.
|
String |
getTokenEndpointAuthSigningAlgorithm()
Returns the allowed JWT Token Endpoint authentication signing algorithm.
|
boolean |
isCibaSupportUserCode()
Returns whether the client supports the user_code parameter.
|
boolean |
isPairwiseUserType()
Returns whether the client uses Pairwise Pseudononymous Identifiers (PPID) for the subject.
|
boolean |
isRequireSignedRequests()
Indicates whether the new client requires a signed request object.
|
void |
setCibaDeliveryMode(String mode)
Sets the CIBA token delivery mode.
|
void |
setCibaNotificationEndpoint(String endpoint)
Sets the CIBA notification endpoint.
|
void |
setCibaRequestObjectSigningAlgorithm(String algorithm)
Sets the allowed CIBA Request Object signing algorithm.
|
void |
setCibaSupportUserCode(boolean supportUserCode)
Sets whether the client supports the user_code parameter.
|
DynamicClient.Status |
setClientAuthenticationType(String authenticationType)
Set the value of the client authentication type.
|
void |
setClientCertIssuerDn(String clientCertIssuerDn)
Set the allowed Issuer DN of the client's certificate used for authentication.
|
void |
setClientCertSubjectDn(String clientCertSubjectDn)
Set the allowed Subject DN of the client's certificate used for authentication.
|
void |
setGrantTypes(Set<String> grantTypes)
Set the client's allowed
Set of grant types. |
void |
setIdTokenContentEncryptionAlgorithm(String algorithm)
Set the client's ID Token content encryption algorithm.
|
void |
setIdTokenEncryptionAlgorithm(String algorithm)
Set the client's ID Token encryption algorithm.
|
void |
setIdTokenSigningAlgorithm(String algorithm)
Set the client's ID Token signing algorithm.
|
void |
setJwks(String jwks)
Set the client's JWKS for JWT validation.
|
void |
setJwksUrl(String jwksUrl)
Set the client's JWKS URL for JWT validation.
|
void |
setLogoUrl(String logoUrl)
Set value of client's logo URL.
|
void |
setName(String name)
Set the name of the client.
|
void |
setPairwiseUserType(boolean pairwiseUserType)
Sets whether the client uses Pairwise Pseudononymous Identifiers (PPID) for the subject.
|
void |
setRedirectUris(List<String> redirectUris)
Set the client's redirect URIs.
|
void |
setRequestObjectSigningAlgorithm(String algorithm)
Sets the allowed Request Object signing algorithm.
|
void |
setRestrictedResponseTypes(List<String> restrictedResponseTypes)
Set the client's restricted response types
|
void |
setScopes(List<String> scopes)
Set the client's
List of scopes. |
void |
setSecret(String secret)
Set the client's secret for authentication.
|
void |
setSectorIdentifierUri(String sectorIdentifierUri)
Sets the Sector Identifier URI.
|
void |
setTokenEndpointAuthSigningAlgorithm(String algorithm)
Set the allowed JWT Token Endpoint authentication signing algorithm.
|
String getClientId()
String getName()
void setName(String name)
name
- New client name.String getSoftwareStatement()
String getClientAuthenticationType()
ClientAuthType
as a String
.ClientAuthType
as a String
.DynamicClient.Status setClientAuthenticationType(String authenticationType)
authenticationType
- New ClientAuthType
value.DynamicClient.Status.SUCCESS
if successful, alternatively a DynamicClient.Status.FAILURE
for an invalid type.String getClientCertIssuerDn()
void setClientCertIssuerDn(String clientCertIssuerDn)
clientCertIssuerDn
- New Issuer DN of the client's certificate used for authentication.String getClientCertSubjectDn()
void setClientCertSubjectDn(String clientCertSubjectDn)
clientCertSubjectDn
- New Subject DN of the client's certificate used for authentication.String getJwksUrl()
void setJwksUrl(String jwksUrl)
jwksUrl
- New JWKS URL for JWT validation.String getJwks()
void setJwks(String jwks)
jwks
- New JWKS for JWT validation.String getSecret()
void setSecret(String secret)
secret
- New client secret used for authentication.void generateSecret(int length)
length
- The length (in characters) of the random secret.String getTokenEndpointAuthSigningAlgorithm()
void setTokenEndpointAuthSigningAlgorithm(String algorithm)
algorithm
- The allowed signing algorithmList<String> getRedirectUris()
List
of redirect URIs.List
of redirect URIs.void setRedirectUris(List<String> redirectUris)
redirectUris
- New List
of redirect URIs.Set<String> getGrantTypes()
Set
of grant types.Set
of grant types allowed by the client.void setGrantTypes(Set<String> grantTypes)
Set
of grant types.grantTypes
- New Set
of grant types allowed by the client.void setScopes(List<String> scopes)
List
of scopes.scopes
- New List
of scopes.String getIdTokenSigningAlgorithm()
void setIdTokenSigningAlgorithm(String algorithm)
algorithm
- New ID Token signing algorithm for the client.String getIdTokenEncryptionAlgorithm()
void setIdTokenEncryptionAlgorithm(String algorithm)
algorithm
- New ID Token encryption algorithm for the client.String getIdTokenContentEncryptionAlgorithm()
void setIdTokenContentEncryptionAlgorithm(String algorithm)
algorithm
- New ID Token content encryption algorithm for the client.String getLogoUrl()
void setLogoUrl(String logoUrl)
logoUrl
- New URL for the client's logo.Set<String> getClientMetadataKeys()
Set
of metadata keys containing both internal keys and defined extended metadata.Set
of metadata keys.List<String> getClientMetadataValues(String key)
DynamicClient.Status addClientMetadataValues(String key, List<String> values)
List
contain
more than one element then DynamicClient.Status.MULTI_VALUE_NOT_ALLOWED
is returned and the value is not stored.key
- A client metadata key.values
- A List
of values.DynamicClient.Status.SUCCESS
if successful, DynamicClient.Status.INVALID_KEY
if the key is not valid,
DynamicClient.Status.MULTI_VALUE_NOT_ALLOWED
if values contains multiple entries and it's not valid.List<String> getRestrictedResponseTypes()
List
of restricted response typesvoid setRestrictedResponseTypes(List<String> restrictedResponseTypes)
restrictedResponseTypes
- New List
of restricted response typesboolean isRequireSignedRequests()
String getRequestObjectSigningAlgorithm()
void setRequestObjectSigningAlgorithm(String algorithm)
algorithm
- The allowed signing algorithmString getCibaDeliveryMode()
void setCibaDeliveryMode(String mode)
mode
- the CIBA token delivery mode.String getCibaNotificationEndpoint()
void setCibaNotificationEndpoint(String endpoint)
endpoint
- the endpoint at which the OP will post a notification after a successful or failed end-user authentication.boolean isCibaSupportUserCode()
void setCibaSupportUserCode(boolean supportUserCode)
supportUserCode
- whether the client supports the user_code parameter.boolean isPairwiseUserType()
void setPairwiseUserType(boolean pairwiseUserType)
pairwiseUserType
- whether the client supports the user_code parameter.String getSectorIdentifierUri()
void setSectorIdentifierUri(String sectorIdentifierUri)
sectorIdentifierUri
- the Sector Identifier URI.String getCibaRequestObjectSigningAlgorithm()
void setCibaRequestObjectSigningAlgorithm(String algorithm)
algorithm
- The allowed CIBA signing algorithmCopyright 2019 Ping Identity Corp. All rights reserved.