Class Client
java.lang.Object
io.jans.orm.model.base.Entry
io.jans.orm.model.base.BaseEntry
io.jans.orm.model.base.DeletableEntity
io.jans.as.common.model.registration.Client
- All Implemented Interfaces:
io.jans.orm.model.base.Deletable,Serializable,Cloneable
- Version:
- October 17, 2022
- Author:
- Javier Rojas Blum
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSet<io.jans.as.model.common.AuthenticationMethod>io.jans.as.model.register.ApplicationTypeReturns the Kind of the application.io.jans.as.model.common.AuthenticationMethodString[]io.jans.as.model.crypto.signature.AsymmetricSignatureAlgorithmio.jans.as.model.common.BackchannelTokenDeliveryModeString[]Returns UMA2 Array of The Claims Redirect URIs to which the client wishes the authorization server to direct the requesting party's user agent after completing its interaction.String[]Returns the Unique Client identifier.Returns the time when the Client Identifier was issued.Returns the name of the Client to be presented to the user.io.jans.orm.model.base.LocalizedStringReturns the name of the Client to be presented to the user represented in a language and a script.Returns the client secret.Returns the time at which the client secret will expire.Returns a URL of the home page of the Client.io.jans.orm.model.base.LocalizedStringReturns a URL of the home page of the Client represented in a language and scriptString[]Returns an Array of e-mail addresses of people responsible for this Client.List<io.jans.orm.model.base.CustomObjectAttribute>String[]String[]Returns the Default requested Authentication Context Class Reference values.Returns the Default Maximum Authentication Age.Gets logout session required.Gets logout uriio.jans.as.model.common.GrantType[]Returns a JSON array containing a list of the OAuth 2.0 grant types that the Client is declaring that it will restrict itself to using.String[]Returns the JWE alg algorithm (JWA) required for encrypting the ID Token.Returns the JWE enc algorithm (JWA) required for symmetric encryption of the ID Token.Returns the JWS alg algorithm (JWA)0 required for the issued ID Token.Returns an URI using the https scheme that the Authorization Server can call to initiate a login at the Client.getJwks()Client's JSON Web Key Set (JWK) document, passed by value.Return the URL for the Client's JSON Web Key (JWK) document containing key(s) that are used for signing requests to the OP.Returns a URL that references a logo for the Client application.io.jans.orm.model.base.LocalizedStringReturns a URL that references a logo for the Client application represented in a language and a script.booleanReturns a URL that the Relying Party Client provides to the End-User to read about how the profile data will be used.io.jans.orm.model.base.LocalizedStringReturns a URL that the Relying Party Client provides to the End-User to read about how the profile data will be used represented in a language and script.String[]Returns an Array of URIs supplied by the RP to request that the user be redirected to this location after a logout has been performed.String[]Returns an Array of redirect URIs values used in the Authorization Code and Implicit grant types.Returns the Access Token that is used by the Client to perform subsequent operations upon the resulting Client registration.Returns the JWE alg algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP.Returns the JWE enc algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP.Returns the JWS alg algorithm (JWA) that must be required by the Authorization Server.String[]Returns an Array of Request URI values that are pre-registered by the Client for use at the Authorization Server.io.jans.as.model.common.ResponseType[]Returns a JSON array containing a list of the OAuth 2.0 response type values that the Client is declaring that it will restrict itself to using.String[]Return an URL using the HTTPS scheme to be used in calculating Pseudonymous Identifiers by the OP.io.jans.as.model.common.SubjectTypeReturns the Subject type requested for the Client ID.Returns the Requested authentication method for the Token Endpoint.Returns the Requested Client Authentication method for the Token Endpoint.Returns a URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service.io.jans.orm.model.base.LocalizedStringReturns a URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service represented in a language and script.booleangetTtl()Returns the JWE alg algorithm (JWA) required for encrypting UserInfo Responses.Returns the JWE enc algorithm (JWA) required for symmetric encryption of UserInfo Responses.Returns the JWS alg algorithm (JWA) required for UserInfo Responses.booleanhasAuthenticationMethod(io.jans.as.model.common.AuthenticationMethod authenticationMethod) booleanbooleanbooleanbooleanbooleanvoidsetAccessTokenAsJwt(boolean accessTokenAsJwt) voidsetAccessTokenLifetime(Integer accessTokenLifetime) voidsetAccessTokenSigningAlg(String accessTokenSigningAlg) voidsetApplicationType(io.jans.as.model.register.ApplicationType applicationType) Sets the Kind of the application.voidsetAttributes(ClientAttributes attributes) voidsetAuthorizedOrigins(String[] authorizedOrigins) voidsetBackchannelAuthenticationRequestSigningAlg(io.jans.as.model.crypto.signature.AsymmetricSignatureAlgorithm backchannelAuthenticationRequestSigningAlg) voidsetBackchannelClientNotificationEndpoint(String backchannelClientNotificationEndpoint) voidsetBackchannelTokenDeliveryMode(io.jans.as.model.common.BackchannelTokenDeliveryMode backchannelTokenDeliveryMode) voidsetBackchannelUserCodeParameter(Boolean backchannelUserCodeParameter) voidsetClaimRedirectUris(String[] claimRedirectUris) Sets Claim redirect URIsvoidvoidsetClientId(String clientId) Sets the Unique Client identifier.voidsetClientIdIssuedAt(Date clientIdIssuedAt) Sets the time then the Client Identifier was issued.voidsetClientName(String clientName) Sets the name of the Client to be presented to the user.voidsetClientNameLocalized(io.jans.orm.model.base.LocalizedString clientNameLocalized) voidsetClientNameLocalized(String clientName) Sets the name of the Client to be presented to the user.voidsetClientNameLocalized(String clientName, Locale locale) Sets the name of the Client to be presented to the user represented in a language and a script.voidsetClientSecret(String clientSecret) Sets the client secret.voidsetClientSecretExpiresAt(Date clientSecretExpiresAt) Sets the time at which the client secret will expire.voidsetClientUri(String clientUri) Sets a URL of the home page of the Client.voidsetClientUriLocalized(io.jans.orm.model.base.LocalizedString clientUriLocalized) voidsetClientUriLocalized(String clientUri) Sets a URL of the home page of the Client.voidsetClientUriLocalized(String clientUri, Locale locale) Sets a URL of the home page of the Client represented in a language and script.voidsetContacts(String[] contacts) Sets an Array of e-mail addresses of people responsible for this Client.voidsetCustomAttributes(List<io.jans.orm.model.base.CustomObjectAttribute> customAttributes) voidsetCustomObjectClasses(String[] customObjectClasses) voidsetDefaultAcrValues(String[] defaultAcrValues) Sets the Default requested Authentication Context Class Reference values.voidsetDefaultMaxAge(Integer defaultMaxAge) Sets the Default Maximum Authentication Age.voidsetDescription(String description) voidsetDisabled(boolean disabled) voidsetDisplayName(String displayName) voidsetFrontChannelLogoutSessionRequired(Boolean frontChannelLogoutSessionRequired) Sets frontchannel logout session required.voidsetFrontChannelLogoutUri(String frontChannelLogoutUri) Sets logout uri.voidsetGrantTypes(io.jans.as.model.common.GrantType[] grantTypes) Sets a JSON array containing a list of the OAuth 2.0 grant types that the Client is declaring that it will restrict itself to using.voidvoidsetIdTokenEncryptedResponseAlg(String idTokenEncryptedResponseAlg) Sets the JWE alg algorithm (JWA) required for encrypting the ID Token.voidsetIdTokenEncryptedResponseEnc(String idTokenEncryptedResponseEnc) Sets the JWE enc algorithm (JWA) required for symmetric encryption of the ID Token.voidsetIdTokenSignedResponseAlg(String idTokenSignedResponseAlg) Sets the JWS alg algorithm (JWA)0 required for the issued ID Token.voidsetIdTokenTokenBindingCnf(String idTokenTokenBindingCnf) voidsetIncludeClaimsInIdToken(boolean includeClaimsInIdToken) voidsetInitiateLoginUri(String initiateLoginUri) Sets an URI using the https scheme that the Authorization Server can call to initiate a login at the Client.voidClient's JSON Web Key Set (JWK) document, passed by value.voidsetJwksUri(String jwksUri) Sets the URL for the Client's JSON Web Key (JWK) document containing key(s) that are used for signing requests to the OP.voidsetLastAccessTime(Date lastAccessTime) voidsetLastLogonTime(Date lastLogonTime) voidsetLogoUri(String logoUri) Sets a URL that references a logo for the Client application.voidsetLogoUriLocalized(io.jans.orm.model.base.LocalizedString logoUriLocalized) voidsetLogoUriLocalized(String logoUri) Sets a URL that references a logo for the Client application.voidsetLogoUriLocalized(String logoUri, Locale locale) Sets a URL that references a logo for the Client application represented in a language and script.voidsetOrganization(String organization) voidsetPersistClientAuthorizations(boolean persistClientAuthorizations) voidsetPolicyUri(String policyUri) Sets a URL that the Relying Party Client provides to the End-User to read about how the profile data will be used.voidsetPolicyUriLocalized(io.jans.orm.model.base.LocalizedString policyUriLocalized) voidsetPolicyUriLocalized(String policyUri) Sets a URL that the Relying Party Client provides to the End-User to read about how the profile data will be used.voidsetPolicyUriLocalized(String policyUri, Locale locale) Sets a URL that the Relying Party Client provides to the End-User to read about how the profile data will be used represented in a language and script.voidsetPostLogoutRedirectUris(String[] postLogoutRedirectUris) Sets an Array of URIs supplied by the RP to request that the user be redirected to this location after a logout has been performed.voidsetRedirectUris(String[] redirectUris) Sets an Array of redirect URIs values used in the Authorization Code and Implicit grant types.voidsetRefreshTokenLifetime(Integer refreshTokenLifetime) voidsetRegistrationAccessToken(String registrationAccessToken) Sets the Access Token that is used by the Client to perform subsequent operations upon the resulting Client registration.voidsetRequestObjectEncryptionAlg(String requestObjectEncryptionAlg) Sets the JWE alg algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP.voidsetRequestObjectEncryptionEnc(String requestObjectEncryptionEnc) Sets the JWE enc algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP.voidsetRequestObjectSigningAlg(String requestObjectSigningAlg) Sets the JWS alg algorithm (JWA) that must be required by the Authorization Server.voidsetRequestUris(String[] requestUris) Sets an Array of Request URI values that are pre-registered by the Client for use at the Authorization Server.voidsetResponseTypes(io.jans.as.model.common.ResponseType[] responseTypes) Sets a JSON array containing a list of the OAuth 2.0 response type values that the Client is declaring that it will restrict itself to using.voidsetRptAsJwt(boolean rptAsJwt) voidvoidsetSectorIdentifierUri(String sectorIdentifierUri) Sets an URL using the HTTPS scheme to be used in calculating Pseudonymous Identifiers by the OP.voidsetSoftwareId(String softwareId) voidsetSoftwareStatement(String softwareStatement) voidsetSoftwareVersion(String jsSoftVer) voidsetSubjectType(io.jans.as.model.common.SubjectType subjectType) Sets the Subject type quested for the Client ID.voidsetTokenEndpointAuthMethod(String tokenEndpointAuthMethod) Sets the Requested authentication method for the Token Endpoint.voidsetTokenEndpointAuthSigningAlg(String tokenEndpointAuthSigningAlg) Sets the Requested Client Authentication method for the Token Endpoint.voidSets a URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service.voidsetTosUriLocalized(io.jans.orm.model.base.LocalizedString tosUriLocalized) voidsetTosUriLocalized(String tosUri) Sets a URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service.voidsetTosUriLocalized(String tosUri, Locale locale) Sets a URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service represented in a language and script.voidsetTrustedClient(boolean trustedClient) voidvoidsetUserInfoEncryptedResponseAlg(String userInfoEncryptedResponseAlg) Sets the JWE alg algorithm (JWA) required for encrypting UserInfo Responses.voidsetUserInfoEncryptedResponseEnc(String userInfoEncryptedResponseEnc) Sets the JWE enc algorithm (JWA) required for symmetric encryption of UserInfo Responses.voidsetUserInfoSignedResponseAlg(String userInfoSignedResponseAlg) Sets the JWS alg algorithm (JWA) required for UserInfo Responses.Methods inherited from class io.jans.orm.model.base.DeletableEntity
canDelete, canDelete, getExpirationDate, isDeletable, setDeletable, setExpirationDate, toStringMethods inherited from class io.jans.orm.model.base.BaseEntry
getDNsMethods inherited from class io.jans.orm.model.base.Entry
equals, getBaseDn, getDn, hashCode, setBaseDn, setDn
-
Constructor Details
-
Client
public Client()
-
-
Method Details
-
getGroups
-
setGroups
-
getOrganization
-
setOrganization
-
getAttributes
-
setAttributes
-
getTtl
-
setTtl
-
isRptAsJwt
public boolean isRptAsJwt() -
setRptAsJwt
public void setRptAsJwt(boolean rptAsJwt) -
isAccessTokenAsJwt
public boolean isAccessTokenAsJwt() -
setAccessTokenAsJwt
public void setAccessTokenAsJwt(boolean accessTokenAsJwt) -
getAccessTokenSigningAlg
-
setAccessTokenSigningAlg
-
getAuthenticationMethod
public io.jans.as.model.common.AuthenticationMethod getAuthenticationMethod() -
hasAuthenticationMethod
public boolean hasAuthenticationMethod(io.jans.as.model.common.AuthenticationMethod authenticationMethod) -
getAllAuthenticationMethods
-
getFrontChannelLogoutSessionRequired
Gets logout session required.- Returns:
- logout session required
-
setFrontChannelLogoutSessionRequired
Sets frontchannel logout session required.- Parameters:
frontChannelLogoutSessionRequired- frontchannel logout session required
-
getFrontChannelLogoutUri
Gets logout uri- Returns:
- logout uri
-
setFrontChannelLogoutUri
Sets logout uri.- Parameters:
frontChannelLogoutUri- logout uri
-
getClientId
Returns the Unique Client identifier.- Returns:
- The Unique Client identifier.
-
setClientId
Sets the Unique Client identifier.- Parameters:
clientId- The client identifier.
-
getClientSecret
Returns the client secret.- Returns:
- The client secret.
-
setClientSecret
Sets the client secret.- Parameters:
clientSecret- The client secret.
-
getRegistrationAccessToken
Returns the Access Token that is used by the Client to perform subsequent operations upon the resulting Client registration.- Returns:
- The registration access token.
-
setRegistrationAccessToken
Sets the Access Token that is used by the Client to perform subsequent operations upon the resulting Client registration.- Parameters:
registrationAccessToken- The registration access token.
-
getClientIdIssuedAt
Returns the time when the Client Identifier was issued.- Returns:
- The Client ID issued at value.
-
setClientIdIssuedAt
Sets the time then the Client Identifier was issued.- Parameters:
clientIdIssuedAt- The Client ID issued at value.
-
getClientSecretExpiresAt
Returns the time at which the client secret will expire.- Returns:
- The Client Secret expiration date.
-
setClientSecretExpiresAt
Sets the time at which the client secret will expire.- Parameters:
clientSecretExpiresAt- The Client Secret expiration date.
-
getRedirectUris
Returns an Array of redirect URIs values used in the Authorization Code and Implicit grant types. One of the these registered redirect URI values must match the Scheme, Host, and Path segments of the Redirect URI parameter value used in each Authorization Request.- Returns:
- The redirect URIs.
-
setRedirectUris
Sets an Array of redirect URIs values used in the Authorization Code and Implicit grant types. One of the these registered redirect URI values must match the Scheme, Host, and Path segments of the Redirect URI parameter value used in each Authorization Request.- Parameters:
redirectUris- The redirect URIs.
-
getClaimRedirectUris
Returns UMA2 Array of The Claims Redirect URIs to which the client wishes the authorization server to direct the requesting party's user agent after completing its interaction. The URI MUST be absolute, MAY contain an application/x-www-form-urlencoded-formatted query parameter component that MUST be retained when adding additional parameters, and MUST NOT contain a fragment component. The client SHOULD pre-register its claims_redirect_uri with the authorization server, and the authorization server SHOULD require all clients to pre-register their claims redirection endpoints. Claims redirection URIs are different from the redirection URIs defined in [RFC6749] in that they are intended for the exclusive use of requesting parties and not resource owners. Therefore, authorization servers MUST NOT redirect requesting parties to pre-registered redirection URIs defined in [RFC6749] unless such URIs are also pre-registered specifically as claims redirection URIs. If the URI is pre-registered, this URI MUST exactly match one of the pre-registered claims redirection URIs, with the matching performed as described in Section 6.2.1 of [RFC3986] (Simple String Comparison).- Returns:
- claims redirect uris
-
setClaimRedirectUris
Sets Claim redirect URIs- Parameters:
claimRedirectUris- claims redirect uris
-
getResponseTypes
public io.jans.as.model.common.ResponseType[] getResponseTypes()Returns a JSON array containing a list of the OAuth 2.0 response type values that the Client is declaring that it will restrict itself to using.- Returns:
- The response types.
-
setResponseTypes
public void setResponseTypes(io.jans.as.model.common.ResponseType[] responseTypes) Sets a JSON array containing a list of the OAuth 2.0 response type values that the Client is declaring that it will restrict itself to using.- Parameters:
responseTypes- The response types.
-
getGrantTypes
public io.jans.as.model.common.GrantType[] getGrantTypes()Returns a JSON array containing a list of the OAuth 2.0 grant types that the Client is declaring that it will restrict itself to using.- Returns:
- The grant types.
-
setGrantTypes
public void setGrantTypes(io.jans.as.model.common.GrantType[] grantTypes) Sets a JSON array containing a list of the OAuth 2.0 grant types that the Client is declaring that it will restrict itself to using.- Parameters:
grantTypes- The grant types.
-
getApplicationType
public io.jans.as.model.register.ApplicationType getApplicationType()Returns the Kind of the application. The default if not specified is web. The defined values are native or web. Web Clients using the OAuth implicit grant type must only register URLs using the https scheme as redirect_uris; they may not use localhost as the hostname. Native Clients must only register redirect_uris using custom URI schemes or URLs using the http: scheme with localhost as the hostname.- Returns:
- The type of the client application.
-
setApplicationType
public void setApplicationType(io.jans.as.model.register.ApplicationType applicationType) Sets the Kind of the application. The default if not specified is web. The defined values are native or web. Web Clients using the OAuth implicit grant type must only register URLs using the https scheme as redirect_uris; they may not use localhost as the hostname. Native Clients must only register redirect_uris using custom URI schemes or URLs using the http: scheme with localhost as the hostname.- Parameters:
applicationType- The type of the client application.
-
getContacts
Returns an Array of e-mail addresses of people responsible for this Client. This may be used by some providers to enable a Web user interface to modify the Client information.- Returns:
- A list of contact email addresses.
-
setContacts
Sets an Array of e-mail addresses of people responsible for this Client. This may be used by some providers to enable a Web user interface to modify the Client information.- Parameters:
contacts- A list of contact email addresses.
-
getIdTokenTokenBindingCnf
-
setIdTokenTokenBindingCnf
-
isTokenBindingSupported
public boolean isTokenBindingSupported() -
getClientName
Returns the name of the Client to be presented to the user.- Returns:
- The name of the Client to be presented to the user.
-
setClientName
Sets the name of the Client to be presented to the user.- Parameters:
clientName- The name of the Client to be presented to the user.
-
getLogoUri
Returns a URL that references a logo for the Client application.- Returns:
- The URL of a logo image for the Client where it can be retrieved.
-
setLogoUri
Sets a URL that references a logo for the Client application.- Parameters:
logoUri- The URL of a logo image for the Client where it can be retrieved.
-
getClientUri
Returns a URL of the home page of the Client.- Returns:
- The URL of the home page of the Client.
-
setClientUri
Sets a URL of the home page of the Client.- Parameters:
clientUri- The URL of the home page of the Client.
-
getPolicyUri
Returns a URL that the Relying Party Client provides to the End-User to read about how the profile data will be used.- Returns:
- A URL location about how the profile data will be used.
-
setPolicyUri
Sets a URL that the Relying Party Client provides to the End-User to read about how the profile data will be used.- Parameters:
policyUri- A URL location about how the profile data will be used.
-
getTosUri
Returns a URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service.- Returns:
- The terms of service URL.
-
setTosUri
Sets a URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service.- Parameters:
tosUri- The terms of service URL.
-
getClientNameLocalized
public io.jans.orm.model.base.LocalizedString getClientNameLocalized()Returns the name of the Client to be presented to the user represented in a language and a script.- Returns:
- The name of the Client to be presented to the user.
-
setClientNameLocalized
public void setClientNameLocalized(io.jans.orm.model.base.LocalizedString clientNameLocalized) -
setLogoUriLocalized
public void setLogoUriLocalized(io.jans.orm.model.base.LocalizedString logoUriLocalized) -
setClientUriLocalized
public void setClientUriLocalized(io.jans.orm.model.base.LocalizedString clientUriLocalized) -
setPolicyUriLocalized
public void setPolicyUriLocalized(io.jans.orm.model.base.LocalizedString policyUriLocalized) -
setTosUriLocalized
public void setTosUriLocalized(io.jans.orm.model.base.LocalizedString tosUriLocalized) -
setClientNameLocalized
Sets the name of the Client to be presented to the user.- Parameters:
clientName- The name of the Client to be presented to the user.
-
setClientNameLocalized
Sets the name of the Client to be presented to the user represented in a language and a script.- Parameters:
clientName- The name of the Client to be presented to the user.locale- The locale
-
getLogoUriLocalized
public io.jans.orm.model.base.LocalizedString getLogoUriLocalized()Returns a URL that references a logo for the Client application represented in a language and a script.- Returns:
- The URL of a logo image for the Client where it can be retrieved.
-
setLogoUriLocalized
Sets a URL that references a logo for the Client application.- Parameters:
logoUri- The URL of a logo image for the Client where it can be retrieved.
-
setLogoUriLocalized
Sets a URL that references a logo for the Client application represented in a language and script.- Parameters:
logoUri- The URL of a logo image for the Client where it can be retrieved.locale- The locale
-
getClientUriLocalized
public io.jans.orm.model.base.LocalizedString getClientUriLocalized()Returns a URL of the home page of the Client represented in a language and script- Returns:
- The URL of the home page of the Client.
-
setClientUriLocalized
Sets a URL of the home page of the Client.- Parameters:
clientUri- The URL of the home page of the Client.
-
setClientUriLocalized
Sets a URL of the home page of the Client represented in a language and script.- Parameters:
clientUri- The URL of the home page of the Client.locale- The locale
-
getPolicyUriLocalized
public io.jans.orm.model.base.LocalizedString getPolicyUriLocalized()Returns a URL that the Relying Party Client provides to the End-User to read about how the profile data will be used represented in a language and script.- Returns:
- A URL location about how the profile data will be used.
-
setPolicyUriLocalized
Sets a URL that the Relying Party Client provides to the End-User to read about how the profile data will be used.- Parameters:
policyUri- A URL location about how the profile data will be used.
-
setPolicyUriLocalized
Sets a URL that the Relying Party Client provides to the End-User to read about how the profile data will be used represented in a language and script.- Parameters:
policyUri- A URL location about how the profile data will be used.locale- The locale
-
getTosUriLocalized
public io.jans.orm.model.base.LocalizedString getTosUriLocalized()Returns a URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service represented in a language and script.- Returns:
- The terms of service URL.
-
setTosUriLocalized
Sets a URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service.- Parameters:
tosUri- The terms of service URL.
-
setTosUriLocalized
Sets a URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service represented in a language and script.- Parameters:
tosUri- The terms of service URL.locale- The Locale
-
getJwksUri
Return the URL for the Client's JSON Web Key (JWK) document containing key(s) that are used for signing requests to the OP. The JWK Set may also contain the Client's encryption key(s) that are used by the OP to encrypt the responses to the Client.- Returns:
- The URL for the Client's JWK Set.
-
setJwksUri
Sets the URL for the Client's JSON Web Key (JWK) document containing key(s) that are used for signing requests to the OP. The JWK Set may also contain the Client's encryption key(s) that are used by the OP to encrypt the responses to the Client.- Parameters:
jwksUri- The URL for the Client's JWK Set.
-
getJwks
Client's JSON Web Key Set (JWK) document, passed by value. The semantics of the jwks parameter are the same as the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client can use jwks_uri, it must not use jwks. One significant downside of jwks is that it does not enable key rotation (which jwks_uri does, as described in Section 10 of OpenID Connect Core 1.0). The jwks_uri and jwks parameters must not be used together.- Returns:
- The Client's JSON Web Key Set (JWK) document.
-
setJwks
Client's JSON Web Key Set (JWK) document, passed by value. The semantics of the jwks parameter are the same as the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client can use jwks_uri, it must not use jwks. One significant downside of jwks is that it does not enable key rotation (which jwks_uri does, as described in Section 10 of OpenID Connect Core 1.0). The jwks_uri and jwks parameters must not be used together.- Parameters:
jwks- The Client's JSON Web Key Set (JWK) document.
-
getSectorIdentifierUri
Return an URL using the HTTPS scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of Redirect URI values.- Returns:
- A HTTPS scheme URL to be used in calculating Pseudonymous Identifiers by the OP.
-
setSectorIdentifierUri
Sets an URL using the HTTPS scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of Redirect URI values.- Parameters:
sectorIdentifierUri- A HTTPS scheme URL to be used in calculating Pseudonymous Identifiers by the OP.
-
getSubjectType
public io.jans.as.model.common.SubjectType getSubjectType()Returns the Subject type requested for the Client ID. Valid types include pairwise and public.- Returns:
- The subject type.
-
setSubjectType
public void setSubjectType(io.jans.as.model.common.SubjectType subjectType) Sets the Subject type quested for the Client ID. Valid types include pairwise and public.- Parameters:
subjectType- The subject type.
-
getIdTokenSignedResponseAlg
Returns the JWS alg algorithm (JWA)0 required for the issued ID Token.- Returns:
- The JWS signing algorithm required for the ID Token issued.
-
setIdTokenSignedResponseAlg
Sets the JWS alg algorithm (JWA)0 required for the issued ID Token.- Parameters:
idTokenSignedResponseAlg- The JWS signing algorithm required for the ID Token issued.
-
getIdTokenEncryptedResponseAlg
Returns the JWE alg algorithm (JWA) required for encrypting the ID Token.- Returns:
- The JWE alg algorithm required for the ID Token issued.
-
setIdTokenEncryptedResponseAlg
Sets the JWE alg algorithm (JWA) required for encrypting the ID Token.- Parameters:
idTokenEncryptedResponseAlg- The JWE alg algorithm required for the ID Token issued.
-
getIdTokenEncryptedResponseEnc
Returns the JWE enc algorithm (JWA) required for symmetric encryption of the ID Token.- Returns:
- The JWE enc algorithm required for the ID token issued.
-
setIdTokenEncryptedResponseEnc
Sets the JWE enc algorithm (JWA) required for symmetric encryption of the ID Token.- Parameters:
idTokenEncryptedResponseEnc- The JWE enc algorithm required for the ID token issued.
-
getUserInfoSignedResponseAlg
Returns the JWS alg algorithm (JWA) required for UserInfo Responses.- Returns:
- The JWS encryption algorithm required for UserInfo responses.
-
setUserInfoSignedResponseAlg
Sets the JWS alg algorithm (JWA) required for UserInfo Responses.- Parameters:
userInfoSignedResponseAlg- The JWS encryption algorithm required for UserInfo responses.
-
getUserInfoEncryptedResponseAlg
Returns the JWE alg algorithm (JWA) required for encrypting UserInfo Responses.- Returns:
- The JWE alg algorithm required for UserInfo responses.
-
setUserInfoEncryptedResponseAlg
Sets the JWE alg algorithm (JWA) required for encrypting UserInfo Responses.- Parameters:
userInfoEncryptedResponseAlg- The JWE alg algorithm required for UserInfo responses.
-
getUserInfoEncryptedResponseEnc
Returns the JWE enc algorithm (JWA) required for symmetric encryption of UserInfo Responses.- Returns:
- The JWE enc algorithm required for UserInfo responses.
-
setUserInfoEncryptedResponseEnc
Sets the JWE enc algorithm (JWA) required for symmetric encryption of UserInfo Responses.- Parameters:
userInfoEncryptedResponseEnc- The JWE enc algorithm required for UserInfo responses.
-
getRequestObjectSigningAlg
Returns the JWS alg algorithm (JWA) that must be required by the Authorization Server.- Returns:
- The JWS signature algorithm that must be required by the Authorization Server.
-
setRequestObjectSigningAlg
Sets the JWS alg algorithm (JWA) that must be required by the Authorization Server.- Parameters:
requestObjectSigningAlg- The JWS signature algorithm that must be required by the Authorization Server.
-
getRequestObjectEncryptionAlg
Returns the JWE alg algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP.- Returns:
- The JWE alg algorithm (JWA).
-
setRequestObjectEncryptionAlg
Sets the JWE alg algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP.- Parameters:
requestObjectEncryptionAlg- The JWE alg algorithm (JWA).
-
getRequestObjectEncryptionEnc
Returns the JWE enc algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP.- Returns:
- The JWE enc algorithm (JWA).
-
setRequestObjectEncryptionEnc
Sets the JWE enc algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP.- Parameters:
requestObjectEncryptionEnc- The JWE enc algorithm (JWA).
-
getTokenEndpointAuthMethod
Returns the Requested authentication method for the Token Endpoint.- Returns:
- The authentication type for the Token Endpoint.
-
setTokenEndpointAuthMethod
Sets the Requested authentication method for the Token Endpoint.- Parameters:
tokenEndpointAuthMethod- The authentication type for the Token Endpoint.
-
getTokenEndpointAuthSigningAlg
Returns the Requested Client Authentication method for the Token Endpoint.- Returns:
- The Requested Client Authentication method for the Token Endpoint.
-
setTokenEndpointAuthSigningAlg
Sets the Requested Client Authentication method for the Token Endpoint.- Parameters:
tokenEndpointAuthSigningAlg- The Requested Client Authentication method for the Token Endpoint.
-
getDefaultMaxAge
Returns the Default Maximum Authentication Age. Specifies that the End-User must be actively authenticated if the End-User was authenticated longer ago than the specified number of seconds.- Returns:
- The default maximum authentication age.
-
setDefaultMaxAge
Sets the Default Maximum Authentication Age. Specified that the End-User must be actively authenticated if the End-User was authenticated longer ago than the specified number of seconds.- Parameters:
defaultMaxAge- The default maximum authentication age.
-
getDefaultAcrValues
Returns the Default requested Authentication Context Class Reference values. Array of strings that specifies the default acr values that the Authorization Server must use for processing requests from the Client.- Returns:
- The default acr values.
-
setDefaultAcrValues
Sets the Default requested Authentication Context Class Reference values. Array of strings that specifies the default acr values that the Authorization Server must use for processing request from the Client.- Parameters:
defaultAcrValues- The default acr values.
-
getInitiateLoginUri
Returns an URI using the https scheme that the Authorization Server can call to initiate a login at the Client.- Returns:
- The initiate login URI.
-
setInitiateLoginUri
Sets an URI using the https scheme that the Authorization Server can call to initiate a login at the Client.- Parameters:
initiateLoginUri- The initiate login URI.
-
getPostLogoutRedirectUris
Returns an Array of URIs supplied by the RP to request that the user be redirected to this location after a logout has been performed.- Returns:
- The Array of post logout redirect URIs.
-
setPostLogoutRedirectUris
Sets an Array of URIs supplied by the RP to request that the user be redirected to this location after a logout has been performed.- Parameters:
postLogoutRedirectUris- The post logout redirect URI.
-
getRequestUris
Returns an Array of Request URI values that are pre-registered by the Client for use at the Authorization Server.- Returns:
- The request URIs.
-
setRequestUris
Sets an Array of Request URI values that are pre-registered by the Client for use at the Authorization Server.- Parameters:
requestUris- The request URIs.
-
getScopes
-
setScopes
-
getClaims
-
setClaims
-
getTrustedClient
public boolean getTrustedClient() -
setTrustedClient
public void setTrustedClient(boolean trustedClient) -
getLastAccessTime
-
setLastAccessTime
-
getLastLogonTime
-
setLastLogonTime
-
getPersistClientAuthorizations
public boolean getPersistClientAuthorizations() -
setPersistClientAuthorizations
public void setPersistClientAuthorizations(boolean persistClientAuthorizations) -
isIncludeClaimsInIdToken
public boolean isIncludeClaimsInIdToken() -
setIncludeClaimsInIdToken
public void setIncludeClaimsInIdToken(boolean includeClaimsInIdToken) -
getRefreshTokenLifetime
-
setRefreshTokenLifetime
-
getAccessTokenLifetime
-
setAccessTokenLifetime
-
getCustomAttributes
-
setCustomAttributes
public void setCustomAttributes(List<io.jans.orm.model.base.CustomObjectAttribute> customAttributes) -
getCustomObjectClasses
-
setCustomObjectClasses
-
isDisabled
public boolean isDisabled() -
setDisabled
public void setDisabled(boolean disabled) -
getAuthorizedOrigins
-
setAuthorizedOrigins
-
getSoftwareId
-
setSoftwareId
-
getSoftwareVersion
-
setSoftwareVersion
-
getSoftwareStatement
-
setSoftwareStatement
-
getBackchannelTokenDeliveryMode
public io.jans.as.model.common.BackchannelTokenDeliveryMode getBackchannelTokenDeliveryMode() -
setBackchannelTokenDeliveryMode
public void setBackchannelTokenDeliveryMode(io.jans.as.model.common.BackchannelTokenDeliveryMode backchannelTokenDeliveryMode) -
getBackchannelClientNotificationEndpoint
-
setBackchannelClientNotificationEndpoint
-
getBackchannelAuthenticationRequestSigningAlg
public io.jans.as.model.crypto.signature.AsymmetricSignatureAlgorithm getBackchannelAuthenticationRequestSigningAlg() -
setBackchannelAuthenticationRequestSigningAlg
public void setBackchannelAuthenticationRequestSigningAlg(io.jans.as.model.crypto.signature.AsymmetricSignatureAlgorithm backchannelAuthenticationRequestSigningAlg) -
getBackchannelUserCodeParameter
-
setBackchannelUserCodeParameter
-
getDisplayName
-
setDisplayName
-
getDescription
-
setDescription
-