Модуль community.general.keycloak_realm — позволяет администрировать realm Keycloak с помощью API Keycloak

access_code_lifespan

aliases: accessCodeLifespan

integer

Время жизни кода доступа области.

access_code_lifespan_login

aliases: accessCodeLifespanLogin

integer

Время жизни кода доступа области для входа.

access_code_lifespan_user_action

aliases: accessCodeLifespanUserAction

integer

Время жизни кода доступа области для действия пользователя.

access_token_lifespan

aliases: accessTokenLifespan

integer

Время жизни токена доступа области.

access_token_lifespan_for_implicit_flow

aliases: accessTokenLifespanForImplicitFlow

integer

Время жизни токена доступа области для неявного потока.

account_theme

aliases: accountTheme

string

Тема учетной записи области.

action_token_generated_by_admin_lifespan

aliases: actionTokenGeneratedByAdminLifespan

integer

Время жизни токена действия области, созданного администратором.

action_token_generated_by_user_lifespan

aliases: actionTokenGeneratedByUserLifespan

integer

Время жизни токена действия области, созданного пользователем.

admin_events_details_enabled

aliases: adminEventsDetailsEnabled

boolean

Включены ли подробные сведения о событиях администратора области.

Варианты:

• false
• true

admin_events_enabled

aliases: adminEventsEnabled

boolean

Включены ли события администратора области.

Варианты:

• false
• true

admin_permissions_enabled

aliases: adminPermissionsEnabled

boolean

добавлено в community.general 12.0.0

Включены ли разрешения администратора области.

Варианты:

• false
• true

admin_theme

aliases: adminTheme

string

Тема администратора области.

attributes

dictionary

Атрибуты области.

auth_client_id

string

client_id OpenID Connect для аутентификации в API.

По умолчанию: "admin-cli"

auth_client_secret

string

Секрет клиента, используемый вместе с auth_client_id (если требуется).

auth_keycloak_url

aliases: url

string / обязательный

URL экземпляра Keycloak.

auth_password

aliases: password

string

Пароль для аутентификации при доступе к API.

auth_realm

string

Имя области Keycloak для аутентификации при доступе к API.

auth_username

aliases: username

string

Имя пользователя для аутентификации при доступе к API.

browser_flow

aliases: browserFlow

string

Поток браузерной аутентификации области.

browser_security_headers

aliases: browserSecurityHeaders

dictionary

Заголовки безопасности браузера области.

brute_force_protected

aliases: bruteForceProtected

boolean

Защищена ли область от атак методом перебора.

Варианты:

• false
• true

brute_force_strategy

aliases: bruteForceStrategy

string

добавлено в community.general 11.2.0

Стратегия защиты области от атак методом перебора.

Варианты:

• "LINEAR"
• "MULTIPLE"

client_authentication_flow

aliases: clientAuthenticationFlow

string

Поток аутентификации клиента области.

client_offline_session_idle_timeout

aliases: clientOfflineSessionIdleTimeout

integer

добавлено в community.general 11.2.0

Все клиенты наследуют эту настройку: время бездействия офлайн-сеанса до его истечения.

client_offline_session_max_lifespan

aliases: clientOfflineSessionMaxLifespan

integer

добавлено в community.general 11.2.0

Все клиенты наследуют эту настройку: максимальное время до истечения офлайн-сеанса независимо от активности.

client_scope_mappings

aliases: clientScopeMappings

dictionary

Сопоставления областей клиента области.

client_session_idle_timeout

aliases: clientSessionIdleTimeout

integer

добавлено в community.general 11.2.0

Все клиенты наследуют эту настройку: время бездействия сеанса до его истечения.

client_session_max_lifespan

aliases: clientSessionMaxLifespan

integer

добавлено в community.general 11.2.0

Все клиенты наследуют эту настройку: максимальное время до истечения сеанса.

connection_timeout

integer

добавлено в community.general 4.5.0

