Package org.keycloak.models

Class Constants

java.lang.Object

org.keycloak.models.Constants

public final class Constants
extends Object

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCOUNT_CONSOLE_CLIENT_ID
static final String	ACCOUNT_MANAGEMENT_CLIENT_ID
static final String	ACR_LOA_MAP
static final String	ADMIN_CLI_CLIENT_ID
static final String	ADMIN_CONSOLE_CLIENT_ID
static final String	AIA_SILENT_CANCEL
static final String	AUTH_ADMIN_URL_PROP
static final String	AUTH_BASE_URL_PROP
static final String	AUTHENTICATION_EXECUTION
static final String	AUTHENTICATION_EXECUTION_REFERENCE_MAX_AGE
static final String	AUTHENTICATION_EXECUTION_REFERENCE_VALUE
static final String	AUTHENTICATION_EXPIRED_MESSAGE
static final String	AUTHENTICATORS_COMPLETED
static final String[]	AUTHZ_DEFAULT_AUTHORIZATION_ROLES
static final String	AUTHZ_UMA_AUTHORIZATION
static final String	AUTHZ_UMA_PROTECTION
static final String	BROKER_SERVICE_CLIENT_ID
static final String[]	BROKER_SERVICE_ROLES
static final String	CFG_DELIMITER
static final Pattern	CFG_DELIMITER_PATTERN
static final String	CLIENT_DATA
static final String	CLIENT_ID
static final String	CLIENT_POLICIES
static final String	CLIENT_PROFILES
static final String	CREDENTIAL_ID
static final int	DEFAULT_ACCESS_TOKEN_LIFESPAN_FOR_IMPLICIT_FLOW_TIMEOUT
static final String	DEFAULT_ACR_VALUES
static final int	DEFAULT_MAX_RESULTS
static final int	DEFAULT_OFFLINE_SESSION_IDLE_TIMEOUT
static final int	DEFAULT_OFFLINE_SESSION_MAX_LIFESPAN
static final String	DEFAULT_ROLES_ROLE_PREFIX
static final int	DEFAULT_SESSION_IDLE_TIMEOUT
static final int	DEFAULT_SESSION_MAX_LIFESPAN
static final String	DEFAULT_SIGNATURE_ALGORITHM
static final String	DEFAULT_WEBAUTHN_POLICY_NOT_SPECIFIED
static final String	DEFAULT_WEBAUTHN_POLICY_RP_ENTITY_NAME
static final String	DEFAULT_WEBAUTHN_POLICY_SIGNATURE_ALGORITHMS
static final Collection<String>	defaultClients
static final String	EXECUTION
static final String	FORCE_LEVEL_OF_AUTHENTICATION
static final String	GENERATE
static final String	INSTALLED_APP_URN
static final String	INTERNAL_SIGNATURE_ALGORITHM
static final String	IS_AIA_REQUEST
static final String	IS_TEMP_ADMIN_ATTR_NAME
static final String	KC_ACTION
static final String	KC_ACTION_ENFORCED	Auth session attribute whether an AIA is enforced, which means it cannot be cancelled.
static final String	KC_ACTION_EXECUTING
static final int	KC_ACTION_MAX_AGE
static final String	KC_ACTION_PARAMETER
static final String	KC_ACTION_STATUS
static final String	KEY
static final String	LEVEL_OF_AUTHENTICATION
static final String	LOA_MAP
static final String	MAPPER_GRANTED_GROUPS
static final String	MAPPER_GRANTED_ROLES
static final String	MAPPER_SESSION_NOTES
static final int	MINIMUM_LOA
static final int	NO_LOA
static final String	OFFLINE_ACCESS_ROLE
static final String	OFFLINE_ACCESS_SCOPE_CONSENT_TEXT
static final String	READ_TOKEN_ROLE
static final String	REALM_CLIENT
static final String	REALM_MANAGEMENT_CLIENT_ID
static final String	REQUESTED_LEVEL_OF_AUTHENTICATION
static final String	REUSE_ID
static final String	SECURITY_ADMIN_CONSOLE_ATTR
static final String	SESSION_NOTE_LIGHTWEIGHT_USER
static final String	SKIP_LINK
static final String	SKIP_LOGOUT
static final String	STORAGE_BATCH_ENABLED	If set as an attribute in the KeycloakSession, indicates that the storage should batch write operations.
static final String	STORAGE_BATCH_SIZE	If #STORAGE_BATCH_ENABLED is set, indicates the batch size.
static final String	SUPPORT_JWT_CLAIM_IN_INTROSPECTION_RESPONSE_ENABLED
static final String	TAB_ID
static final String	TEMPLATE_ATTR_ACTION_URI
static final String	TEMPLATE_ATTR_REQUIRED_ACTIONS
static final String	TOKEN
static final String	TOTP_SECRET_KEY
static final String	USE_LIGHTWEIGHT_ACCESS_TOKEN_ENABLED
static final String	USER_ATTRIBUTES_PREFIX
static final String	VERIFY_EMAIL_KEY
static final String	WEBAUTHN_PASSWORDLESS_PREFIX

