Package com.ringcentral.definitions
Class OpenIdDiscovery
java.lang.Object
com.ringcentral.definitions.OpenIdDiscovery
The OpenID Connect configuration document as defined by the
[OpenID Connect Discovery 1.0](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata) specification
-
Field Summary
FieldsModifier and TypeFieldDescriptionURL of the OAuth 2.0 authorization endpoint Required Format: uri Example: https://platform.ringcentral.com/restapi/oauth/authorizeBoolean value specifying whether the provide supports use of the `claims` parameterString[]The list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for Example: sub,iss,auth_time,exp Enum: sub, iss, auth_time, aud, exp, iat, jti, nonce, account_id, email, email_verified, given_name, family_nameString[]The list of the `display` parameter values (in OAuth 2.0 Authorization Endpoint) supported by the provider Enum: page, popup, touch, mobileString[]The list of the JWS signing algorithms (`alg` values) supported by the provider for the ID Token to encode the Claims in a JWT Required Example: RS256,HS256 Enum: RS256, HS256An identifier of the ID token's issuer.URL of JSON Web Key Set document that contains public key(s) to be used by the Relying Party to validate ID Token signatures Required Format: uri Example: https://platform.ringcentral.com/restapi/oauth/jwksBoolean value specifying whether the provide supports use of the `request` parameterBoolean value specifying whether the provide supports use of the `request` parameterString[]The list of the OAuth 2.0 `response_type` values supported by the provider Required Example: code Enum: codeURL of the OAuth 2.0 revocation endpoint as defined by [RFC-7009](https://datatracker.ietf.org/doc/html/rfc7009) Required Format: uri Example: https://platform.ringcentral.com/restapi/oauth/revokeString[]The list of the OAuth 2.0 scope values that this server supports Required Example: openid,email,profile Enum: openid, email, profileString[]The list of the Subject Identifier types supported by the provider (only `public` is currently supported) Required Example: public Enum: publicURL of the OAuth 2.0 token endpoint Required Format: uri Example: https://platform.ringcentral.com/restapi/oauth/tokenString[]The list of Client Authentication methods supported by the Token Endpoint Required Example: client_secret_basic Enum: client_secret_basic, client_secret_jwt, private_key_jwtString[]Language codes supported for the user interface, represented as language tags defined in [RFC-5646](https://datatracker.ietf.org/doc/html/rfc5646) Example: en,en-US,en-GB,fr-CAURL of the user info endpoint as defined by [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo) specification Required Format: uri Example: https://platform.ringcentral.com/restapi/oauth/userinfoString[]The list of the JWS signing algorithms (`alg` values) supported by the UserInfo Endpoint to encode the Claims in a JWT Required Example: none Enum: none -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionauthorization_endpoint(String authorization_endpoint) claims_parameter_supported(Boolean claims_parameter_supported) claims_supported(String[] claims_supported) display_values_supported(String[] display_values_supported) id_token_signing_alg_values_supported(String[] id_token_signing_alg_values_supported) request_parameter_supported(Boolean request_parameter_supported) request_uri_parameter_supported(Boolean request_uri_parameter_supported) response_types_supported(String[] response_types_supported) revocation_endpoint(String revocation_endpoint) scopes_supported(String[] scopes_supported) subject_types_supported(String[] subject_types_supported) token_endpoint(String token_endpoint) token_endpoint_auth_methods_supported(String[] token_endpoint_auth_methods_supported) ui_locales_supported(String[] ui_locales_supported) userinfo_endpoint(String userinfo_endpoint) userinfo_signing_alg_values_supported(String[] userinfo_signing_alg_values_supported)
-
Field Details
-
issuer
An identifier of the ID token's issuer. This value is identical to the `iss` Claim value in ID Tokens Required Format: uri Example: https://platform.ringcentral.com -
authorization_endpoint
URL of the OAuth 2.0 authorization endpoint Required Format: uri Example: https://platform.ringcentral.com/restapi/oauth/authorize -
token_endpoint
URL of the OAuth 2.0 token endpoint Required Format: uri Example: https://platform.ringcentral.com/restapi/oauth/token -
revocation_endpoint
URL of the OAuth 2.0 revocation endpoint as defined by [RFC-7009](https://datatracker.ietf.org/doc/html/rfc7009) Required Format: uri Example: https://platform.ringcentral.com/restapi/oauth/revoke -
userinfo_endpoint
URL of the user info endpoint as defined by [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo) specification Required Format: uri Example: https://platform.ringcentral.com/restapi/oauth/userinfo -
jwks_uri
URL of JSON Web Key Set document that contains public key(s) to be used by the Relying Party to validate ID Token signatures Required Format: uri Example: https://platform.ringcentral.com/restapi/oauth/jwks -
scopes_supported
The list of the OAuth 2.0 scope values that this server supports Required Example: openid,email,profile Enum: openid, email, profile -
token_endpoint_auth_methods_supported
The list of Client Authentication methods supported by the Token Endpoint Required Example: client_secret_basic Enum: client_secret_basic, client_secret_jwt, private_key_jwt -
response_types_supported
The list of the OAuth 2.0 `response_type` values supported by the provider Required Example: code Enum: code -
subject_types_supported
The list of the Subject Identifier types supported by the provider (only `public` is currently supported) Required Example: public Enum: public -
userinfo_signing_alg_values_supported
The list of the JWS signing algorithms (`alg` values) supported by the UserInfo Endpoint to encode the Claims in a JWT Required Example: none Enum: none -
id_token_signing_alg_values_supported
The list of the JWS signing algorithms (`alg` values) supported by the provider for the ID Token to encode the Claims in a JWT Required Example: RS256,HS256 Enum: RS256, HS256 -
display_values_supported
The list of the `display` parameter values (in OAuth 2.0 Authorization Endpoint) supported by the provider Enum: page, popup, touch, mobile -
claims_supported
The list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for Example: sub,iss,auth_time,exp Enum: sub, iss, auth_time, aud, exp, iat, jti, nonce, account_id, email, email_verified, given_name, family_name -
ui_locales_supported
Language codes supported for the user interface, represented as language tags defined in [RFC-5646](https://datatracker.ietf.org/doc/html/rfc5646) Example: en,en-US,en-GB,fr-CA -
claims_parameter_supported
Boolean value specifying whether the provide supports use of the `claims` parameter -
request_parameter_supported
Boolean value specifying whether the provide supports use of the `request` parameter -
request_uri_parameter_supported
Boolean value specifying whether the provide supports use of the `request` parameter
-
-
Constructor Details
-
OpenIdDiscovery
public OpenIdDiscovery()
-
-
Method Details
-
issuer
-
authorization_endpoint
-
token_endpoint
-
revocation_endpoint
-
userinfo_endpoint
-
jwks_uri
-
scopes_supported
-
token_endpoint_auth_methods_supported
public OpenIdDiscovery token_endpoint_auth_methods_supported(String[] token_endpoint_auth_methods_supported) -
response_types_supported
-
subject_types_supported
-
userinfo_signing_alg_values_supported
public OpenIdDiscovery userinfo_signing_alg_values_supported(String[] userinfo_signing_alg_values_supported) -
id_token_signing_alg_values_supported
public OpenIdDiscovery id_token_signing_alg_values_supported(String[] id_token_signing_alg_values_supported) -
display_values_supported
-
claims_supported
-
ui_locales_supported
-
claims_parameter_supported
-
request_parameter_supported
-
request_uri_parameter_supported
-