AuthorizationServiceDiscovery (AppAuth)

java.lang.Object
- net.openid.appauth.AuthorizationServiceDiscovery

```
public class AuthorizationServiceDiscovery
extends Object
```
An OpenID Connect 1.0 Discovery Document.

See Also:

"OpenID Provider Metadata", OpenID Connect Discovery 1.0, Section 3

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AuthorizationServiceDiscovery.MissingArgumentException` Thrown when a mandatory property is missing from the discovery document.

Field Summary

Fields
Modifier and Type Field and Description

JSONObject docJson
The JSON representation of the discovery document.

Fields
Modifier and Type	Field and Description
`JSONObject`	`docJson` The JSON representation of the discovery document.

Constructor Summary

Constructors
Constructor and Description

AuthorizationServiceDiscovery(JSONObject discoveryDoc)
Extracts a discovery document from its standard JSON representation.

Constructors
Constructor and Description
`AuthorizationServiceDiscovery(JSONObject discoveryDoc)` Extracts a discovery document from its standard JSON representation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getAcrValuesSupported()` The authentication context class references supported.
`Uri`	`getAuthorizationEndpoint()` The OAuth 2 authorization endpoint URI.
`List<String>`	`getClaimsLocalesSupported()` Languages and scripts supported for values in claims being returned.
`List<String>`	`getClaimsSupported()` The claim names of the claims that the provider may be able to supply values for.
`List<String>`	`getClaimTypesSupported()` The claim types supported.
`List<String>`	`getDisplayValuesSupported()` The `display` parameter values supported.
`List<String>`	`getGrantTypesSupported()` The OAuth 2 `grant_type` values supported.
`List<String>`	`getIdTokenEncryptionAlgorithmValuesSupported()` The JWE encryption algorithms (alg values) supported for encoding ID token claims.
`List<String>`	`getIdTokenEncryptionEncodingValuesSupported()` The JWE encryption encodings (enc values) supported for encoding ID token claims.
`List<String>`	`getIdTokenSigningAlgorithmValuesSupported()` The JWS signing algorithms (alg values) supported for encoding ID token claims.
`String`	`getIssuer()` The asserted issuer identifier.
`Uri`	`getJwksUri()` The JSON web key set document URI.
`Uri`	`getOpPolicyUri()` A page articulating the policy regarding the use of data provided by the provider.
`Uri`	`getOpTosUri()` A page articulating the terms of service for the provider.
`Uri`	`getRegistrationEndpoint()` The dynamic client registration endpoint URI.
`List<String>`	`getRequestObjectEncryptionAlgorithmValuesSupported()` The JWE encryption algorithms (alg values) supported for Request Objects.
`List<String>`	`getRequestObjectEncryptionEncodingValuesSupported()` The JWE encryption encodings (enc values) supported for Request Objects.
`List<String>`	`getRequestObjectSigningAlgorithmValuesSupported()` The JWS signing algorithms (alg values) supported for Request Objects.
`List<String>`	`getResponseModesSupported()` The OAuth 2 `response_mode` values supported.
`List<String>`	`getResponseTypesSupported()` The OAuth 2 `response_type` values supported.
`List<String>`	`getScopesSupported()` The OAuth 2 scope values supported.
`Uri`	`getServiceDocumentation()` A page containing human-readable information that developers might want or need to know when using this provider.
`List<String>`	`getSubjectTypesSupported()` The subject identifier types supported.
`Uri`	`getTokenEndpoint()` The OAuth 2 token endpoint URI.
`List<String>`	`getTokenEndpointAuthMethodsSupported()` The client authentication methods supported by the token endpoint.
`List<String>`	`getTokenEndpointAuthSigningAlgorithmValuesSupported()` The JWS signing algorithms (alg values) supported by the token endpoint for the signature on the JWT used to authenticate the client for the `private_key_jwt` and `client_secret_jwt` authentication methods.
`List<String>`	`getUiLocalesSupported()` Languages and scripts supported for the user interface.
`List<String>`	`getUserinfoEncryptionAlgorithmValuesSupported()` The JWE encryption algorithms (alg values) supported by the UserInfo Endpoint for encoding ID token claims.
`List<String>`	`getUserinfoEncryptionEncodingValuesSupported()` The JWE encryption encodings (enc values) supported by the UserInfo Endpoint for encoding ID token claims.
`Uri`	`getUserinfoEndpoint()` The OpenID Connect UserInfo endpoint URI.
`List<String>`	`getUserinfoSigningAlgorithmValuesSupported()` The JWS signing algorithms (alg values) supported by the UserInfo Endpoint for encoding ID token claims.
`boolean`	`isClaimsParameterSupported()` Specifies whether the `claims` parameter is supported for authorization requests.
`boolean`	`isRequestParameterSupported()` Specifies whether the `request` parameter is supported for authorization requests.
`boolean`	`isRequestUriParameterSupported()` Specifies whether the `request_uri` is supported for authorization requests.
`boolean`	`requireRequestUriRegistration()` Specifies whether `request_uri` values are required to be pre-registered before use.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - docJson
```
@NonNull
public final JSONObject docJson
```
    The JSON representation of the discovery document.
