Package org.apereo.cas.support.oauth

Interface OAuth20Constants

public interface OAuth20Constants

This class has the main constants for the OAuth implementation.

Since:

3.5.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_DENIED	Access denied error.
static final String	ACCESS_TOKEN	The access token.
static final String	ACCESS_TOKEN_URL	The access token url.
static final String	ACR_VALUES	Authentication context reference values.
static final String	AUTHORIZATION_PENDING	Authz pending error.
static final String	AUTHORIZATION_STATE	Authz state.
static final String	AUTHORIZE_URL	The authorize url.
static final String	BASE_OAUTH20_URL	Base OAuth 2.0 url.
static final String	BYPASS_APPROVAL_PROMPT	The approval prompt.
static final String	CALLBACK_AUTHORIZE_URL	The callback authorize url.
static final String	CALLBACK_AUTHORIZE_URL_DEFINITION	The callback authorize url definition.
static final String	CLAIMS	The claims.
static final String	CLAIMS_SUBMITTED	Authz state claims submitted.
static final String	CLAIMS_USERINFO	userinfo claims found as claims request parameter.
static final String	CLIENT_ASSERTION	The client assertion jwt.
static final String	CLIENT_ASSERTION_TYPE	The client assertion type.
static final String	CLIENT_ASSERTION_TYPE_JWT_BEARER	Client assertion type as jwt bearer.
static final String	CLIENT_ID	The client id.
static final String	CLIENT_SECRET	The client secret.
static final String	CODE	The code.
static final String	CODE_CHALLENGE	PKCE code challenge.
static final String	CODE_CHALLENGE_METHOD	PKCE code challenge method.
static final String	CODE_VERIFIER	PKCE code verifier.
static final String	CONFIRM_VIEW	The confirm view.
static final String	DEVICE_AUTHZ_URL	device authorization url.
static final String	DEVICE_CODE	Device code flow device code.
static final String	DEVICE_CODE_APPROVAL_VIEW	The device code approval view.
static final String	DEVICE_CODE_APPROVED_VIEW	The device code approved view.
static final String	DEVICE_INTERVAL	Device code flow refresh interval.
static final String	DEVICE_USER_CODE	Device code flow user code.
static final String	DEVICE_VERIFICATION_URI	Device code flow verification uri.
static final String	DPOP	DPoP header.
static final String	DPOP_CONFIRMATION	DPoP confirmation that is put inside access token as an attribute.
static final String	ERROR	The error.
static final String	ERROR_DESCRIPTION	The error description.
static final String	ERROR_DETAILS	error details.
static final String	ERROR_WITH_CALLBACK	The error with callback.
static final String	EXPIRED_ACCESS_TOKEN	The expired access token.
static final String	EXPIRES_IN	The remaining time in seconds before expiration.
static final String	GRANT_TYPE	The grant type.
static final String	INTROSPECTION_JWT_HEADER_CONTENT_TYPE	Header value to signal JWT responses for token introspection payloads.
static final String	INTROSPECTION_URL	The introspection url.
static final String	INVALID_CLIENT	The invalid client.
static final String	INVALID_DPOP_PROOF	The invalid dpop.
static final String	INVALID_GRANT	The invalid grant.
static final String	INVALID_REQUEST	The invalid request.
static final String	INVALID_SCOPE	The invalid scope.
static final String	MISSING_ACCESS_TOKEN	The missing access token.
static final String	NEED_INFO	need information.
static final String	NONCE	The nonce parameter.
static final String	PROFILE_URL	The profile url.
static final String	PROMPT	The prompt parameter.
static final String	REDIRECT_URI	The redirect uri.
static final String	REFRESH_TOKEN	The refresh token.
static final String	REQUEST	The request passed as a jwt.
static final String	REQUEST_ATTRIBUTE_ACCESS_TOKEN_REQUEST	Internal attribute to indicate whether the incoming request is an access token request.
static final String	REQUESTING_PARTY_CLAIMS	requesting party claim.
static final String	RESPONSE_MODE	The response mode.
static final String	RESPONSE_TYPE	The response type.
static final String	REVOCATION_URL	The revocation url.
static final String	SCOPE	The scope request.
static final String	SESSION_STALE_MISMATCH	The oauthSessionStaleMismatchErrorView view.
static final String	SLOW_DOWN	slow down error for when approval requests are too quick.
static final String	STATE	The state.
static final String	TOKEN	The access token.
static final String	TOKEN_TYPE	The token type parameter.
static final String	TOKEN_TYPE_BEARER	The bearer type.
static final String	TOKEN_TYPE_DPOP	The DPOP Token.
static final String	TOKEN_URL	The token url.
static final String	UMA_AUTHORIZATION_REQUEST_URL	authorization registration endpoint URL.
static final String	UMA_AUTHORIZATION_SCOPE	UMA authz scope.
static final String	UMA_CLAIMS_COLLECTION_URL	claims collection endpoint URL.
static final String	UMA_JWKS_URL	URL endpoint that exposes JWKS for token signing.
static final String	UMA_PERMISSION_URL	permission registration endpoint URL.
static final String	UMA_POLICY_URL	policy registration endpoint URL.
static final String	UMA_PROTECTION_SCOPE	UMA protection scope.
static final String	UMA_REGISTRATION_URL	Registration endpoint URL.
static final String	UMA_RESOURCE_SET_REGISTRATION_URL	resource set registration endpoint URL.
static final String	UNAUTHORIZED_CLIENT	The unauthorized client.
static final String	UNMET_AUTHENTICATION_REQUIREMENTS	The Authorization Server is unable to meet the requirements of the Relying Party for the authentication of the End-User.
static final String	UNSUPPORTED_RESPONSE_TYPE	Unsupported response_type error.
static final String	X509_CERTIFICATE_DIGEST	X509 certificate hash used and collected during TLS authentication.

