update_realm_settings
Modify Keycloak realm settings, including display names, themes, user registration, email verification, login options, brute force protection, and SSL requirements to customize identity and access management.
Instructions
Update realm settings.
Args:
display_name: Display name for the realm
display_name_html: HTML display name
login_theme: Login theme name
account_theme: Account management theme
admin_theme: Admin console theme
email_theme: Email theme
enabled: Whether realm is enabled
registration_allowed: Allow user registration
registration_email_as_username: Use email as username
reset_password_allowed: Allow password reset
remember_me: Enable remember me
verify_email: Require email verification
login_with_email_allowed: Allow login with email
duplicate_emails_allowed: Allow duplicate emails
ssl_required: SSL requirement (none, external, all)
brute_force_protected: Enable brute force protection
permanent_lockout: Permanent lockout on max failures
max_failure_wait_seconds: Max wait after failures
minimum_quick_login_wait_seconds: Min wait between quick logins
wait_increment_seconds: Wait increment
quick_login_check_milli_seconds: Quick login check interval
max_delta_time_seconds: Max time between failures
failure_factor: Failure factor
default_locale: Default locale
realm: Target realm (uses default if not specified)
Returns:
Status message
Input Schema
Name | Required | Description | Default |
---|---|---|---|
account_theme | No | ||
admin_theme | No | ||
brute_force_protected | No | ||
default_locale | No | ||
display_name | No | ||
display_name_html | No | ||
duplicate_emails_allowed | No | ||
email_theme | No | ||
enabled | No | ||
failure_factor | No | ||
login_theme | No | ||
login_with_email_allowed | No | ||
max_delta_time_seconds | No | ||
max_failure_wait_seconds | No | ||
minimum_quick_login_wait_seconds | No | ||
permanent_lockout | No | ||
quick_login_check_milli_seconds | No | ||
realm | No | ||
registration_allowed | No | ||
registration_email_as_username | No | ||
remember_me | No | ||
reset_password_allowed | No | ||
ssl_required | No | ||
verify_email | No | ||
wait_increment_seconds | No |
Input Schema (JSON Schema)
{
"properties": {
"account_theme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Theme"
},
"admin_theme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Admin Theme"
},
"brute_force_protected": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Brute Force Protected"
},
"default_locale": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Default Locale"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"display_name_html": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name Html"
},
"duplicate_emails_allowed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Duplicate Emails Allowed"
},
"email_theme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Theme"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Enabled"
},
"failure_factor": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Failure Factor"
},
"login_theme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Login Theme"
},
"login_with_email_allowed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Login With Email Allowed"
},
"max_delta_time_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Delta Time Seconds"
},
"max_failure_wait_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Failure Wait Seconds"
},
"minimum_quick_login_wait_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum Quick Login Wait Seconds"
},
"permanent_lockout": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Permanent Lockout"
},
"quick_login_check_milli_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Quick Login Check Milli Seconds"
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Realm"
},
"registration_allowed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Registration Allowed"
},
"registration_email_as_username": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Registration Email As Username"
},
"remember_me": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Remember Me"
},
"reset_password_allowed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Reset Password Allowed"
},
"ssl_required": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ssl Required"
},
"verify_email": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Verify Email"
},
"wait_increment_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Wait Increment Seconds"
}
},
"title": "update_realm_settingsArguments",
"type": "object"
}