Constructor Summary

Constructors

Constructor	Description
Constants()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ADMIN_CONSOLE_CLIENT_ID

public static final String ADMIN_CONSOLE_CLIENT_ID

See Also:

• Constant Field Values

ADMIN_CLI_CLIENT_ID

public static final String ADMIN_CLI_CLIENT_ID

See Also:

• Constant Field Values

ACCOUNT_MANAGEMENT_CLIENT_ID

public static final String ACCOUNT_MANAGEMENT_CLIENT_ID

See Also:

• Constant Field Values

ACCOUNT_CONSOLE_CLIENT_ID

public static final String ACCOUNT_CONSOLE_CLIENT_ID

See Also:

• Constant Field Values

BROKER_SERVICE_CLIENT_ID

public static final String BROKER_SERVICE_CLIENT_ID

See Also:

• Constant Field Values

REALM_MANAGEMENT_CLIENT_ID

public static final String REALM_MANAGEMENT_CLIENT_ID

See Also:

• Constant Field Values

AUTH_BASE_URL_PROP

public static final String AUTH_BASE_URL_PROP

See Also:

• Constant Field Values

AUTH_ADMIN_URL_PROP

public static final String AUTH_ADMIN_URL_PROP

See Also:

• Constant Field Values

defaultClients

public static final Collection<String> defaultClients

INSTALLED_APP_URN

public static final String INSTALLED_APP_URN

See Also:

• Constant Field Values

READ_TOKEN_ROLE

public static final String READ_TOKEN_ROLE

See Also:

• Constant Field Values

BROKER_SERVICE_ROLES

public static final String[] BROKER_SERVICE_ROLES

OFFLINE_ACCESS_ROLE

public static final String OFFLINE_ACCESS_ROLE

See Also:

• Constant Field Values

DEFAULT_ROLES_ROLE_PREFIX

public static final String DEFAULT_ROLES_ROLE_PREFIX

See Also:

• Constant Field Values

AUTHZ_UMA_PROTECTION

public static final String AUTHZ_UMA_PROTECTION

See Also:

• Constant Field Values

AUTHZ_UMA_AUTHORIZATION

public static final String AUTHZ_UMA_AUTHORIZATION

See Also:

• Constant Field Values

AUTHZ_DEFAULT_AUTHORIZATION_ROLES

public static final String[] AUTHZ_DEFAULT_AUTHORIZATION_ROLES

DEFAULT_ACCESS_TOKEN_LIFESPAN_FOR_IMPLICIT_FLOW_TIMEOUT

public static final int DEFAULT_ACCESS_TOKEN_LIFESPAN_FOR_IMPLICIT_FLOW_TIMEOUT

See Also:

• Constant Field Values

DEFAULT_OFFLINE_SESSION_IDLE_TIMEOUT

public static final int DEFAULT_OFFLINE_SESSION_IDLE_TIMEOUT

See Also:

• Constant Field Values

DEFAULT_OFFLINE_SESSION_MAX_LIFESPAN

public static final int DEFAULT_OFFLINE_SESSION_MAX_LIFESPAN

See Also:

• Constant Field Values

DEFAULT_SIGNATURE_ALGORITHM

public static final String DEFAULT_SIGNATURE_ALGORITHM

See Also:

• Constant Field Values

INTERNAL_SIGNATURE_ALGORITHM

public static final String INTERNAL_SIGNATURE_ALGORITHM