Задает время ожидания HTTP-подключений к API Keycloak (в секундах).

По умолчанию: 10

default_default_client_scopes

aliases: defaultDefaultClientScopes

list / elements=string

Области клиента по умолчанию области по умолчанию.

default_groups

aliases: defaultGroups

list / elements=string

Группы области по умолчанию.

default_locale

aliases: defaultLocale

string

Язык области по умолчанию.

default_optional_client_scopes

aliases: defaultOptionalClientScopes

list / elements=string

Необязательные области клиента области по умолчанию.

default_roles

aliases: defaultRoles

list / elements=string

Роли области по умолчанию.

default_signature_algorithm

aliases: defaultSignatureAlgorithm

string

Алгоритм подписи области по умолчанию.

direct_grant_flow

aliases: directGrantFlow

string

Поток прямого предоставления области.

display_name

aliases: displayName

string

Отображаемое имя области.

display_name_html

aliases: displayNameHtml

string

HTML-код отображаемого имени области.

docker_authentication_flow

aliases: dockerAuthenticationFlow

string

Поток аутентификации Docker области.

duplicate_emails_allowed

aliases: duplicateEmailsAllowed

boolean

Разрешены ли повторяющиеся адреса электронной почты в области.

Варианты:

• false
• true

edit_username_allowed

aliases: editUsernameAllowed

boolean

Разрешено ли изменять имя пользователя в области.

Варианты:

• false
• true

email_theme

aliases: emailTheme

string

Тема электронной почты области.

enabled

boolean

Включена ли область.

Варианты:

• false
• true

enabled_event_types

aliases: enabledEventTypes

list / elements=string

Типы событий, включенные для области.

events_enabled

aliases: eventsEnabled

boolean

добавлено в community.general 3.6.0

Включает или отключает события входа для этой области.

Варианты:

• false
• true

events_expiration

aliases: eventsExpiration

integer

Срок хранения событий области.

events_listeners

псевдонимы: eventsListeners

list / elements=string

Слушатели событий области.

failure_factor

псевдонимы: failureFactor

integer

Коэффициент ошибок области.

first_broker_login_flow

псевдонимы: firstBrokerLoginFlow

string

добавлено в community.general 12.5.0

Процесс первого входа через брокер области.

http_agent

string

добавлено в community.general 5.4.0

Настраивает заголовок HTTP User-Agent.

По умолчанию: "Ansible"

id

string

Создаваемая область.

internationalization_enabled

псевдонимы: internationalizationEnabled

boolean

Параметр включения интернационализации области.

Варианты:

• false
• true

localization_texts

псевдонимы: localizationTexts

dictionary

добавлено в community.general 12.4.0

Пользовательские тексты локализации для области.

login_theme

псевдонимы: loginTheme

string

Тема страницы входа в область.

login_with_email_allowed

псевдонимы: loginWithEmailAllowed

boolean

Параметр разрешения входа в область по адресу электронной почты.

Варианты:

• false
• true

max_delta_time_seconds

псевдонимы: maxDeltaTimeSeconds

integer

Максимальная дельта времени области в секундах.

max_failure_wait_seconds

псевдонимы: maxFailureWaitSeconds

integer

Максимальное время ожидания после ошибки в области в секундах.

max_temporary_lockouts

псевдонимы: maxTemporaryLockouts

integer

добавлено в community.general 11.2.0

Максимальное число временных блокировок в области.

minimum_quick_login_wait_seconds

псевдонимы: minimumQuickLoginWaitSeconds

integer

Минимальное время ожидания перед быстрой повторной попыткой входа в область в секундах.

not_before

псевдонимы: notBefore

integer

Параметр not before области.

oauth2_device_code_lifespan

псевдонимы: oauth2DeviceCodeLifespan

integer

добавлено в community.general 11.2.0

Максимальное время до истечения срока действия кода устройства и пользовательского кода.

oauth2_device_polling_interval