- Constructor Detail
  - AuthorizationServiceDiscovery
```
public AuthorizationServiceDiscovery(@NonNull
                                     JSONObject discoveryDoc)
                              throws JSONException,
                                     AuthorizationServiceDiscovery.MissingArgumentException
```
    Extracts a discovery document from its standard JSON representation.
    
    Throws:
    
    JSONException - if the provided JSON does not match the expected structure.
    
    AuthorizationServiceDiscovery.MissingArgumentException - if a mandatory property is missing from the discovery document.
- Method Detail
  - getIssuer
```
@NonNull
public String getIssuer()
```
    The asserted issuer identifier.
    
    See Also:
    
    "OpenID Connect Dynamic Client Registration 1.0"
  - getAuthorizationEndpoint
```
@NonNull
public Uri getAuthorizationEndpoint()
```
    The OAuth 2 authorization endpoint URI.
    
    See Also:
    
    "OpenID Connect Dynamic Client Registration 1.0"
  - getTokenEndpoint
```
@Nullable
public Uri getTokenEndpoint()
```
    The OAuth 2 token endpoint URI. Not specified if only the implicit flow is used.
    
    See Also:
    
    "OpenID Connect Dynamic Client Registration 1.0"
  - getUserinfoEndpoint
```
@Nullable
public Uri getUserinfoEndpoint()
```
    The OpenID Connect UserInfo endpoint URI.
    
    See Also:
    
    "OpenID Connect Dynamic Client Registration 1.0"
  - getJwksUri
```
@NonNull
public Uri getJwksUri()
```
    The JSON web key set document URI.
    
    See Also:
    
    "JSON Web Key (JWK)"
  - getRegistrationEndpoint
```
@Nullable
public Uri getRegistrationEndpoint()
```
    The dynamic client registration endpoint URI.
    
    See Also:
    
    "OpenID Connect Dynamic Client Registration 1.0"
  - getScopesSupported
```
public List<String> getScopesSupported()
```
    The OAuth 2 scope values supported.
    
    See Also:
    
    "The OAuth 2.0 Authorization Framework"
  - getResponseTypesSupported
```
@NonNull
public List<String> getResponseTypesSupported()
```
    The OAuth 2 response_type values supported.
  - getResponseModesSupported
```
@Nullable
public List<String> getResponseModesSupported()
```
    The OAuth 2 response_mode values supported.
    
    See Also:
    
    "OAuth 2.0 Multiple Response Type Encoding Practices"
  - getGrantTypesSupported
```
@NonNull
public List<String> getGrantTypesSupported()
```
    The OAuth 2 grant_type values supported. Defaults to authorization_code and implicit if not specified in the discovery document, as suggested by the discovery specification.
  - getAcrValuesSupported