Field Details

REQUEST_ATTRIBUTE_ACCESS_TOKEN_REQUEST

static final String REQUEST_ATTRIBUTE_ACCESS_TOKEN_REQUEST

Internal attribute to indicate whether the incoming request is an access token request.

See Also:

• Constant Field Values

PROMPT

static final String PROMPT

The prompt parameter.

See Also:

• Constant Field Values

DEVICE_VERIFICATION_URI

static final String DEVICE_VERIFICATION_URI

Device code flow verification uri.

See Also:

• Constant Field Values

DEVICE_USER_CODE

static final String DEVICE_USER_CODE

Device code flow user code.

See Also:

• Constant Field Values

DEVICE_CODE

static final String DEVICE_CODE

Device code flow device code.

See Also:

• Constant Field Values

DEVICE_INTERVAL

static final String DEVICE_INTERVAL

Device code flow refresh interval.

See Also:

• Constant Field Values

ACR_VALUES

static final String ACR_VALUES

Authentication context reference values.

See Also:

• Constant Field Values

BASE_OAUTH20_URL

static final String BASE_OAUTH20_URL

Base OAuth 2.0 url.

See Also:

• Constant Field Values

REDIRECT_URI

static final String REDIRECT_URI

The redirect uri.

See Also:

• Constant Field Values

UNMET_AUTHENTICATION_REQUIREMENTS

static final String UNMET_AUTHENTICATION_REQUIREMENTS

The Authorization Server is unable to meet the requirements of the Relying Party for the authentication of the End-User.

See Also:

• Constant Field Values

RESPONSE_TYPE

static final String RESPONSE_TYPE

The response type.

See Also:

• Constant Field Values

RESPONSE_MODE

static final String RESPONSE_MODE

The response mode.

See Also:

• Constant Field Values

CLAIMS

static final String CLAIMS

The claims.

See Also:

• Constant Field Values

CLAIMS_USERINFO

static final String CLAIMS_USERINFO

userinfo claims found as claims request parameter.

See Also:

• Constant Field Values

REQUEST

static final String REQUEST

The request passed as a jwt.

See Also:

• Constant Field Values

GRANT_TYPE

static final String GRANT_TYPE

The grant type.

See Also:

• Constant Field Values

CLIENT_ID

static final String CLIENT_ID

The client id.

See Also:

• Constant Field Values

CODE_CHALLENGE

static final String CODE_CHALLENGE

PKCE code challenge.

See Also:

• Constant Field Values

CODE_VERIFIER

static final String CODE_VERIFIER

PKCE code verifier.

See Also:

• Constant Field Values

CODE_CHALLENGE_METHOD

static final String CODE_CHALLENGE_METHOD

PKCE code challenge method.

