OpenIdProviderMetadata (security-parent 3.9.7 API)

All Known Implementing Classes:

DefaultOpenIdProviderMetadata
```
public interface OpenIdProviderMetadata
```
Metadata describing the configuration of OpenID Providers.

Since:

1.2.0

Author:

Sergio del Amo

See Also:

Open ID Provider Metadata Spec

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.util.List<java.lang.String>`	`getAcrValuesSupported()` acr_values_supported.
`java.lang.String`	`getAuthorizationEndpoint()` authorization_endpoint.
`java.lang.String`	`getCheckSessionIframe()` check_session_iframe.
`java.util.List<java.lang.String>`	`getClaimsLocalesSupported()` claims_locales_supported OPTIONAL.
`java.lang.Boolean`	`getClaimsParameterSupported()` claims_parameter_supported OPTIONAL.
`java.util.List<java.lang.String>`	`getClaimsSupported()` claims_supported RECOMMENDED.
`java.util.List<java.lang.String>`	`getClaimTypesSupported()` claim_types_supported OPTIONAL.
`java.util.List<java.lang.String>`	`getCodeChallengeMethodsSupported()` code_challenge_methods_supported.
`java.util.List<java.lang.String>`	`getDisplayValuesSupported()` display_values_supported OPTIONAL.
`java.lang.String`	`getEndSessionEndpoint()` end_session_endpoint.
`java.util.List<java.lang.String>`	`getGrantTypesSupported()` grant_types_supported.
`java.util.List<java.lang.String>`	`getIdTokenEncryptionEncValuesSupported()` id_token_encryption_enc_values_supported OPTIONAL.
`java.util.List<java.lang.String>`	`getIdTokenSigningAlgValuesSupported()` id_token_signing_alg_values_supported REQUIRED.
`java.lang.String`	`getIntrospectionEndpoint()`
`java.util.List<java.lang.String>`	`getIntrospectionEndpointAuthMethodsSupported()`
`java.lang.String`	`getIssuer()` issuer.
`java.lang.String`	`getJwksUri()` jwks_uri.
`java.lang.String`	`getOpPolicyUri()` op_policy_uri OPTIONAL.
`java.lang.String`	`getOpTosUri()` op_tos_uri.
`java.lang.String`	`getRegistrationEndpoint()` registration_endpoint.
`java.util.List<java.lang.String>`	`getRequestObjectEncryptionAlgValuesSupported()` request_object_encryption_alg_values_supported OPTIONAL.
`java.util.List<java.lang.String>`	`getRequestObjectEncryptionEncValuesSupported()` request_object_encryption_enc_values_supported OPTIONAL.
`java.util.List<java.lang.String>`	`getRequestObjectSigningAlgValuesSupported()` request_object_signing_alg_values_supported.
`java.lang.Boolean`	`getRequestParameterSupported()` request_parameter_supported OPTIONAL.
`java.lang.Boolean`	`getRequestUriParameterSupported()` request_uri_parameter_supported OPTIONAL.
`java.lang.Boolean`	`getRequireRequestUriRegistration()` require_request_uri_registration OPTIONAL.
`java.util.List<java.lang.String>`	`getResponseModesSupported()` response_modes_supported.
`java.util.List<java.lang.String>`	`getResponseTypesSupported()` response_types_supported.
`java.lang.String`	`getRevocationEndpoint()`
`java.util.List<java.lang.String>`	`getRevocationEndpointAuthMethodsSupported()`
`java.util.List<java.lang.String>`	`getScopesSupported()` scopes_supported.
`java.lang.String`	`getServiceDocumentation()` service_documentation OPTIONAL.
`java.util.List<java.lang.String>`	`getSubjectTypesSupported()` subject_types_supported.
`java.lang.String`	`getTokenEndpoint()` token_endpoint.
`default java.util.Optional<java.util.List<AuthenticationMethod>>`	`getTokenEndpointAuthMethods()`
`java.util.List<java.lang.String>`	`getTokenEndpointAuthMethodsSupported()` token_endpoint_auth_methods_supported OPTIONAL.
`java.util.List<java.lang.String>`	`getTokenEndpointAuthSigningAlgValuesSupported()` token_endpoint_auth_signing_alg_values_supported OPTIONAL.
`java.util.List<java.lang.String>`	`getUriLocalesSupported()` ui_locales_supported OPTIONAL.
`java.util.List<java.lang.String>`	`getUserInfoEncryptionAlgValuesSupported()` userinfo_encryption_alg_values_supported.
`java.util.List<java.lang.String>`	`getUserinfoEncryptionEncValuesSupported()` userinfo_encryption_enc_values_supported OPTIONAL.
`java.lang.String`	`getUserinfoEndpoint()` userinfo_endpoint.

- Method Detail
  - getIssuer
```
@NonNull
java.lang.String getIssuer()
```
    issuer. REQUIRED.
    
    Returns:
    
    URL using the https scheme with no query or fragment component that the Open ID Provider asserts as its Issuer Identifier.
  - getAuthorizationEndpoint
```
@NonNull
java.lang.String getAuthorizationEndpoint()
```
    authorization_endpoint. REQUIRED.
    
    Returns:
    
    URL of the Open ID Provider's OAuth 2.0 Authorization Endpoint
  - getTokenEndpoint
```
@NonNull
java.lang.String getTokenEndpoint()
```
    token_endpoint. This is REQUIRED unless only the Implicit Flow is used.
    
    Returns:
    
    URL of the Open ID Provider's OAuth 2.0 Token Endpoint
  - getUserinfoEndpoint
```
@Nullable
java.lang.String getUserinfoEndpoint()
```
    userinfo_endpoint. RECOMMENDED. This URL MUST use the https scheme and MAY contain port, path, and query parameter components.
    
    Returns:
    
    URL of the Open ID Provider's UserInfo Endpoint
  - getJwksUri
```
@NonNull
java.lang.String getJwksUri()
```
    jwks_uri. REQUIRED
    
    Returns:
    
    URL of the Open ID Provider's JSON Web Key Set
  - getRegistrationEndpoint
```
@Nullable
java.lang.String getRegistrationEndpoint()
```
    registration_endpoint. RECOMMENDED
    
    Returns:
    
    URL of the Open ID Provider's Dynamic Client Registration Endpoint
  - getScopesSupported
```
@Nullable
java.util.List<java.lang.String> getScopesSupported()
```
    scopes_supported. RECOMMENDED.
    
    Returns:
    
    List of the OAuth 2.0 [RFC6749] scope values that this server supports.
  - getResponseTypesSupported
```
@Nullable
java.util.List<java.lang.String> getResponseTypesSupported()
```
    response_types_supported. REQUIRED
    
    Returns:
    
    List of the OAuth 2.0 response_type values that this Open ID Provider supports.
  - getResponseModesSupported
```
@Nullable
java.util.List<java.lang.String> getResponseModesSupported()
```
    response_modes_supported. OPTIONAL
    
    Returns:
    
    List of the OAuth 2.0 response_mode values that this Open ID Provider supports.
  - getGrantTypesSupported
```
@Nullable
java.util.List<java.lang.String> getGrantTypesSupported()
```
    grant_types_supported. OPTIONAL
    
    Returns:
    
    List of the OAuth 2.0 Grant Type values that this Open ID Provider supports.
  - getAcrValuesSupported
```
@Nullable
java.util.List<java.lang.String> getAcrValuesSupported()
```
    acr_values_supported. OPTIONAL.
    
    Returns:
    
    List of the Authentication Context Class References that this OP supports.
  - getSubjectTypesSupported
```
@NonNull
java.util.List<java.lang.String> getSubjectTypesSupported()
```
    subject_types_supported. REQUIRED
    
    Returns:
    
    List of the Subject Identifier types that this OP supports.
  - getIdTokenSigningAlgValuesSupported
```
@NonNull
java.util.List<java.lang.String> getIdTokenSigningAlgValuesSupported()
```
    id_token_signing_alg_values_supported REQUIRED.
    
    Returns:
    
    List of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
  - getIdTokenEncryptionEncValuesSupported
```
@Nullable
java.util.List<java.lang.String> getIdTokenEncryptionEncValuesSupported()
```
    id_token_encryption_enc_values_supported OPTIONAL.
    
    Returns:
    
    List of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
  - getUserInfoEncryptionAlgValuesSupported
```
@Nullable
java.util.List<java.lang.String> getUserInfoEncryptionAlgValuesSupported()
```
    userinfo_encryption_alg_values_supported. OPTIONAL.
    
    Returns:
    
    List of the JWE [JWE] encryption algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
  - getUserinfoEncryptionEncValuesSupported
```
@Nullable
java.util.List<java.lang.String> getUserinfoEncryptionEncValuesSupported()
```
    userinfo_encryption_enc_values_supported OPTIONAL.
    
    Returns:
    
    List of the JWE encryption algorithms (enc values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
  - getRequestObjectSigningAlgValuesSupported
```
@Nullable
java.util.List<java.lang.String> getRequestObjectSigningAlgValuesSupported()
```
    request_object_signing_alg_values_supported. OPTIONAL
    
    Returns:
    
    List of the JWS signing algorithms (alg values) supported by the OP for Request Objects.
  - getRequestObjectEncryptionAlgValuesSupported
```
@Nullable
java.util.List<java.lang.String> getRequestObjectEncryptionAlgValuesSupported()
```
    request_object_encryption_alg_values_supported OPTIONAL.
    
    Returns:
    
    list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects.
  - getRequestObjectEncryptionEncValuesSupported
```
@Nullable
java.util.List<java.lang.String> getRequestObjectEncryptionEncValuesSupported()
```
    request_object_encryption_enc_values_supported OPTIONAL.
    
    Returns:
    
    List of the JWE encryption algorithms (enc values) supported by the OP for Request Objects.
  - getTokenEndpointAuthMethodsSupported
```
@Nullable
java.util.List<java.lang.String> getTokenEndpointAuthMethodsSupported()
```
    token_endpoint_auth_methods_supported OPTIONAL.
    
    Returns:
    
    List of Client Authentication methods supported by this Token Endpoint.
  - getTokenEndpointAuthSigningAlgValuesSupported
```
@Nullable
java.util.List<java.lang.String> getTokenEndpointAuthSigningAlgValuesSupported()
```
    token_endpoint_auth_signing_alg_values_supported OPTIONAL.
    
    Returns:
    
    List of the JWS signing algorithms (alg values) supported by the Token Endpoint.
  - getDisplayValuesSupported
```
@Nullable
java.util.List<java.lang.String> getDisplayValuesSupported()
```
    display_values_supported OPTIONAL.
    
    Returns:
    
    List of the display parameter values that the OpenID Provider supports.
  - getClaimTypesSupported
```
@Nullable
java.util.List<java.lang.String> getClaimTypesSupported()
```
    claim_types_supported OPTIONAL.
    
    Returns:
    
    List of the Claim Types that the OpenID Provider supports.
  - getClaimsSupported
```
@Nullable
java.util.List<java.lang.String> getClaimsSupported()
```
    claims_supported RECOMMENDED.
    
    Returns:
    
    List of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for.
  - getServiceDocumentation
```
@Nullable
java.lang.String getServiceDocumentation()
```
    service_documentation OPTIONAL.
    
    Returns:
    
    URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider.
  - getClaimsLocalesSupported
```
@Nullable
java.util.List<java.lang.String> getClaimsLocalesSupported()
```
    claims_locales_supported OPTIONAL.
    
    Returns:
    
    Languages and scripts supported for values in Claims
  - getUriLocalesSupported
```
@Nullable
java.util.List<java.lang.String> getUriLocalesSupported()
```
    ui_locales_supported OPTIONAL.
    
    Returns:
    
    Languages and scripts supported for the user interface
  - getClaimsParameterSupported
```
@Nullable
java.lang.Boolean getClaimsParameterSupported()
```
    claims_parameter_supported OPTIONAL.
    
    Returns:
    
    Boolean value specifying whether the OP supports use of the claims parameter.
  - getRequestParameterSupported
```
@Nullable
java.lang.Boolean getRequestParameterSupported()
```
    request_parameter_supported OPTIONAL.
    
    Returns:
    
    Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.
  - getRequestUriParameterSupported
```
@Nullable
java.lang.Boolean getRequestUriParameterSupported()
```
    request_uri_parameter_supported OPTIONAL.
    
    Returns:
    
    Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.
  - getRequireRequestUriRegistration
```
@Nullable
java.lang.Boolean getRequireRequestUriRegistration()
```
    require_request_uri_registration OPTIONAL.
    
    Returns:
    
    Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter. Pre-registration is REQUIRED when the value is true. If omitted, the default value is false.
  - getOpPolicyUri
```
@Nullable
java.lang.String getOpPolicyUri()
```
    op_policy_uri OPTIONAL.
    
    Returns:
    
    URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on how the Relying Party can use the data provided by the OP.
  - getOpTosUri
```
@Nullable
java.lang.String getOpTosUri()
```
    op_tos_uri. OPTIONAL.
    
    Returns:
    
    URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service.
  - getCodeChallengeMethodsSupported
```
@Nullable
java.util.List<java.lang.String> getCodeChallengeMethodsSupported()
```
    code_challenge_methods_supported.
    
    Returns:
    
    List of the supported transformation methods by the authorisation code verifier for Proof Key for Code Exchange (PKCE).
  - getIntrospectionEndpointAuthMethodsSupported
```
@Nullable
java.util.List<java.lang.String> getIntrospectionEndpointAuthMethodsSupported()
```
    Returns:
    
    List of Client Authentication methods supported by Introspection Endpoint
  - getRevocationEndpointAuthMethodsSupported
```
@Nullable
java.util.List<java.lang.String> getRevocationEndpointAuthMethodsSupported()
```
    Returns:
    
    List of Client Authentication methods supported by Revocation Endpoint
  - getIntrospectionEndpoint
```
@Nullable
java.lang.String getIntrospectionEndpoint()
```
    Returns:
    
    The fully qualified URL of the server's introspection endpoint defined by OAuth Token Introspection [RFC7662]
    
    See Also:
    
    OAuth 2.0 Token Introspection
  - getRevocationEndpoint
```
@Nullable
java.lang.String getRevocationEndpoint()
```
    Returns:
    
    The fully qualified URL of the server's revocation endpoint defined by Oauth Token Revocation.
    
    See Also:
    
    OAuth 2.0 Token Revocation
  - getCheckSessionIframe
```
@Nullable
java.lang.String getCheckSessionIframe()
```
    check_session_iframe. REQUIRED
    
    Returns:
    
    URL of an OP iframe that supports cross-origin communications for session state information with the RP Client, using the HTML5 postMessage API.
  - getEndSessionEndpoint
```
@Nullable
java.lang.String getEndSessionEndpoint()
```
    end_session_endpoint. REQUIRED
    
    Returns:
    
    URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.
  - getTokenEndpointAuthMethods
```
@NonNull
default java.util.Optional<java.util.List<AuthenticationMethod>> getTokenEndpointAuthMethods()
```

Interface OpenIdProviderMetadata

Method Summary

Method Detail

getIssuer

getAuthorizationEndpoint

getTokenEndpoint

getUserinfoEndpoint

getJwksUri

getRegistrationEndpoint

getScopesSupported

getResponseTypesSupported

getResponseModesSupported

getGrantTypesSupported

getAcrValuesSupported

getSubjectTypesSupported

getIdTokenSigningAlgValuesSupported

getIdTokenEncryptionEncValuesSupported

getUserInfoEncryptionAlgValuesSupported

getUserinfoEncryptionEncValuesSupported

getRequestObjectSigningAlgValuesSupported

getRequestObjectEncryptionAlgValuesSupported

getRequestObjectEncryptionEncValuesSupported

getTokenEndpointAuthMethodsSupported

getTokenEndpointAuthSigningAlgValuesSupported

getDisplayValuesSupported

getClaimTypesSupported

getClaimsSupported

getServiceDocumentation

getClaimsLocalesSupported

getUriLocalesSupported

getClaimsParameterSupported

getRequestParameterSupported

getRequestUriParameterSupported

getRequireRequestUriRegistration

getOpPolicyUri

getOpTosUri

getCodeChallengeMethodsSupported

getIntrospectionEndpointAuthMethodsSupported

getRevocationEndpointAuthMethodsSupported

getIntrospectionEndpoint

getRevocationEndpoint

getCheckSessionIframe

getEndSessionEndpoint

getTokenEndpointAuthMethods