псевдонимы: oauth2DevicePollingInterval

integer

добавлено в community.general 11.2.0

Минимальное время в секундах, которое клиент должен выждать между запросами опроса конечной точки токена.

offline_session_idle_timeout

псевдонимы: offlineSessionIdleTimeout

integer

Тайм-аут бездействия автономного сеанса области.

offline_session_max_lifespan

псевдонимы: offlineSessionMaxLifespan

integer

Максимальный срок действия автономного сеанса области.

offline_session_max_lifespan_enabled

псевдонимы: offlineSessionMaxLifespanEnabled

boolean

Параметр включения максимального срока действия автономного сеанса области.

Варианты:

• false
• true

organizations_enabled

псевдонимы: organizationsEnabled

boolean

добавлено в community.general 10.0.0

Включает поддержку экспериментальной функции организаций.

Варианты:

• false
• true

otp_policy_algorithm

псевдонимы: otpPolicyAlgorithm

string

Алгоритм политики OTP области.

otp_policy_digits

псевдонимы: otpPolicyDigits

integer

Количество цифр в политике OTP области.

otp_policy_initial_counter

псевдонимы: otpPolicyInitialCounter

integer

Начальный счетчик политики OTP области.

otp_policy_look_ahead_window

псевдонимы: otpPolicyLookAheadWindow

integer

Окно предварительного просмотра политики OTP области.

otp_policy_period

псевдонимы: otpPolicyPeriod

integer

Период политики OTP области.

otp_policy_type

псевдонимы: otpPolicyType

string

Тип политики OTP области.

otp_supported_applications

псевдонимы: otpSupportedApplications

list / elements=string

Приложения, поддерживающие OTP в области.

password_policy

псевдонимы: passwordPolicy

string

Политика паролей области.

permanent_lockout

псевдонимы: permanentLockout

boolean

Постоянная блокировка области.

Варианты:

• false
• true

quick_login_check_milli_seconds

псевдонимы: quickLoginCheckMilliSeconds

integer

Проверка быстрого входа в область в миллисекундах.

realm

string

Имя области.

refresh_token

string

добавлено в community.general 10.3.0

Токен обновления аутентификации для Keycloak API.

refresh_token_max_reuse

псевдонимы: refreshTokenMaxReuse

integer

Максимальное число повторных использований токена обновления области.

registration_allowed

псевдонимы: registrationAllowed

boolean

Параметр разрешения регистрации в области.

Варианты:

• false
• true

registration_email_as_username

псевдонимы: registrationEmailAsUsername

boolean

Параметр использования адреса электронной почты в качестве имени пользователя при регистрации в области.

Варианты:

• false
• true

registration_flow

псевдонимы: registrationFlow

string

Процесс регистрации в области.

remember_me

псевдонимы: rememberMe

boolean

Параметр запоминания пользователя в области.

Варианты:

• false
• true

reset_credentials_flow

псевдонимы: resetCredentialsFlow

string

Процесс сброса учетных данных области.

reset_password_allowed

псевдонимы: resetPasswordAllowed

boolean

Параметр разрешения сброса пароля в области.

Варианты:

• false
• true

revoke_refresh_token

псевдонимы: revokeRefreshToken

boolean

Параметр отзыва токена обновления в области.

Варианты:

• false
• true

smtp_server

псевдонимы: smtpServer

dictionary

SMTP-сервер области.

ssl_required

псевдонимы: sslRequired

string

Параметр обязательного использования SSL в области.

Варианты:

• "all"
• "external"
• "none"

sso_session_idle_timeout

псевдонимы: ssoSessionIdleTimeout

integer

Тайм-аут бездействия сеанса SSO области.

sso_session_idle_timeout_remember_me

псевдонимы: ssoSessionIdleTimeoutRememberMe

integer

Тайм-аут бездействия сеанса SSO области при включенном запоминании пользователя.

sso_session_max_lifespan