See Also:

• Constant Field Values

CLIENT_SECRET

static final String CLIENT_SECRET

The client secret.

See Also:

• Constant Field Values

BYPASS_APPROVAL_PROMPT

static final String BYPASS_APPROVAL_PROMPT

The approval prompt.

See Also:

• Constant Field Values

SCOPE

static final String SCOPE

The scope request.

See Also:

• Constant Field Values

CODE

static final String CODE

The code.

See Also:

• Constant Field Values

ERROR

static final String ERROR

The error.

See Also:

• Constant Field Values

ERROR_DESCRIPTION

static final String ERROR_DESCRIPTION

The error description.

See Also:

• Constant Field Values

ERROR_WITH_CALLBACK

static final String ERROR_WITH_CALLBACK

The error with callback.

See Also:

• Constant Field Values

UNSUPPORTED_RESPONSE_TYPE

static final String UNSUPPORTED_RESPONSE_TYPE

Unsupported response_type error.

See Also:

• Constant Field Values

STATE

static final String STATE

The state.

See Also:

• Constant Field Values

TOKEN

static final String TOKEN

The access token.

See Also:

• Constant Field Values

ACCESS_TOKEN

static final String ACCESS_TOKEN

The access token.

See Also:

• Constant Field Values

REFRESH_TOKEN

static final String REFRESH_TOKEN

The refresh token.

See Also:

• Constant Field Values

CLIENT_ASSERTION_TYPE

static final String CLIENT_ASSERTION_TYPE

The client assertion type.

See Also:

• Constant Field Values

CLIENT_ASSERTION

static final String CLIENT_ASSERTION

The client assertion jwt.

See Also:

• Constant Field Values

MISSING_ACCESS_TOKEN

static final String MISSING_ACCESS_TOKEN

The missing access token.

See Also:

• Constant Field Values

EXPIRED_ACCESS_TOKEN

static final String EXPIRED_ACCESS_TOKEN

The expired access token.

See Also:

• Constant Field Values

CONFIRM_VIEW

static final String CONFIRM_VIEW

The confirm view.

See Also:

• Constant Field Values

SESSION_STALE_MISMATCH

static final String SESSION_STALE_MISMATCH

The oauthSessionStaleMismatchErrorView view.

See Also:

• Constant Field Values

DEVICE_CODE_APPROVAL_VIEW

static final String DEVICE_CODE_APPROVAL_VIEW

The device code approval view.

See Also:

• Constant Field Values

DEVICE_CODE_APPROVED_VIEW

static final String DEVICE_CODE_APPROVED_VIEW

The device code approved view.

See Also:

• Constant Field Values

INVALID_CLIENT

static final String INVALID_CLIENT

The invalid client.

See Also:

• Constant Field Values

INVALID_REQUEST

static final String INVALID_REQUEST

The invalid request.

See Also:

• Constant Field Values

INVALID_GRANT

static final String INVALID_GRANT

The invalid grant.

See Also:

• Constant Field Values

INVALID_DPOP_PROOF

static final String INVALID_DPOP_PROOF

The invalid dpop.

See Also:

• Constant Field Values

INVALID_SCOPE

static final String INVALID_SCOPE

The invalid scope.

See Also:

• Constant Field Values

ACCESS_DENIED

static final String ACCESS_DENIED

Access denied error.

See Also:

• Constant Field Values

AUTHORIZATION_PENDING

static final String AUTHORIZATION_PENDING

Authz pending error.

See Also:

• Constant Field Values

AUTHORIZATION_STATE

static final String AUTHORIZATION_STATE

Authz state.

See Also:

• Constant Field Values

CLAIMS_SUBMITTED

static final String CLAIMS_SUBMITTED

Authz state claims submitted.

See Also:

• Constant Field Values

SLOW_DOWN

static final String SLOW_DOWN

slow down error for when approval requests are too quick.

See Also:

• Constant Field Values

AUTHORIZE_URL

static final String AUTHORIZE_URL

The authorize url.

See Also:

• Constant Field Values

INTROSPECTION_URL

static final String INTROSPECTION_URL

The introspection url.

See Also:

• Constant Field Values

INTROSPECTION_JWT_HEADER_CONTENT_TYPE

static final String INTROSPECTION_JWT_HEADER_CONTENT_TYPE