```
public List<String> getAcrValuesSupported()
```
    The authentication context class references supported.
  - getSubjectTypesSupported
```
@NonNull
public List<String> getSubjectTypesSupported()
```
    The subject identifier types supported.
  - getIdTokenSigningAlgorithmValuesSupported
```
@NonNull
public List<String> getIdTokenSigningAlgorithmValuesSupported()
```
    The JWS signing algorithms (alg values) supported for encoding ID token claims.
    
    See Also:
    
    "JSON Web Token (JWT)"
  - getIdTokenEncryptionAlgorithmValuesSupported
```
@Nullable
public List<String> getIdTokenEncryptionAlgorithmValuesSupported()
```
    The JWE encryption algorithms (alg values) supported for encoding ID token claims.
    
    See Also:
    
    "JSON Web Token (JWT)"
  - getIdTokenEncryptionEncodingValuesSupported
```
@Nullable
public List<String> getIdTokenEncryptionEncodingValuesSupported()
```
    The JWE encryption encodings (enc values) supported for encoding ID token claims.
    
    See Also:
    
    "JSON Web Token (JWT)"
  - getUserinfoSigningAlgorithmValuesSupported
```
@Nullable
public List<String> getUserinfoSigningAlgorithmValuesSupported()
```
    The JWS signing algorithms (alg values) supported by the UserInfo Endpoint for encoding ID token claims.
    
    See Also:
    
    "JSON Web Signature (JWS)", "JSON Web Algorithms (JWA)", "JSON Web Token (JWT)"
  - getUserinfoEncryptionAlgorithmValuesSupported
```
@Nullable
public List<String> getUserinfoEncryptionAlgorithmValuesSupported()
```
    The JWE encryption algorithms (alg values) supported by the UserInfo Endpoint for encoding ID token claims.
    
    See Also:
    
    "JSON Web Signature (JWS)", "JSON Web Algorithms (JWA)", "JSON Web Token (JWT)"
  - getUserinfoEncryptionEncodingValuesSupported
```
@Nullable
public List<String> getUserinfoEncryptionEncodingValuesSupported()
```
    The JWE encryption encodings (enc values) supported by the UserInfo Endpoint for encoding ID token claims.
    
    See Also:
    
    "JSON Web Token (JWT)"
  - getRequestObjectSigningAlgorithmValuesSupported
```
public List<String> getRequestObjectSigningAlgorithmValuesSupported()
```
    The JWS signing algorithms (alg values) supported for Request Objects.
    
    See Also:
    
    "OpenID Connect Core 1.0", Section 6.1
  - getRequestObjectEncryptionAlgorithmValuesSupported
```
@Nullable
public List<String> getRequestObjectEncryptionAlgorithmValuesSupported()
```
    The JWE encryption algorithms (alg values) supported for Request Objects.
  - getRequestObjectEncryptionEncodingValuesSupported
```
@Nullable
public List<String> getRequestObjectEncryptionEncodingValuesSupported()
```
    The JWE encryption encodings (enc values) supported for Request Objects.
  - getTokenEndpointAuthMethodsSupported
```
@NonNull
public List<String> getTokenEndpointAuthMethodsSupported()
```
    The client authentication methods supported by the token endpoint. Defaults to client_secret_basic if the discovery document does not specify a value, as suggested by the discovery specification.
    
    See Also:
    
    "OpenID Connect Core 1.0", "The OAuth 2.0 Authorization Framework"
  - getTokenEndpointAuthSigningAlgorithmValuesSupported
```
@Nullable
public List<String> getTokenEndpointAuthSigningAlgorithmValuesSupported()
```
    The JWS signing algorithms (alg values) supported by the token endpoint for the signature on the JWT used to authenticate the client for the private_key_jwt and client_secret_jwt authentication methods.
    
    See Also:
    
    "JSON Web Token (JWT)"
  - getDisplayValuesSupported