псевдонимы: ssoSessionMaxLifespan

integer

Максимальный срок действия сеанса SSO области.

sso_session_max_lifespan_remember_me

псевдонимы: ssoSessionMaxLifespanRememberMe

integer

Максимальный срок действия сеанса SSO области при включенном запоминании пользователя.

state

string

Состояние области.

При present область создаётся (или обновляется, если она уже существует).

При absent область удаляется, если она существует.

Варианты:

• "present" ← (по умолчанию)
• "absent"

supported_locales

псевдонимы: supportedLocales

list / элементы=string

Поддерживаемые языковые стандарты области.

token

string

добавлено в community.general 3.0.0

Токен аутентификации для API Keycloak.

user_managed_access_allowed

псевдонимы: userManagedAccessAllowed

boolean

Параметр разрешения управляемого пользователем доступа для области.

Варианты:

• false
• true

validate_certs

boolean

Проверять сертификаты TLS (не отключайте эту проверку в рабочей среде).

Варианты:

• false
• true ← (по умолчанию)

verify_email

псевдонимы: verifyEmail

boolean

Параметр подтверждения адреса электронной почты для области.

Варианты:

• false
• true

wait_increment_seconds

псевдонимы: waitIncrementSeconds

integer

Шаг ожидания для области в секундах.

web_authn_policy_acceptable_aaguids

псевдонимы: webAuthnPolicyAcceptableAaguids

list / элементы=string

добавлено в community.general 11.3.0

Список допустимых AAGUID для средств аутентификации WebAuthn.

web_authn_policy_attestation_conveyance_preference

псевдонимы: webAuthnPolicyAttestationConveyancePreference

string

добавлено в community.general 11.3.0

Предпочтительный способ передачи аттестации для WebAuthn.

web_authn_policy_authenticator_attachment

псевдонимы: webAuthnPolicyAuthenticatorAttachment

string

добавлено в community.general 11.3.0

Предпочтительный тип подключения средства аутентификации WebAuthn.

web_authn_policy_avoid_same_authenticator_register

псевдонимы: webAuthnPolicyAvoidSameAuthenticatorRegister

boolean

добавлено в community.general 11.3.0

Запретить повторную регистрацию одного и того же средства аутентификации.

Варианты:

• false
• true

web_authn_policy_create_timeout

псевдонимы: webAuthnPolicyCreateTimeout

integer

добавлено в community.general 11.3.0

Время ожидания создания учётных данных WebAuthn (мс).

web_authn_policy_extra_origins

псевдонимы: webAuthnPolicyExtraOrigins

list / элементы=string

добавлено в community.general 11.3.0

Дополнительные допустимые источники для запросов WebAuthn.

web_authn_policy_passwordless_acceptable_aaguids

псевдонимы: webAuthnPolicyPasswordlessAcceptableAaguids

list / элементы=string

добавлено в community.general 11.3.0

Список допустимых AAGUID для средств аутентификации WebAuthn без пароля.

web_authn_policy_passwordless_attestation_conveyance_preference

псевдонимы: webAuthnPolicyPasswordlessAttestationConveyancePreference

string

добавлено в community.general 11.3.0

Предпочтительный способ передачи аттестации для WebAuthn без пароля.

web_authn_policy_passwordless_authenticator_attachment

псевдонимы: webAuthnPolicyPasswordlessAuthenticatorAttachment

string

добавлено в community.general 11.3.0

Тип подключения средства аутентификации для WebAuthn без пароля.

web_authn_policy_passwordless_avoid_same_authenticator_register

псевдонимы: webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister

boolean

добавлено в community.general 11.3.0

Запретить повторную регистрацию одного и того же средства аутентификации для входа без пароля.

Варианты:

• false
• true

web_authn_policy_passwordless_create_timeout

псевдонимы: webAuthnPolicyPasswordlessCreateTimeout

integer

добавлено в community.general 11.3.0