See Also:

• Constant Field Values

DEFAULT_SESSION_IDLE_TIMEOUT

public static final int DEFAULT_SESSION_IDLE_TIMEOUT

See Also:

• Constant Field Values

DEFAULT_SESSION_MAX_LIFESPAN

public static final int DEFAULT_SESSION_MAX_LIFESPAN

See Also:

• Constant Field Values

DEFAULT_WEBAUTHN_POLICY_SIGNATURE_ALGORITHMS

public static final String DEFAULT_WEBAUTHN_POLICY_SIGNATURE_ALGORITHMS

See Also:

• Constant Field Values

DEFAULT_WEBAUTHN_POLICY_RP_ENTITY_NAME

public static final String DEFAULT_WEBAUTHN_POLICY_RP_ENTITY_NAME

See Also:

• Constant Field Values

DEFAULT_WEBAUTHN_POLICY_NOT_SPECIFIED

public static final String DEFAULT_WEBAUTHN_POLICY_NOT_SPECIFIED

See Also:

• Constant Field Values

WEBAUTHN_PASSWORDLESS_PREFIX

public static final String WEBAUTHN_PASSWORDLESS_PREFIX

See Also:

• Constant Field Values

VERIFY_EMAIL_KEY

public static final String VERIFY_EMAIL_KEY

See Also:

• Constant Field Values

EXECUTION

public static final String EXECUTION

See Also:

• Constant Field Values

CLIENT_ID

public static final String CLIENT_ID

See Also:

• Constant Field Values

TOKEN

public static final String TOKEN

See Also:

• Constant Field Values

TAB_ID

public static final String TAB_ID

See Also:

• Constant Field Values

CLIENT_DATA

public static final String CLIENT_DATA

See Also:

• Constant Field Values

REUSE_ID

public static final String REUSE_ID

See Also:

• Constant Field Values

SKIP_LOGOUT

public static final String SKIP_LOGOUT

See Also:

• Constant Field Values

KEY

public static final String KEY

See Also:

• Constant Field Values

KC_ACTION

public static final String KC_ACTION

See Also:

• Constant Field Values

KC_ACTION_PARAMETER

public static final String KC_ACTION_PARAMETER

See Also:

• Constant Field Values

KC_ACTION_STATUS

public static final String KC_ACTION_STATUS

See Also:

• Constant Field Values

KC_ACTION_EXECUTING

public static final String KC_ACTION_EXECUTING

See Also:

• Constant Field Values

KC_ACTION_ENFORCED

public static final String KC_ACTION_ENFORCED

Auth session attribute whether an AIA is enforced, which means it cannot be cancelled.

Example use case: the action behind the AIA is also defined on the user (for example, UPDATE_PASSWORD).

See Also:

• Constant Field Values

KC_ACTION_MAX_AGE

public static final int KC_ACTION_MAX_AGE

See Also:

• Constant Field Values

IS_AIA_REQUEST

public static final String IS_AIA_REQUEST

See Also:

• Constant Field Values

AIA_SILENT_CANCEL

public static final String AIA_SILENT_CANCEL

See Also:

• Constant Field Values

AUTHENTICATION_EXECUTION

public static final String AUTHENTICATION_EXECUTION

See Also:

• Constant Field Values

CREDENTIAL_ID

public static final String CREDENTIAL_ID

See Also:

• Constant Field Values

SKIP_LINK

public static final String SKIP_LINK

See Also:

• Constant Field Values

TEMPLATE_ATTR_ACTION_URI

public static final String TEMPLATE_ATTR_ACTION_URI

See Also:

• Constant Field Values

TEMPLATE_ATTR_REQUIRED_ACTIONS

public static final String TEMPLATE_ATTR_REQUIRED_ACTIONS

See Also:

• Constant Field Values

USER_ATTRIBUTES_PREFIX

public static final String USER_ATTRIBUTES_PREFIX

See Also:

• Constant Field Values

MAPPER_GRANTED_ROLES

public static final String MAPPER_GRANTED_ROLES

See Also:

• Constant Field Values

MAPPER_GRANTED_GROUPS

public static final String MAPPER_GRANTED_GROUPS

See Also:

• Constant Field Values

MAPPER_SESSION_NOTES