Header value to signal JWT responses for token introspection payloads.

See Also:

• Constant Field Values

CALLBACK_AUTHORIZE_URL

static final String CALLBACK_AUTHORIZE_URL

The callback authorize url.

See Also:

• Constant Field Values

CALLBACK_AUTHORIZE_URL_DEFINITION

static final String CALLBACK_AUTHORIZE_URL_DEFINITION

The callback authorize url definition.

See Also:

• Constant Field Values

ACCESS_TOKEN_URL

static final String ACCESS_TOKEN_URL

The access token url.

See Also:

• Constant Field Values

DEVICE_AUTHZ_URL

static final String DEVICE_AUTHZ_URL

device authorization url.

See Also:

• Constant Field Values

TOKEN_URL

static final String TOKEN_URL

The token url.

See Also:

• Constant Field Values

PROFILE_URL

static final String PROFILE_URL

The profile url.

See Also:

• Constant Field Values

REVOCATION_URL

static final String REVOCATION_URL

The revocation url.

See Also:

• Constant Field Values

EXPIRES_IN

static final String EXPIRES_IN

The remaining time in seconds before expiration.

See Also:

• Constant Field Values

NONCE

static final String NONCE

The nonce parameter.

See Also:

• Constant Field Values

TOKEN_TYPE

static final String TOKEN_TYPE

The token type parameter.

See Also:

• Constant Field Values

TOKEN_TYPE_BEARER

static final String TOKEN_TYPE_BEARER

The bearer type.

See Also:

• Constant Field Values

TOKEN_TYPE_DPOP

static final String TOKEN_TYPE_DPOP

The DPOP Token.

See Also:

• Constant Field Values

CLIENT_ASSERTION_TYPE_JWT_BEARER

static final String CLIENT_ASSERTION_TYPE_JWT_BEARER

Client assertion type as jwt bearer.

See Also:

• Constant Field Values

UMA_REGISTRATION_URL

static final String UMA_REGISTRATION_URL

Registration endpoint URL.

See Also:

• Constant Field Values

UMA_RESOURCE_SET_REGISTRATION_URL

static final String UMA_RESOURCE_SET_REGISTRATION_URL

resource set registration endpoint URL.

See Also:

• Constant Field Values

UMA_PERMISSION_URL

static final String UMA_PERMISSION_URL

permission registration endpoint URL.

See Also:

• Constant Field Values

UMA_POLICY_URL

static final String UMA_POLICY_URL

policy registration endpoint URL.

See Also:

• Constant Field Values

UMA_AUTHORIZATION_REQUEST_URL

static final String UMA_AUTHORIZATION_REQUEST_URL

authorization registration endpoint URL.

See Also:

• Constant Field Values

UMA_CLAIMS_COLLECTION_URL

static final String UMA_CLAIMS_COLLECTION_URL

claims collection endpoint URL.

See Also:

• Constant Field Values

UMA_JWKS_URL

static final String UMA_JWKS_URL

URL endpoint that exposes JWKS for token signing.

See Also:

• Constant Field Values

UMA_PROTECTION_SCOPE

static final String UMA_PROTECTION_SCOPE

UMA protection scope.

See Also:

• Constant Field Values

UMA_AUTHORIZATION_SCOPE

static final String UMA_AUTHORIZATION_SCOPE

UMA authz scope.

See Also:

• Constant Field Values

REQUESTING_PARTY_CLAIMS

static final String REQUESTING_PARTY_CLAIMS

requesting party claim.

See Also:

• Constant Field Values

ERROR_DETAILS

static final String ERROR_DETAILS

error details.

See Also:

• Constant Field Values

NEED_INFO

static final String NEED_INFO

need information.

See Also:

• Constant Field Values

UNAUTHORIZED_CLIENT

static final String UNAUTHORIZED_CLIENT

The unauthorized client.

See Also:

• Constant Field Values

DPOP

static final String DPOP

DPoP header.

See Also:

• Constant Field Values

DPOP_CONFIRMATION

static final String DPOP_CONFIRMATION

DPoP confirmation that is put inside access token as an attribute.

See Also:

• Constant Field Values

X509_CERTIFICATE_DIGEST

static final String X509_CERTIFICATE_DIGEST

X509 certificate hash used and collected during TLS authentication.

See Also:

• Constant Field Values