Class OIDCProviderMetadata
- java.lang.Object
-
- com.nimbusds.oauth2.sdk.as.AuthorizationServerEndpointMetadata
-
- com.nimbusds.oauth2.sdk.as.AuthorizationServerMetadata
-
- com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata
-
- All Implemented Interfaces:
ReadOnlyAuthorizationServerEndpointMetadata,ReadOnlyAuthorizationServerMetadata,ReadOnlyOIDCProviderEndpointMetadata,ReadOnlyOIDCProviderMetadata
public class OIDCProviderMetadata extends AuthorizationServerMetadata implements ReadOnlyOIDCProviderMetadata
OpenID Provider (OP) metadata.Related specifications:
- OpenID Connect Discovery 1.0, section 3.
- OpenID Connect Session Management 1.0, section 2.1.
- OpenID Connect Front-Channel Logout 1.0, section 3.
- OpenID Connect Back-Channel Logout 1.0, section 2.1.
- OpenID Connect for Identity Assurance 1.0 (draft 12).
- OpenID Connect Federation 1.0 (draft 23).
- Initiating User Registration via OpenID Connect 1.0
- OAuth 2.0 Authorization Server Metadata (RFC 8414)
- OAuth 2.0 Mutual TLS Client Authentication and Certificate Bound Access Tokens (RFC 8705)
- Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)
- OAuth 2.0 Authorization Server Issuer Identification (RFC 9207)
- Financial-grade API - Part 2: Read and Write API Security Profile
- OAuth 2.0 Pushed Authorization Requests (RFC 9126)
- OAuth 2.0 Rich Authorization Requests (RFC 9396)
- OAuth 2.0 Device Authorization Grant (RFC 8628)
- OAuth 2.0 Incremental Authorization (draft-ietf-oauth-incremental-authz-04)
-
-
Constructor Summary
Constructors Constructor Description OIDCProviderMetadata(Issuer issuer, List<SubjectType> subjectTypes, URI jwkSetURI)Creates a new OpenID Connect provider metadata instance.OIDCProviderMetadata(Issuer issuer, List<SubjectType> subjectTypes, List<ClientRegistrationType> clientRegistrationTypes, URI jwkSetURI, URI signedJWKSetURI, com.nimbusds.jose.jwk.JWKSet jwkSet)Creates a new OpenID Connect Federation 1.0 provider metadata instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidapplyDefaults()Applies the OpenID Provider metadata defaults where no values have been specified.List<ACR>getACRs()Gets the supported Authentication Context Class References (ACRs).List<HashAlgorithm>getAttachmentDigestAlgs()Gets the supported digest algorithms for the external evidence attachments.List<AttachmentType>getAttachmentTypes()Gets the supported evidence attachment types.URIgetCheckSessionIframeURI()Gets the cross-origin check session iframe URI.List<String>getClaims()Gets the supported claims names.List<com.nimbusds.langtag.LangTag>getClaimsLocales()Gets the supported claims locales.List<ClaimType>getClaimTypes()Gets the supported claim types.List<Display>getDisplays()Gets the supported displays.List<IdentityVerificationMethod>getDocumentMethods()Gets the supported coarse identity verification methods for evidences of type document.List<DocumentType>getDocumentTypes()Gets the supported identity document types.List<ValidationMethodType>getDocumentValidationMethods()Gets the supported validation methods for evidences of type document.List<VerificationMethodType>getDocumentVerificationMethods()Gets the supported verification methods for evidences of type document.List<ElectronicRecordType>getElectronicRecordTypes()Gets the supported electronic record types.URIgetEndSessionEndpointURI()Gets the logout endpoint URI.List<IDDocumentType>getIdentityDocumentTypes()Deprecated.List<IdentityEvidenceType>getIdentityEvidenceTypes()Gets the supported identity evidence types.List<IdentityTrustFramework>getIdentityTrustFrameworks()Gets the supported identity trust frameworks.List<IdentityVerificationMethod>getIdentityVerificationMethods()Deprecated.List<com.nimbusds.jose.JWEAlgorithm>getIDTokenJWEAlgs()Gets the supported JWE algorithms for ID tokens.List<com.nimbusds.jose.EncryptionMethod>getIDTokenJWEEncs()Gets the supported encryption methods for ID tokens.List<com.nimbusds.jose.JWSAlgorithm>getIDTokenJWSAlgs()Gets the supported JWS algorithms for ID tokens.OIDCProviderEndpointMetadatagetMtlsEndpointAliases()Gets the aliases for communication with mutual TLS.OIDCProviderEndpointMetadatagetReadOnlyMtlsEndpointAliases()Gets the aliases for communication with mutual TLS.static Set<String>getRegisteredParameterNames()Gets the registered OpenID Connect provider metadata parameter names.List<SubjectType>getSubjectTypes()Gets the supported subject types.URIgetUserInfoEndpointURI()Gets the UserInfo endpoint URI.List<com.nimbusds.jose.JWEAlgorithm>getUserInfoJWEAlgs()Gets the supported JWE algorithms for UserInfo JWTs.List<com.nimbusds.jose.EncryptionMethod>getUserInfoJWEEncs()Gets the supported encryption methods for UserInfo JWTs.List<com.nimbusds.jose.JWSAlgorithm>getUserInfoJWSAlgs()Gets the supported JWS algorithms for UserInfo JWTs.List<String>getVerifiedClaims()Gets the names of the supported verified claims.static OIDCProviderMetadataparse(String s)Parses an OpenID Provider metadata from the specified JSON object string.static OIDCProviderMetadataparse(net.minidev.json.JSONObject jsonObject)Parses an OpenID Provider metadata from the specified JSON object.static OIDCProviderMetadataresolve(Issuer issuer)Resolves OpenID Provider metadata from the specified issuer identifier.static OIDCProviderMetadataresolve(Issuer issuer, int connectTimeout, int readTimeout)Resolves OpenID Provider metadata from the specified issuer identifier.static OIDCProviderMetadataresolve(Issuer issuer, HTTPRequestConfigurator requestConfigurator)Resolves OpenID Provider metadata from the specified issuer identifier.static URLresolveURL(Issuer issuer)Resolves OpenID Provider metadata URL from the specified issuer identifier.voidsetACRs(List<ACR> acrValues)Sets the supported Authentication Context Class References (ACRs).voidsetAttachmentDigestAlgs(List<HashAlgorithm> digestAlgs)Sets the supported digest algorithms for the external evidence attachments.voidsetAttachmentTypes(List<AttachmentType> attachmentTypes)Sets the supported evidence attachment types.voidsetCheckSessionIframeURI(URI checkSessionIframe)Sets the cross-origin check session iframe URI.voidsetClaimLocales(List<com.nimbusds.langtag.LangTag> claimsLocales)Sets the supported claims locales.voidsetClaims(List<String> claims)Sets the supported claims names.voidsetClaimTypes(List<ClaimType> claimTypes)Sets the supported claim types.voidsetDisplays(List<Display> displays)Sets the supported displays.voidsetDocumentMethods(List<IdentityVerificationMethod> methods)Sets the supported coarse identity verification methods for evidences of type document.voidsetDocumentTypes(List<DocumentType> documentTypes)Sets the supported identity document types.voidsetDocumentValidationMethods(List<ValidationMethodType> methods)Sets the supported validation methods for evidences of type document.voidsetDocumentVerificationMethods(List<VerificationMethodType> methods)Sets the supported verification methods for evidences of type document.voidsetElectronicRecordTypes(List<ElectronicRecordType> electronicRecordTypes)Sets the supported electronic record types.voidsetEndSessionEndpointURI(URI endSessionEndpoint)Sets the logout endpoint URI.voidsetIdentityDocumentTypes(List<IDDocumentType> idDocuments)Deprecated.voidsetIdentityEvidenceTypes(List<IdentityEvidenceType> evidenceTypes)Sets the supported identity evidence types.voidsetIdentityTrustFrameworks(List<IdentityTrustFramework> trustFrameworks)Sets the supported identity trust frameworks.voidsetIdentityVerificationMethods(List<IdentityVerificationMethod> idVerificationMethods)Deprecated.voidsetIDTokenJWEAlgs(List<com.nimbusds.jose.JWEAlgorithm> idTokenJWEAlgs)Sets the supported JWE algorithms for ID tokens.voidsetIDTokenJWEEncs(List<com.nimbusds.jose.EncryptionMethod> idTokenJWEEncs)Sets the supported encryption methods for ID tokens.voidsetIDTokenJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> idTokenJWSAlgs)Sets the supported JWS algorithms for ID tokens.voidsetMtlsEndpointAliases(AuthorizationServerEndpointMetadata mtlsEndpointAliases)Sets the aliases for communication with mutual TLS.voidsetSupportsBackChannelLogout(boolean backChannelLogoutSupported)Sets the support for back-channel logout.voidsetSupportsBackChannelLogoutSession(boolean backChannelLogoutSessionSupported)Sets the support for back-channel logout with a session ID.voidsetSupportsClaimsParams(boolean claimsParamSupported)Sets the support for theclaimsauthorisation request parameter.voidsetSupportsFrontChannelLogout(boolean frontChannelLogoutSupported)Sets the support for front-channel logout.voidsetSupportsFrontChannelLogoutSession(boolean frontChannelLogoutSessionSupported)Sets the support for front-channel logout with a session ID.voidsetSupportsVerifiedClaims(boolean verifiedClaimsSupported)Sets support for verified claims.voidsetUserInfoEndpointURI(URI userInfoEndpoint)Sets the UserInfo endpoint URI.voidsetUserInfoJWEAlgs(List<com.nimbusds.jose.JWEAlgorithm> userInfoJWEAlgs)Sets the supported JWE algorithms for UserInfo JWTs.voidsetUserInfoJWEEncs(List<com.nimbusds.jose.EncryptionMethod> userInfoJWEEncs)Sets the supported encryption methods for UserInfo JWTs.voidsetUserInfoJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> userInfoJWSAlgs)Sets the supported JWS algorithms for UserInfo JWTs.voidsetVerifiedClaims(List<String> verifiedClaims)Sets the names of the supported verified claims.booleansupportsBackChannelLogout()Gets the support for back-channel logout.booleansupportsBackChannelLogoutSession()Gets the support for back-channel logout with a session ID.booleansupportsClaimsParam()Gets the support for theclaimsauthorisation request parameter.booleansupportsFrontChannelLogout()Gets the support for front-channel logout.booleansupportsFrontChannelLogoutSession()Gets the support for front-channel logout with a session ID.booleansupportsVerifiedClaims()Gets support for verified claims.net.minidev.json.JSONObjecttoJSONObject()Returns the JSON object representation of the metadata.-
Methods inherited from class com.nimbusds.oauth2.sdk.as.AuthorizationServerMetadata
getAuthorizationDetailsTypes, getAuthorizationJWEAlgs, getAuthorizationJWEEncs, getAuthorizationJWSAlgs, getBackChannelAuthenticationRequestJWSAlgs, getBackChannelTokenDeliveryModes, getClientRegistrationAuthnJWSAlgs, getClientRegistrationAuthnMethods, getClientRegistrationTypes, getCodeChallengeMethods, getCustomParameter, getCustomParameters, getCustomURIParameter, getDPoPJWSAlgs, getFederationRegistrationEndpointURI, getGrantTypes, getIncrementalAuthorizationTypes, getIntrospectionEndpointAuthMethods, getIntrospectionEndpointJWSAlgs, getIssuer, getJWKSet, getJWKSetURI, getOrganizationName, getPolicyURI, getPromptTypes, getRequestObjectJWEAlgs, getRequestObjectJWEEncs, getRequestObjectJWSAlgs, getResponseModes, getResponseTypes, getRevocationEndpointAuthMethods, getRevocationEndpointJWSAlgs, getScopes, getServiceDocsURI, getSignedJWKSetURI, getTermsOfServiceURI, getTokenEndpointAuthMethods, getTokenEndpointJWSAlgs, getUILocales, requiresPushedAuthorizationRequests, requiresPushedAuthorizationRequests, requiresRequestURIRegistration, setAuthorizationDetailsTypes, setAuthorizationJWEAlgs, setAuthorizationJWEEncs, setAuthorizationJWSAlgs, setBackChannelAuthenticationRequestJWSAlgs, setBackChannelTokenDeliveryModes, setClientRegistrationAuthnJWSAlgs, setClientRegistrationAuthnMethods, setClientRegistrationTypes, setCodeChallengeMethods, setCustomParameter, setDPoPJWSAlgs, setFederationRegistrationEndpointURI, setGrantTypes, setIncrementalAuthorizationTypes, setIntrospectionEndpointAuthMethods, setIntrospectionEndpointJWSAlgs, setJWKSet, setJWKSetURI, setOrganizationName, setPolicyURI, setPromptTypes, setRequestObjectJWEAlgs, setRequestObjectJWEEncs, setRequestObjectJWSAlgs, setRequiresRequestURIRegistration, setResponseModes, setResponseTypes, setRevocationEndpointAuthMethods, setRevocationEndpointJWSAlgs, setScopes, setServiceDocsURI, setSignedJWKSetURI, setSupportsAuthorizationResponseIssuerParam, setSupportsBackChannelUserCodeParam, setSupportsMutualTLSSenderConstrainedAccessTokens, setSupportsRequestParam, setSupportsRequestURIParam, setSupportsTLSClientCertificateBoundAccessTokens, setTermsOfServiceURI, setTokenEndpointAuthMethods, setTokenEndpointJWSAlgs, setUILocales, supportsAuthorizationResponseIssuerParam, supportsBackChannelUserCodeParam, supportsMutualTLSSenderConstrainedAccessTokens, supportsRequestParam, supportsRequestURIParam, supportsTLSClientCertificateBoundAccessTokens
-
Methods inherited from class com.nimbusds.oauth2.sdk.as.AuthorizationServerEndpointMetadata
getAuthorizationEndpointURI, getBackChannelAuthenticationEndpoint, getBackChannelAuthenticationEndpointURI, getDeviceAuthorizationEndpointURI, getIntrospectionEndpointURI, getPushedAuthorizationRequestEndpointURI, getRegistrationEndpointURI, getRequestObjectEndpoint, getRevocationEndpointURI, getTokenEndpointURI, setAuthorizationEndpointURI, setBackChannelAuthenticationEndpoint, setBackChannelAuthenticationEndpointURI, setDeviceAuthorizationEndpointURI, setIntrospectionEndpointURI, setPushedAuthorizationRequestEndpointURI, setRegistrationEndpointURI, setRequestObjectEndpoint, setRevocationEndpointURI, setTokenEndpointURI, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.nimbusds.oauth2.sdk.as.ReadOnlyAuthorizationServerEndpointMetadata
getAuthorizationEndpointURI, getBackChannelAuthenticationEndpoint, getBackChannelAuthenticationEndpointURI, getDeviceAuthorizationEndpointURI, getFederationRegistrationEndpointURI, getIntrospectionEndpointURI, getPushedAuthorizationRequestEndpointURI, getRegistrationEndpointURI, getRequestObjectEndpoint, getRevocationEndpointURI, getTokenEndpointURI
-
Methods inherited from interface com.nimbusds.oauth2.sdk.as.ReadOnlyAuthorizationServerMetadata
getAuthorizationDetailsTypes, getAuthorizationJWEAlgs, getAuthorizationJWEEncs, getAuthorizationJWSAlgs, getBackChannelAuthenticationRequestJWSAlgs, getBackChannelTokenDeliveryModes, getClientRegistrationAuthnJWSAlgs, getClientRegistrationAuthnMethods, getClientRegistrationTypes, getCodeChallengeMethods, getCustomParameter, getCustomParameters, getCustomURIParameter, getDPoPJWSAlgs, getGrantTypes, getIncrementalAuthorizationTypes, getIntrospectionEndpointAuthMethods, getIntrospectionEndpointJWSAlgs, getIssuer, getJWKSet, getJWKSetURI, getOrganizationName, getPolicyURI, getPromptTypes, getRequestObjectJWEAlgs, getRequestObjectJWEEncs, getRequestObjectJWSAlgs, getResponseModes, getResponseTypes, getRevocationEndpointAuthMethods, getRevocationEndpointJWSAlgs, getScopes, getServiceDocsURI, getSignedJWKSetURI, getTermsOfServiceURI, getTokenEndpointAuthMethods, getTokenEndpointJWSAlgs, getUILocales, requiresPushedAuthorizationRequests, requiresRequestURIRegistration, supportsAuthorizationResponseIssuerParam, supportsBackChannelUserCodeParam, supportsMutualTLSSenderConstrainedAccessTokens, supportsRequestParam, supportsRequestURIParam, supportsTLSClientCertificateBoundAccessTokens
-
-
-
-
Constructor Detail
-
OIDCProviderMetadata
public OIDCProviderMetadata(Issuer issuer, List<SubjectType> subjectTypes, URI jwkSetURI)
Creates a new OpenID Connect provider metadata instance.- Parameters:
issuer- The issuer identifier. Must be a URI using the https scheme with no query or fragment component. Must not benull.subjectTypes- The supported subject types. At least one must be specified. Must not benull.jwkSetURI- The JWK set URI. Must not benull.
-
OIDCProviderMetadata
public OIDCProviderMetadata(Issuer issuer, List<SubjectType> subjectTypes, List<ClientRegistrationType> clientRegistrationTypes, URI jwkSetURI, URI signedJWKSetURI, com.nimbusds.jose.jwk.JWKSet jwkSet)
Creates a new OpenID Connect Federation 1.0 provider metadata instance. The provider JWK set should be specified byjwks_uri,signed_jwks_uriorjwks.- Parameters:
issuer- The issuer identifier. Must be a URI using the https scheme with no query or fragment component. Must not benull.subjectTypes- The supported subject types. At least one must be specified. Must not benull.clientRegistrationTypes- The supported client registration types. At least one must be specified. Must not benull.jwkSetURI- The JWK set URI,nullif specified by another field.signedJWKSetURI- The signed JWK set URI,nullif specified by another field.jwkSet- the JWK set,nullif specified by another field.
-
-
Method Detail
-
setMtlsEndpointAliases
public void setMtlsEndpointAliases(AuthorizationServerEndpointMetadata mtlsEndpointAliases)
Description copied from class:AuthorizationServerMetadataSets the aliases for communication with mutual TLS. Corresponds to themtls_endpoint_aliasesmetadata field.- Overrides:
setMtlsEndpointAliasesin classAuthorizationServerMetadata- Parameters:
mtlsEndpointAliases- The aliases for communication with mutual TLS, ornullwhen no aliases are defined.
-
getReadOnlyMtlsEndpointAliases
public OIDCProviderEndpointMetadata getReadOnlyMtlsEndpointAliases()
Description copied from interface:ReadOnlyAuthorizationServerMetadataGets the aliases for communication with mutual TLS. Corresponds to themtls_endpoint_aliasesmetadata field.- Specified by:
getReadOnlyMtlsEndpointAliasesin interfaceReadOnlyAuthorizationServerMetadata- Specified by:
getReadOnlyMtlsEndpointAliasesin interfaceReadOnlyOIDCProviderMetadata- Overrides:
getReadOnlyMtlsEndpointAliasesin classAuthorizationServerMetadata- Returns:
- The aliases for communication with mutual TLS,
nullwhen no aliases are defined.
-
getMtlsEndpointAliases
public OIDCProviderEndpointMetadata getMtlsEndpointAliases()
Description copied from class:AuthorizationServerMetadataGets the aliases for communication with mutual TLS. Corresponds to themtls_endpoint_aliasesmetadata field.- Overrides:
getMtlsEndpointAliasesin classAuthorizationServerMetadata- Returns:
- The aliases for communication with mutual TLS,
nullwhen no aliases are defined.
-
getRegisteredParameterNames
public static Set<String> getRegisteredParameterNames()
Gets the registered OpenID Connect provider metadata parameter names.- Returns:
- The registered OpenID Connect provider metadata parameter names, as an unmodifiable set.
-
getUserInfoEndpointURI
public URI getUserInfoEndpointURI()
Description copied from interface:ReadOnlyOIDCProviderEndpointMetadataGets the UserInfo endpoint URI. Corresponds theuserinfo_endpointmetadata field.- Specified by:
getUserInfoEndpointURIin interfaceReadOnlyOIDCProviderEndpointMetadata- Returns:
- The UserInfo endpoint URI,
nullif not specified.
-
setUserInfoEndpointURI
public void setUserInfoEndpointURI(URI userInfoEndpoint)
Sets the UserInfo endpoint URI. Corresponds theuserinfo_endpointmetadata field.- Parameters:
userInfoEndpoint- The UserInfo endpoint URI,nullif not specified.
-
getCheckSessionIframeURI
public URI getCheckSessionIframeURI()
Description copied from interface:ReadOnlyOIDCProviderEndpointMetadataGets the cross-origin check session iframe URI. Corresponds to thecheck_session_iframemetadata field.- Specified by:
getCheckSessionIframeURIin interfaceReadOnlyOIDCProviderEndpointMetadata- Returns:
- The check session iframe URI,
nullif not specified.
-
setCheckSessionIframeURI
public void setCheckSessionIframeURI(URI checkSessionIframe)
Sets the cross-origin check session iframe URI. Corresponds to thecheck_session_iframemetadata field.- Parameters:
checkSessionIframe- The check session iframe URI,nullif not specified.
-
getEndSessionEndpointURI
public URI getEndSessionEndpointURI()
Description copied from interface:ReadOnlyOIDCProviderEndpointMetadataGets the logout endpoint URI. Corresponds to theend_session_endpointmetadata field.- Specified by:
getEndSessionEndpointURIin interfaceReadOnlyOIDCProviderEndpointMetadata- Returns:
- The logoout endpoint URI,
nullif not specified.
-
setEndSessionEndpointURI
public void setEndSessionEndpointURI(URI endSessionEndpoint)
Sets the logout endpoint URI. Corresponds to theend_session_endpointmetadata field.- Parameters:
endSessionEndpoint- The logoout endpoint URI,nullif not specified.
-
getACRs
public List<ACR> getACRs()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported Authentication Context Class References (ACRs). Corresponds to theacr_values_supportedmetadata field.- Specified by:
getACRsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported ACRs,
nullif not specified.
-
setACRs
public void setACRs(List<ACR> acrValues)
Sets the supported Authentication Context Class References (ACRs). Corresponds to theacr_values_supportedmetadata field.- Parameters:
acrValues- The supported ACRs,nullif not specified.
-
getSubjectTypes
public List<SubjectType> getSubjectTypes()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported subject types. Corresponds to thesubject_types_supportedmetadata field.- Specified by:
getSubjectTypesin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported subject types.
-
getIDTokenJWSAlgs
public List<com.nimbusds.jose.JWSAlgorithm> getIDTokenJWSAlgs()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported JWS algorithms for ID tokens. Corresponds to theid_token_signing_alg_values_supportedmetadata field.- Specified by:
getIDTokenJWSAlgsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported JWS algorithms,
nullif not specified.
-
setIDTokenJWSAlgs
public void setIDTokenJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> idTokenJWSAlgs)
Sets the supported JWS algorithms for ID tokens. Corresponds to theid_token_signing_alg_values_supportedmetadata field.- Parameters:
idTokenJWSAlgs- The supported JWS algorithms,nullif not specified.
-
getIDTokenJWEAlgs
public List<com.nimbusds.jose.JWEAlgorithm> getIDTokenJWEAlgs()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported JWE algorithms for ID tokens. Corresponds to theid_token_encryption_alg_values_supportedmetadata field.- Specified by:
getIDTokenJWEAlgsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported JWE algorithms,
nullif not specified.
-
setIDTokenJWEAlgs
public void setIDTokenJWEAlgs(List<com.nimbusds.jose.JWEAlgorithm> idTokenJWEAlgs)
Sets the supported JWE algorithms for ID tokens. Corresponds to theid_token_encryption_alg_values_supportedmetadata field.- Parameters:
idTokenJWEAlgs- The supported JWE algorithms,nullif not specified.
-
getIDTokenJWEEncs
public List<com.nimbusds.jose.EncryptionMethod> getIDTokenJWEEncs()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported encryption methods for ID tokens. Corresponds to theid_token_encryption_enc_values_supportedmetadata field.- Specified by:
getIDTokenJWEEncsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported encryption methods,
nullif not specified.
-
setIDTokenJWEEncs
public void setIDTokenJWEEncs(List<com.nimbusds.jose.EncryptionMethod> idTokenJWEEncs)
Sets the supported encryption methods for ID tokens. Corresponds to theid_token_encryption_enc_values_supportedmetadata field.- Parameters:
idTokenJWEEncs- The supported encryption methods,nullif not specified.
-
getUserInfoJWSAlgs
public List<com.nimbusds.jose.JWSAlgorithm> getUserInfoJWSAlgs()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported JWS algorithms for UserInfo JWTs. Corresponds to theuserinfo_signing_alg_values_supportedmetadata field.- Specified by:
getUserInfoJWSAlgsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported JWS algorithms,
nullif not specified.
-
setUserInfoJWSAlgs
public void setUserInfoJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> userInfoJWSAlgs)
Sets the supported JWS algorithms for UserInfo JWTs. Corresponds to theuserinfo_signing_alg_values_supportedmetadata field.- Parameters:
userInfoJWSAlgs- The supported JWS algorithms,nullif not specified.
-
getUserInfoJWEAlgs
public List<com.nimbusds.jose.JWEAlgorithm> getUserInfoJWEAlgs()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported JWE algorithms for UserInfo JWTs. Corresponds to theuserinfo_encryption_alg_values_supportedmetadata field.- Specified by:
getUserInfoJWEAlgsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported JWE algorithms,
nullif not specified.
-
setUserInfoJWEAlgs
public void setUserInfoJWEAlgs(List<com.nimbusds.jose.JWEAlgorithm> userInfoJWEAlgs)
Sets the supported JWE algorithms for UserInfo JWTs. Corresponds to theuserinfo_encryption_alg_values_supportedmetadata field.- Parameters:
userInfoJWEAlgs- The supported JWE algorithms,nullif not specified.
-
getUserInfoJWEEncs
public List<com.nimbusds.jose.EncryptionMethod> getUserInfoJWEEncs()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported encryption methods for UserInfo JWTs. Corresponds to theuserinfo_encryption_enc_values_supportedmetadata field.- Specified by:
getUserInfoJWEEncsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported encryption methods,
nullif not specified.
-
setUserInfoJWEEncs
public void setUserInfoJWEEncs(List<com.nimbusds.jose.EncryptionMethod> userInfoJWEEncs)
Sets the supported encryption methods for UserInfo JWTs. Corresponds to theuserinfo_encryption_enc_values_supportedmetadata field.- Parameters:
userInfoJWEEncs- The supported encryption methods,nullif not specified.
-
getDisplays
public List<Display> getDisplays()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported displays. Corresponds to thedisplay_values_supportedmetadata field.- Specified by:
getDisplaysin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported displays,
nullif not specified.
-
setDisplays
public void setDisplays(List<Display> displays)
Sets the supported displays. Corresponds to thedisplay_values_supportedmetadata field.- Parameters:
displays- The supported displays,nullif not specified.
-
getClaimTypes
public List<ClaimType> getClaimTypes()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported claim types. Corresponds to theclaim_types_supportedmetadata field.- Specified by:
getClaimTypesin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported claim types,
nullif not specified.
-
setClaimTypes
public void setClaimTypes(List<ClaimType> claimTypes)
Sets the supported claim types. Corresponds to theclaim_types_supportedmetadata field.- Parameters:
claimTypes- The supported claim types,nullif not specified.
-
getClaims
public List<String> getClaims()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported claims names. Corresponds to theclaims_supportedmetadata field.- Specified by:
getClaimsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported claims names,
nullif not specified.
-
setClaims
public void setClaims(List<String> claims)
Sets the supported claims names. Corresponds to theclaims_supportedmetadata field.- Parameters:
claims- The supported claims names,nullif not specified.
-
getClaimsLocales
public List<com.nimbusds.langtag.LangTag> getClaimsLocales()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported claims locales. Corresponds to theclaims_locales_supportedmetadata field.- Specified by:
getClaimsLocalesin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported claims locales,
nullif not specified.
-
setClaimLocales
public void setClaimLocales(List<com.nimbusds.langtag.LangTag> claimsLocales)
Sets the supported claims locales. Corresponds to theclaims_locales_supportedmetadata field.- Parameters:
claimsLocales- The supported claims locales,nullif not specified.
-
supportsClaimsParam
public boolean supportsClaimsParam()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the support for theclaimsauthorisation request parameter. Corresponds to theclaims_parameter_supportedmetadata field.- Specified by:
supportsClaimsParamin interfaceReadOnlyOIDCProviderMetadata- Returns:
trueif theclaimparameter is supported, elsefalse.
-
setSupportsClaimsParams
public void setSupportsClaimsParams(boolean claimsParamSupported)
Sets the support for theclaimsauthorisation request parameter. Corresponds to theclaims_parameter_supportedmetadata field.- Parameters:
claimsParamSupported-trueif theclaimparameter is supported, elsefalse.
-
supportsFrontChannelLogout
public boolean supportsFrontChannelLogout()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the support for front-channel logout. Corresponds to thefrontchannel_logout_supportedmetadata field.- Specified by:
supportsFrontChannelLogoutin interfaceReadOnlyOIDCProviderMetadata- Returns:
trueif front-channel logout is supported, elsefalse.
-
setSupportsFrontChannelLogout
public void setSupportsFrontChannelLogout(boolean frontChannelLogoutSupported)
Sets the support for front-channel logout. Corresponds to thefrontchannel_logout_supportedmetadata field.- Parameters:
frontChannelLogoutSupported-trueif front-channel logout is supported, elsefalse.
-
supportsFrontChannelLogoutSession
public boolean supportsFrontChannelLogoutSession()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the support for front-channel logout with a session ID. Corresponds to thefrontchannel_logout_session_supportedmetadata field.- Specified by:
supportsFrontChannelLogoutSessionin interfaceReadOnlyOIDCProviderMetadata- Returns:
trueif front-channel logout with a session ID is supported, elsefalse.
-
setSupportsFrontChannelLogoutSession
public void setSupportsFrontChannelLogoutSession(boolean frontChannelLogoutSessionSupported)
Sets the support for front-channel logout with a session ID. Corresponds to thefrontchannel_logout_session_supportedmetadata field.- Parameters:
frontChannelLogoutSessionSupported-trueif front-channel logout with a session ID is supported, elsefalse.
-
supportsBackChannelLogout
public boolean supportsBackChannelLogout()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the support for back-channel logout. Corresponds to thebackchannel_logout_supportedmetadata field.- Specified by:
supportsBackChannelLogoutin interfaceReadOnlyOIDCProviderMetadata- Returns:
trueif back-channel logout is supported, elsefalse.
-
setSupportsBackChannelLogout
public void setSupportsBackChannelLogout(boolean backChannelLogoutSupported)
Sets the support for back-channel logout. Corresponds to thebackchannel_logout_supportedmetadata field.- Parameters:
backChannelLogoutSupported-trueif back-channel logout is supported, elsefalse.
-
supportsBackChannelLogoutSession
public boolean supportsBackChannelLogoutSession()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the support for back-channel logout with a session ID. Corresponds to thebackchannel_logout_session_supportedmetadata field.- Specified by:
supportsBackChannelLogoutSessionin interfaceReadOnlyOIDCProviderMetadata- Returns:
trueif back-channel logout with a session ID is supported, elsefalse.
-
setSupportsBackChannelLogoutSession
public void setSupportsBackChannelLogoutSession(boolean backChannelLogoutSessionSupported)
Sets the support for back-channel logout with a session ID. Corresponds to thebackchannel_logout_session_supportedmetadata field.- Parameters:
backChannelLogoutSessionSupported-trueif back-channel logout with a session ID is supported, elsefalse.
-
supportsVerifiedClaims
public boolean supportsVerifiedClaims()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets support for verified claims. Corresponds to theverified_claims_supportedmetadata field.- Specified by:
supportsVerifiedClaimsin interfaceReadOnlyOIDCProviderMetadata- Returns:
trueif verified claims are supported, elsefalse.
-
setSupportsVerifiedClaims
public void setSupportsVerifiedClaims(boolean verifiedClaimsSupported)
Sets support for verified claims. Corresponds to theverified_claims_supportedmetadata field.- Parameters:
verifiedClaimsSupported-trueif verified claims are supported, elsefalse.
-
getIdentityTrustFrameworks
public List<IdentityTrustFramework> getIdentityTrustFrameworks()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported identity trust frameworks. Corresponds to thetrust_frameworks_supportedmetadata field.- Specified by:
getIdentityTrustFrameworksin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported identity trust frameworks,
nullif not specified.
-
setIdentityTrustFrameworks
public void setIdentityTrustFrameworks(List<IdentityTrustFramework> trustFrameworks)
Sets the supported identity trust frameworks. Corresponds to thetrust_frameworks_supportedmetadata field.- Parameters:
trustFrameworks- The supported identity trust frameworks,nullif not specified.
-
getIdentityEvidenceTypes
public List<IdentityEvidenceType> getIdentityEvidenceTypes()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported identity evidence types. Corresponds to theevidence_supportedmetadata field.- Specified by:
getIdentityEvidenceTypesin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported identity evidence types,
nullif not specified.
-
setIdentityEvidenceTypes
public void setIdentityEvidenceTypes(List<IdentityEvidenceType> evidenceTypes)
Sets the supported identity evidence types. Corresponds to theevidence_supportedmetadata field.- Parameters:
evidenceTypes- The supported identity evidence types,nullif not specified.
-
getDocumentTypes
public List<DocumentType> getDocumentTypes()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported identity document types. Corresponds to thedocuments_supportedmetadata field.- Specified by:
getDocumentTypesin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported identity document types,
nullif not specified.
-
setDocumentTypes
public void setDocumentTypes(List<DocumentType> documentTypes)
Sets the supported identity document types. Corresponds to thedocuments_supportedmetadata field.- Parameters:
documentTypes- The supported identity document types,nullif not specified.
-
getIdentityDocumentTypes
@Deprecated public List<IDDocumentType> getIdentityDocumentTypes()
Deprecated.Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported identity document types. Corresponds to theid_documents_supportedmetadata field.- Specified by:
getIdentityDocumentTypesin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported identity documents types,
nullif not specified.
-
setIdentityDocumentTypes
@Deprecated public void setIdentityDocumentTypes(List<IDDocumentType> idDocuments)
Deprecated.Sets the supported identity document types. Corresponds to theid_documents_supportedmetadata field.- Parameters:
idDocuments- The supported identity document types,nullif not specified.
-
getDocumentMethods
public List<IdentityVerificationMethod> getDocumentMethods()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported coarse identity verification methods for evidences of type document. Corresponds to thedocuments_methods_supportedmetadata field.- Specified by:
getDocumentMethodsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported identity verification methods for document
evidences,
nullif not specified.
-
setDocumentMethods
public void setDocumentMethods(List<IdentityVerificationMethod> methods)
Sets the supported coarse identity verification methods for evidences of type document. Corresponds to thedocuments_methods_supportedmetadata field.- Parameters:
methods- The supported identity verification methods for document evidences,nullif not specified.
-
getDocumentValidationMethods
public List<ValidationMethodType> getDocumentValidationMethods()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported validation methods for evidences of type document. Corresponds to thedocuments_validation_methods_supportedmetadata field.- Specified by:
getDocumentValidationMethodsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The validation methods for document evidences,
nullif not specified.
-
setDocumentValidationMethods
public void setDocumentValidationMethods(List<ValidationMethodType> methods)
Sets the supported validation methods for evidences of type document. Corresponds to thedocuments_validation_methods_supportedmetadata field.- Parameters:
methods- The validation methods for document evidences,nullif not specified.
-
getDocumentVerificationMethods
public List<VerificationMethodType> getDocumentVerificationMethods()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported verification methods for evidences of type document. Corresponds to thedocuments_verification_methods_supportedmetadata field.- Specified by:
getDocumentVerificationMethodsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The verification methods for document evidences,
nullif not specified.
-
setDocumentVerificationMethods
public void setDocumentVerificationMethods(List<VerificationMethodType> methods)
Sets the supported verification methods for evidences of type document. Corresponds to thedocuments_verification_methods_supportedmetadata field.- Parameters:
methods- The verification methods for document evidences,nullif not specified.
-
getElectronicRecordTypes
public List<ElectronicRecordType> getElectronicRecordTypes()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported electronic record types. Corresponds to theelectronic_records_supportedmetadata field.- Specified by:
getElectronicRecordTypesin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported electronic record types,
nullif not specified.
-
setElectronicRecordTypes
public void setElectronicRecordTypes(List<ElectronicRecordType> electronicRecordTypes)
Sets the supported electronic record types. Corresponds to theelectronic_records_supportedmetadata field.- Parameters:
electronicRecordTypes- The supported electronic record types,nullif not specified.
-
getIdentityVerificationMethods
@Deprecated public List<IdentityVerificationMethod> getIdentityVerificationMethods()
Deprecated.Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported identity verification methods. Corresponds to theid_documents_verification_methods_supportedmetadata field.- Specified by:
getIdentityVerificationMethodsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported identity verification methods,
nullif not specified.
-
setIdentityVerificationMethods
@Deprecated public void setIdentityVerificationMethods(List<IdentityVerificationMethod> idVerificationMethods)
Deprecated.Sets the supported identity verification methods. Corresponds to theid_documents_verification_methods_supportedmetadata field.- Parameters:
idVerificationMethods- The supported identity verification methods,nullif not specified.
-
getVerifiedClaims
public List<String> getVerifiedClaims()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the names of the supported verified claims. Corresponds to theclaims_in_verified_claims_supportedmetadata field.- Specified by:
getVerifiedClaimsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported verified claims names,
nullif not specified.
-
setVerifiedClaims
public void setVerifiedClaims(List<String> verifiedClaims)
Sets the names of the supported verified claims. Corresponds to theclaims_in_verified_claims_supportedmetadata field.- Parameters:
verifiedClaims- The supported verified claims names,nullif not specified.
-
getAttachmentTypes
public List<AttachmentType> getAttachmentTypes()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported evidence attachment types. Corresponds to theattachments_supportedmetadata field.- Specified by:
getAttachmentTypesin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported evidence attachment types, empty if
attachments are not supported,
nullif not specified.
-
setAttachmentTypes
public void setAttachmentTypes(List<AttachmentType> attachmentTypes)
Sets the supported evidence attachment types. Corresponds to theattachments_supportedmetadata field.- Parameters:
attachmentTypes- The supported evidence attachment types, empty if attachments are not supported,nullif not specified.
-
getAttachmentDigestAlgs
public List<HashAlgorithm> getAttachmentDigestAlgs()
Description copied from interface:ReadOnlyOIDCProviderMetadataGets the supported digest algorithms for the external evidence attachments. Corresponds to thedigest_algorithms_supportedmetadata field.- Specified by:
getAttachmentDigestAlgsin interfaceReadOnlyOIDCProviderMetadata- Returns:
- The supported digest algorithms,
nullif not specified.
-
setAttachmentDigestAlgs
public void setAttachmentDigestAlgs(List<HashAlgorithm> digestAlgs)
Sets the supported digest algorithms for the external evidence attachments. Corresponds to thedigest_algorithms_supportedmetadata field.- Parameters:
digestAlgs- The supported digest algorithms,nullif not specified.
-
applyDefaults
public void applyDefaults()
Applies the OpenID Provider metadata defaults where no values have been specified.- The response modes default to
["query", "fragment"]. - The grant types default to
["authorization_code", "implicit"]. - The token endpoint authentication methods default to
["client_secret_basic"]. - The claim types default to
["normal].
- Overrides:
applyDefaultsin classAuthorizationServerMetadata
- The response modes default to
-
toJSONObject
public net.minidev.json.JSONObject toJSONObject()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadataReturns the JSON object representation of the metadata.- Specified by:
toJSONObjectin interfaceReadOnlyAuthorizationServerEndpointMetadata- Specified by:
toJSONObjectin interfaceReadOnlyAuthorizationServerMetadata- Overrides:
toJSONObjectin classAuthorizationServerMetadata- Returns:
- The JSON object.
-
parse
public static OIDCProviderMetadata parse(net.minidev.json.JSONObject jsonObject) throws ParseException
Parses an OpenID Provider metadata from the specified JSON object.- Parameters:
jsonObject- The JSON object to parse. Must not benull.- Returns:
- The OpenID Provider metadata.
- Throws:
ParseException- If the JSON object couldn't be parsed to an OpenID Provider metadata.
-
parse
public static OIDCProviderMetadata parse(String s) throws ParseException
Parses an OpenID Provider metadata from the specified JSON object string.- Parameters:
s- The JSON object sting to parse. Must not benull.- Returns:
- The OpenID Provider metadata.
- Throws:
ParseException- If the JSON object string couldn't be parsed to an OpenID Provider metadata.
-
resolveURL
public static URL resolveURL(Issuer issuer) throws GeneralException
Resolves OpenID Provider metadata URL from the specified issuer identifier.- Parameters:
issuer- The OpenID Provider issuer identifier. Must represent a valid HTTPS or HTTP URL. Must not benull.- Returns:
- The OpenID Provider metadata URL.
- Throws:
GeneralException- If the issuer identifier is invalid.
-
resolve
public static OIDCProviderMetadata resolve(Issuer issuer) throws GeneralException, IOException
Resolves OpenID Provider metadata from the specified issuer identifier. The metadata is downloaded by HTTP GET from[issuer-url]/.well-known/openid-configuration.- Parameters:
issuer- The OpenID Provider issuer identifier. Must represent a valid HTTPS or HTTP URL. Must not benull.- Returns:
- The OpenID Provider metadata.
- Throws:
GeneralException- If the issuer identifier or the downloaded metadata are invalid.IOException- On a HTTP exception.
-
resolve
public static OIDCProviderMetadata resolve(Issuer issuer, int connectTimeout, int readTimeout) throws GeneralException, IOException
Resolves OpenID Provider metadata from the specified issuer identifier. The metadata is downloaded by HTTP GET from[issuer-url]/.well-known/openid-configuration, using the specified HTTP timeouts.- Parameters:
issuer- The issuer identifier. Must represent a valid HTTPS or HTTP URL. Must not benull.connectTimeout- The HTTP connect timeout, in milliseconds. Zero implies no timeout. Must not be negative.readTimeout- The HTTP response read timeout, in milliseconds. Zero implies no timeout. Must not be negative.- Returns:
- The OpenID Provider metadata.
- Throws:
GeneralException- If the issuer identifier or the downloaded metadata are invalid.IOException- On an HTTP exception.
-
resolve
public static OIDCProviderMetadata resolve(Issuer issuer, HTTPRequestConfigurator requestConfigurator) throws GeneralException, IOException
Resolves OpenID Provider metadata from the specified issuer identifier. The metadata is downloaded by HTTP GET from[issuer-url]/.well-known/openid-configuration, using the specified HTTP request configurator.- Parameters:
issuer- The issuer identifier. Must represent a valid HTTPS or HTTP URL. Must not benull.requestConfigurator- AnHTTPRequestConfiguratorinstance to perform additionalHTTPRequestconfiguration to fetch the OpenID Provider metadata. Must not benull.- Returns:
- The OpenID Provider metadata.
- Throws:
GeneralException- If the issuer identifier or the downloaded metadata are invalid.IOException- On an HTTP exception.
-
-