public static final String MAPPER_SESSION_NOTES

See Also:

• Constant Field Values

GENERATE

public static final String GENERATE

See Also:

• Constant Field Values

DEFAULT_MAX_RESULTS

public static final int DEFAULT_MAX_RESULTS

See Also:

• Constant Field Values

CFG_DELIMITER

public static final String CFG_DELIMITER

See Also:

• Constant Field Values

CFG_DELIMITER_PATTERN

public static final Pattern CFG_DELIMITER_PATTERN

OFFLINE_ACCESS_SCOPE_CONSENT_TEXT

public static final String OFFLINE_ACCESS_SCOPE_CONSENT_TEXT

See Also:

• Constant Field Values

STORAGE_BATCH_ENABLED

public static final String STORAGE_BATCH_ENABLED

If set as an attribute in the KeycloakSession, indicates that the storage should batch write operations.

See Also:

• Constant Field Values

STORAGE_BATCH_SIZE

public static final String STORAGE_BATCH_SIZE

If #STORAGE_BATCH_ENABLED is set, indicates the batch size.

See Also:

• Constant Field Values

CLIENT_PROFILES

public static final String CLIENT_PROFILES

See Also:

• Constant Field Values

CLIENT_POLICIES

public static final String CLIENT_POLICIES

See Also:

• Constant Field Values

LEVEL_OF_AUTHENTICATION

public static final String LEVEL_OF_AUTHENTICATION

See Also:

• Constant Field Values

AUTHENTICATION_EXECUTION_REFERENCE_VALUE

public static final String AUTHENTICATION_EXECUTION_REFERENCE_VALUE

See Also:

• Constant Field Values

AUTHENTICATION_EXECUTION_REFERENCE_MAX_AGE

public static final String AUTHENTICATION_EXECUTION_REFERENCE_MAX_AGE

See Also:

• Constant Field Values

AUTHENTICATORS_COMPLETED

public static final String AUTHENTICATORS_COMPLETED

See Also:

• Constant Field Values

LOA_MAP

public static final String LOA_MAP

See Also:

• Constant Field Values

REQUESTED_LEVEL_OF_AUTHENTICATION

public static final String REQUESTED_LEVEL_OF_AUTHENTICATION

See Also:

• Constant Field Values

FORCE_LEVEL_OF_AUTHENTICATION

public static final String FORCE_LEVEL_OF_AUTHENTICATION

See Also:

• Constant Field Values

ACR_LOA_MAP

public static final String ACR_LOA_MAP

See Also:

• Constant Field Values

DEFAULT_ACR_VALUES

public static final String DEFAULT_ACR_VALUES

See Also:

• Constant Field Values

MINIMUM_LOA

public static final int MINIMUM_LOA

See Also:

• Constant Field Values

NO_LOA

public static final int NO_LOA

See Also:

• Constant Field Values

SESSION_NOTE_LIGHTWEIGHT_USER

public static final String SESSION_NOTE_LIGHTWEIGHT_USER

See Also:

• Constant Field Values

USE_LIGHTWEIGHT_ACCESS_TOKEN_ENABLED

public static final String USE_LIGHTWEIGHT_ACCESS_TOKEN_ENABLED

See Also:

• Constant Field Values

SUPPORT_JWT_CLAIM_IN_INTROSPECTION_RESPONSE_ENABLED

public static final String SUPPORT_JWT_CLAIM_IN_INTROSPECTION_RESPONSE_ENABLED

See Also:

• Constant Field Values

TOTP_SECRET_KEY

public static final String TOTP_SECRET_KEY

See Also:

• Constant Field Values

AUTHENTICATION_EXPIRED_MESSAGE

public static final String AUTHENTICATION_EXPIRED_MESSAGE

See Also:

• Constant Field Values

SECURITY_ADMIN_CONSOLE_ATTR

public static final String SECURITY_ADMIN_CONSOLE_ATTR

See Also:

• Constant Field Values

REALM_CLIENT

public static final String REALM_CLIENT

See Also:

• Constant Field Values

IS_TEMP_ADMIN_ATTR_NAME

public static final String IS_TEMP_ADMIN_ATTR_NAME

See Also:

• Constant Field Values

Constructor Details

Constants

public Constants()