102 lines
14 KiB
JSON
102 lines
14 KiB
JSON
{
|
|
"fromDisplayName": "A user-friendly name for the 'From' address (optional).",
|
|
"replyToDisplayName": "A user-friendly name for the 'Reply-To' address (optional).",
|
|
"envelopeFrom": "An email address used for bounces (optional).",
|
|
"password": "SMTP password. This field is able to obtain its value from vault, use ${vault.ID} format.",
|
|
"frontendUrl": "Set the frontend URL for the realm. Use in combination with the default hostname provider to override the base URL for frontend requests for a specific realm.",
|
|
"requireSsl": "Is HTTPS required? 'None' means HTTPS is not required for any client IP address. 'External requests' means localhost and private IP addresses can access without HTTPS. 'All requests' means HTTPS is required for all IP addresses.",
|
|
"userManagedAccess": "If enabled, users are allowed to manage their resources and permissions using the Account Management UI.",
|
|
"userProfileEnabled": "If enabled, allows managing user profiles.",
|
|
"endpoints": "Shows the configuration of the protocol endpoints",
|
|
"loginTheme": "Select theme for login, OTP, grant, registration and forgot password pages.",
|
|
"accountTheme": "Select a theme for the user account management console.",
|
|
"adminTheme": "Select a theme for administration console.",
|
|
"emailTheme": "Select a theme for emails that are sent by the server.",
|
|
"displayName": "Display name of provider when linked in Admin UI",
|
|
"priority": "Priority of the provider",
|
|
"enabled": "Set if the keys are enabled",
|
|
"active": "Set if the keys can be used for signing",
|
|
"AESKeySize": "Size in bytes for the generated AES key. Size 16 is for AES-128, Size 24 for AES-192, and Size 32 for AES-256. WARN: Bigger keys than 128 are not allowed on some JDK implementations.",
|
|
"save-user-events": "If enabled, user events are saved to the database, which makes events available to the admin and account management UIs.",
|
|
"save-admin-events": "If enabled, admin events are saved to the database, which makes events available to the Admin UI.",
|
|
"expiration": "Sets the expiration for events. Expired events are periodically deleted from the database.",
|
|
"admin-clearEvents": "Deletes all admin events in the database.",
|
|
"includeRepresentation": "Include JSON representation for create and update requests.",
|
|
"user-clearEvents": "Deletes all user events in the database.",
|
|
"ellipticCurve": "Elliptic curve used in ECDSA",
|
|
"secretSize": "Size in bytes for the generated secret",
|
|
"keySize": "Size for the generated keys",
|
|
"algorithm": "Intended algorithm for the key",
|
|
"keystore": "Path to keys file",
|
|
"keystorePassword": "Password for the keys",
|
|
"keyAlias": "Alias for the private key",
|
|
"keyPassword": "Password for the private key",
|
|
"privateRSAKey": "Private RSA Key encoded in PEM format",
|
|
"x509Certificate": "X509 Certificate encoded in PEM format",
|
|
"xFrameOptions": "Default value prevents pages from being included by non-origin iframes <1>Learn more</1>",
|
|
"contentSecurityPolicy": "Default value prevents pages from being included by non-origin iframes <1>Learn more</1>",
|
|
"contentSecurityPolicyReportOnly": "For testing Content Security Policies <1>Learn more</1>",
|
|
"xContentTypeOptions": "Default value prevents Internet Explorer and Google Chrome from MIME-sniffing a response away from the declared content-type <1>Learn more</1>",
|
|
"xRobotsTag": "Prevent pages from appearing in search engines <1>Learn more</1>",
|
|
"xXSSProtection": "This header configures the Cross-site scripting (XSS) filter in your browser. Using the default behaviour, the browser will prevent rendering of the page when a XSS attack is detected. <1>Learn more</1>",
|
|
"strictTransportSecurity": "The Strict-Transport-Security HTTP header tells browsers to always use HTTPS. Once a browser sees this header, it will only visit the site over HTTPS for the time specified (1 year) at max-age, including the subdomains. <1>Learn more</1>",
|
|
"failureFactor": "How many failures before wait is triggered.",
|
|
"permanentLockout": "Lock the user permanently when the user exceeds the maximum login failures.",
|
|
"waitIncrementSeconds": "When failure threshold has been met, how much time should the user be locked out?",
|
|
"maxFailureWaitSeconds": "Max time a user will be locked out.",
|
|
"maxDeltaTimeSeconds": "When will failure count be reset?",
|
|
"quickLoginCheckMilliSeconds": "If a failure happens concurrently too quickly, lock out the user.",
|
|
"minimumQuickLoginWaitSeconds": "How long to wait after a quick login failure.",
|
|
"ssoSessionIdle": "Time a session is allowed to be idle before it expires. Tokens and browser sessions are invalidated when a session is expired.",
|
|
"ssoSessionMax": "Max time before a session is expired. Tokens and browser sessions are invalidated when a session is expired.",
|
|
"ssoSessionIdleRememberMe": "Time a remember me session is allowed to be idle before it expires. Tokens and browser sessions are invalidated when a session is expired. If not set it uses the standard SSO Session Idle value.",
|
|
"ssoSessionMaxRememberMe": "Max time before a session is expired when a user has set the remember me option. Tokens and browser sessions are invalidated when a session is expired. If not set it uses the standard SSO Session Max value.",
|
|
"clientSessionIdle": "Time a client session is allowed to be idle before it expires. Tokens are invalidated when a client session is expired. The option does not affect the global user SSO session. If not set, it uses the standard SSO Session Idle value.",
|
|
"clientSessionMax": "Max time before a client session is expired. Tokens are invalidated when a session is expired. The option does not affect the global user SSO session. If not set, it uses the standard SSO Session Max value.",
|
|
"offlineSessionIdle": "Time an offline session is allowed to be idle before it expires. You need to use offline token to refresh at least once within this period; otherwise offline session will expire.",
|
|
"offlineSessionMaxLimited": "Enable offline session max",
|
|
"offlineSessionMax": "Max time before an offline session is expired regardless of activity.",
|
|
"loginTimeout": "Max time a user has to complete a login. This is recommended to be relatively long, such as 30 minutes or more",
|
|
"loginActionTimeout": "Max time a user has to complete login related actions like update password or configure totp. This is recommended to be relatively long, such as 5 minutes or more",
|
|
"defaultSigAlg": "Default algorithm used to sign tokens for the realm",
|
|
"revokeRefreshToken": "If enabled a refresh token can only be used up to 'Refresh Token Max Reuse' and is revoked when a different token is used. Otherwise refresh tokens are not revoked when used and can be used multiple times.",
|
|
"refreshTokenMaxReuse": "Maximum number of times a refresh token can be reused. When a different token is used, revocation is immediate.",
|
|
"accessTokenLifespan": "Max time before an access token is expired. This value is recommended to be short relative to the SSO timeout",
|
|
"accessTokenLifespanImplicitFlow": "Max time before an access token issued during OpenID Connect Implicit Flow is expired. This value is recommended to be shorter than the SSO timeout. There is no possibility to refresh token during implicit flow, that's why there is a separate timeout different to 'Access Token Lifespan'",
|
|
"clientLoginTimeout": "Max time a client has to finish the access token protocol. This should normally be 1 minute.",
|
|
"userInitiatedActionLifespan": "Maximum time before an action permit sent by a user (such as a forgot password e-mail) is expired. This value is recommended to be short because it's expected that the user would react to self-created action quickly.",
|
|
"defaultAdminInitiatedActionLifespan": "Maximum time before an action permit sent to a user by administrator is expired. This value is recommended to be long to allow administrators to send e-mails for users that are currently offline. The default timeout can be overridden immediately before issuing the token.",
|
|
"oAuthDeviceCodeLifespan": "Max time before the device code and user code are expired. This value needs to be a long enough lifetime to be usable (allowing the user to retrieve their secondary device, navigate to the verification URI, login, etc.), but should be sufficiently short to limit the usability of a code obtained for phishing.",
|
|
"oAuthDevicePollingInterval": "The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint.",
|
|
"shortVerificationUriTooltip": "If set, this value will be return as verification_uri in Device Authorization flow. This uri need to redirect to {server-root}/realms/{realm}/device",
|
|
"overrideActionTokens": "Override default settings of maximum time before an action permit sent by a user (such as a forgot password e-mail) is expired for specific action. This value is recommended to be short because it's expected that the user would react to self-created action quickly.",
|
|
"internationalization": "If enabled, you can choose which locales you support for this realm and which locale is the default.",
|
|
"supportedLocales": "The locales to support for this realm. The user chooses one of these locales on the login screen.",
|
|
"defaultLocale": "The initial locale to use. It is used on the login screen and other screens in the Admin UI and Account UI.",
|
|
"conditions": "Conditions, which will be evaluated to determine if client policy should be applied during particular action or not.",
|
|
"clientProfiles": "Client profiles applied on this policy.",
|
|
"anyClient": "The condition is satisfied by any client on any event.",
|
|
"clientAccessType": "It uses the client's access type (confidential, public, bearer-only) to determine whether the policy is applied. Condition is checked during most of OpenID Connect requests (Authorization requests, token requests, introspection endpoint request, etc.)",
|
|
"clientAccesstypeTooltip": "Access Type of the client, for which the condition will be applied.",
|
|
"clientRoles": "The condition checks whether one of the specified client roles exists on the client to determine whether the policy is applied. This effectively allows client administrator to create client role of specified name on the client to make sure that particular client policy will be applied on requests of this client. Condition is checked during most of OpenID Connect requests (Authorization requests, token requests, introspection endpoint request, etc.)",
|
|
"clientRolesConditionTooltip": "Client roles, which will be checked during this condition evaluation. Condition evaluates to true if client has at least one client role with the name as the client roles specified in the configuration.",
|
|
"clientScopes": "It uses the scopes requested or assigned in advance to the client to determine whether the policy is applied to this client. Condition is evaluated during OpenID Connect authorization request and/or token request.",
|
|
"clientScopesConditionTooltip": "The list of expected client scopes. Condition evaluates to true if specified client request matches some of the client scopes. It depends also whether it should be default or optional client scope based on the 'Scope Type' configured.",
|
|
"clientUpdaterContext": "The condition checks the context how is client created/updated to determine whether the policy is applied. For example it checks if client is created with admin REST API or OIDC dynamic client registration. And for the letter case if it is ANONYMOUS client registration or AUTHENTICATED client registration with Initial access token or Registration access token and so on.",
|
|
"clientUpdaterSourceGroups": "The condition checks the group of the entity who tries to create/update the client to determine whether the policy is applied.",
|
|
"clientUpdaterSourceGroupsTooltip": "Name of groups to check. Condition evaluates to true if the entity, who creates/updates client is member of some of the specified groups. Configured groups are specified by their simple name, which must match to the name of the Keycloak group. No support for group hierarchy is used here.",
|
|
"clientUpdaterSourceHost": "The condition checks the host/domain of the entity who tries to create/update the client to determine whether the policy is applied.",
|
|
"clientUpdaterTrustedHostsTooltip": "List of Hosts, which are trusted. In case that client registration/update request comes from the host/domain specified in this configuration, condition evaluates to true. You can use hostnames or IP addresses. If you use star at the beginning (for example '*.example.com' ) then whole domain example.com will be trusted.",
|
|
"clientUpdaterSourceRoles": "The condition checks the role of the entity who tries to create/update the client to determine whether the policy is applied.",
|
|
"clientUpdaterSourceRolesTooltip": "The condition is checked during client registration/update requests and it evaluates to true if the entity (usually user), who is creating/updating client is member of the specified role. For reference the realm role, you can use the realm role name like 'my_realm_role' . For reference client role, you can use the client_id.role_name for example 'my_client.my_client_role' will refer to client role 'my_client_role' of client 'my_client'. ",
|
|
"defaultGroups": "Default groups allow you to automatically assign groups membership whenever any new user is created or imported through <1>identity brokering</1>.",
|
|
"attributeGeneralSettingsDescription": "This section contains a few basic settings common to all attributes.",
|
|
"attributeNameHelp": "The name of the attribute.",
|
|
"attributeDisplayNameHelp": "Display name for the attribute. Supports keys for localized values as well. For example: ${profile.attribute.phoneNumber}.",
|
|
"attributeGroupHelp": "user.profile.attribute.group.tooltip",
|
|
"requiredHelp": "Set the attribute as required. If enabled, the attribute must be set by users and administrators. Otherwise, the attribute is optional.",
|
|
"attributePermissionDescription": "This section contains permissions for who can edit and who can view the attribute.",
|
|
"whoCanEditHelp": "If enabled, users or administrators can view and edit the attribute. Otherwise, users or administrators don't have access to write to the attribute.",
|
|
"whoCanViewHelp": "If enabled, users or administrators can view the attribute. Otherwise, users or administrators don't have access to the attribute.",
|
|
"editUsername": "If enabled, the username field is editable, readonly otherwise."
|
|
}
|