```
@Nullable
public List<String> getDisplayValuesSupported()
```
    The display parameter values supported.
    
    See Also:
    
    "OpenID Connect Core 1.0"
  - getClaimTypesSupported
```
public List<String> getClaimTypesSupported()
```
    The claim types supported. Defaults to normal if not specified by the discovery document JSON, as suggested by the discovery specification.
    
    See Also:
    
    "OpenID Connect Core 1.0", Section 5.6
  - getClaimsSupported
```
@Nullable
public List<String> getClaimsSupported()
```
    The claim names of the claims that the provider may be able to supply values for.
  - getServiceDocumentation
```
@Nullable
public Uri getServiceDocumentation()
```
    A page containing human-readable information that developers might want or need to know when using this provider.
  - getClaimsLocalesSupported
```
@Nullable
public List<String> getClaimsLocalesSupported()
```
    Languages and scripts supported for values in claims being returned. Represented as a list of BCP47 language tag values.
    
    See Also:
    
    "Tags for Identifying Languages"
  - getUiLocalesSupported
```
@Nullable
public List<String> getUiLocalesSupported()
```
    Languages and scripts supported for the user interface. Represented as a list of BCP47 language tag values.
    
    See Also:
    
    "Tags for Identifying Languages"
  - isClaimsParameterSupported
```
public boolean isClaimsParameterSupported()
```
    Specifies whether the claims parameter is supported for authorization requests.
    
    See Also:
    
    "OpenID Connect Core 1.0", Section 5.5
  - isRequestParameterSupported
```
public boolean isRequestParameterSupported()
```
    Specifies whether the request parameter is supported for authorization requests.
    
    See Also:
    
    "OpenID Connect Core 1.0", Section 6.1
  - isRequestUriParameterSupported
```
public boolean isRequestUriParameterSupported()
```
    Specifies whether the request_uri is supported for authorization requests.
    
    See Also:
    
    "OpenID Connect Core 1.0", Section 6.2
  - requireRequestUriRegistration
```
public boolean requireRequestUriRegistration()
```
    Specifies whether request_uri values are required to be pre-registered before use.
    
    See Also:
    
    "OpenID Connect Core 1.0", Section 6.2
  - getOpPolicyUri
```
@Nullable
public Uri getOpPolicyUri()
```
    A page articulating the policy regarding the use of data provided by the provider.
  - getOpTosUri
```
@Nullable
public Uri getOpTosUri()
```
    A page articulating the terms of service for the provider.

Class AuthorizationServiceDiscovery

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

docJson

Constructor Detail

AuthorizationServiceDiscovery

Method Detail

getIssuer

getAuthorizationEndpoint

getTokenEndpoint

getUserinfoEndpoint

getJwksUri

getRegistrationEndpoint

getScopesSupported

getResponseTypesSupported

getResponseModesSupported

getGrantTypesSupported

getAcrValuesSupported

getSubjectTypesSupported

getIdTokenSigningAlgorithmValuesSupported

getIdTokenEncryptionAlgorithmValuesSupported

getIdTokenEncryptionEncodingValuesSupported

getUserinfoSigningAlgorithmValuesSupported

getUserinfoEncryptionAlgorithmValuesSupported

getUserinfoEncryptionEncodingValuesSupported

getRequestObjectSigningAlgorithmValuesSupported

getRequestObjectEncryptionAlgorithmValuesSupported

getRequestObjectEncryptionEncodingValuesSupported

getTokenEndpointAuthMethodsSupported

getTokenEndpointAuthSigningAlgorithmValuesSupported

getDisplayValuesSupported

getClaimTypesSupported

getClaimsSupported

getServiceDocumentation

getClaimsLocalesSupported

getUiLocalesSupported

isClaimsParameterSupported

isRequestParameterSupported

isRequestUriParameterSupported

requireRequestUriRegistration

getOpPolicyUri

getOpTosUri