Время ожидания создания учётных данных WebAuthn для входа без пароля (мс).

web_authn_policy_passwordless_extra_origins

псевдонимы: webAuthnPolicyPasswordlessExtraOrigins

list / элементы=string

добавлено в community.general 11.3.0

Дополнительные допустимые источники для запросов WebAuthn без пароля.

web_authn_policy_passwordless_passkeys_enabled

псевдонимы: webAuthnPolicyPasswordlessPasskeysEnabled

boolean

добавлено в community.general 12.1.0

Включить аутентификацию с помощью ключей доступа (условный интерфейс) в формах ввода имени пользователя.

Варианты:

• false
• true

web_authn_policy_passwordless_require_resident_key

псевдонимы: webAuthnPolicyPasswordlessRequireResidentKey

string

добавлено в community.general 11.3.0

Обязательны ли резидентные ключи для WebAuthn без пароля (Yes/No/not specified).

web_authn_policy_passwordless_rp_entity_name

псевдонимы: webAuthnPolicyPasswordlessRpEntityName

string

добавлено в community.general 11.3.0

Имя сущности стороны-полагающейся WebAuthn без пароля.

web_authn_policy_passwordless_rp_id

псевдонимы: webAuthnPolicyPasswordlessRpId

string

добавлено в community.general 11.3.0

Идентификатор стороны-полагающейся WebAuthn без пароля (домен).

web_authn_policy_passwordless_signature_algorithms

псевдонимы: webAuthnPolicyPasswordlessSignatureAlgorithms

list / элементы=string

добавлено в community.general 11.3.0

Список допустимых алгоритмов подписи WebAuthn для входа без пароля.

web_authn_policy_passwordless_user_verification_requirement

псевдонимы: webAuthnPolicyPasswordlessUserVerificationRequirement

string

добавлено в community.general 11.3.0

Требование проверки пользователя для WebAuthn без пароля.

web_authn_policy_require_resident_key

псевдонимы: webAuthnPolicyRequireResidentKey

string

добавлено в community.general 11.3.0

Обязательны ли резидентные ключи для WebAuthn (Да/Нет/не указано).

web_authn_policy_rp_entity_name

псевдонимы: webAuthnPolicyRpEntityName

string

добавлено в community.general 11.3.0

Имя сущности стороны-полагающейся WebAuthn.

web_authn_policy_rp_id

псевдонимы: webAuthnPolicyRpId

string

добавлено в community.general 11.3.0

Идентификатор стороны-полагающейся WebAuthn (домен). Пустая строка означает, что используется хост запроса.

web_authn_policy_signature_algorithms

псевдонимы: webAuthnPolicySignatureAlgorithms

list / элементы=string

добавлено в community.general 11.3.0

Список допустимых алгоритмов подписи WebAuthn.

web_authn_policy_user_verification_requirement

псевдонимы: webAuthnPolicyUserVerificationRequirement

string

добавлено в community.general 11.3.0

Требование проверки пользователя для WebAuthn.

action_group

Группа действий: community.general.keycloak

добавлено в community.general 10.2.0

Используйте group/community.general.keycloak в module_defaults, чтобы задать значения по умолчанию для этого модуля.

check_mode

Поддержка: full

Может выполняться в режиме check_mode и возвращать прогнозируемый статус изменений, не изменяя целевой объект.

diff_mode

Поддержка: full

В режиме сравнения возвращает сведения о том, что изменилось (или, возможно, требует изменения в check_mode).

end_state

dictionary

Представление области после выполнения модуля (пример усечён).

Возвращается: при успешном выполнении

Пример: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

existing

dictionary

Представление существующей области (пример усечён).

Возвращается: всегда

Пример: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

msg

string

Сообщение о выполненном действии.

Возвращается: всегда

Пример: "Realm testrealm has been updated"

proposed

dictionary

Представление предлагаемой области.

Возвращается: всегда

Пример: {"realm": "test"}