Spec-Zone.ru › Ansible

community.general.keycloak_realm модуль – Разрешает администрирование домена Keycloak через API Keycloak

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать его в книге задач, укажите: community.general.keycloak_realm.

Новая функция в community.general 3.0.0

  • Описание
  • Параметры
  • Атрибуты
  • Примеры
  • Возвращаемые значения

Описание

  • Этот модуль позволяет управлять доменом Keycloak через REST API Keycloak. Он требует доступа к REST API через OpenID Connect; пользователь, подключающийся, и используемый домен должны иметь соответствующие права доступа. В стандартной установке Keycloak admin-cli и пользователь-администратор будут работать, как и отдельное определение домена со scope, настроенным под ваши потребности, и пользователем с ожидаемыми ролями.
  • Имена параметров модуля представляют собой snake_case версии camelCase, найденные в API Keycloak и его документации по адресу https://www.keycloak.org/docs-api/8.0/rest-api/index.html. Предоставляются алиасы, чтобы можно было использовать также camelCased версии.
  • API Keycloak не всегда проверяет корректность ввода, например, вы можете задать настройки, специфичные для SAML, на клиенте OpenID Connect, и наоборот. Будьте внимательны. Если вы не укажете настройку, обычно выбирается разумное значение по умолчанию.
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

access_code_lifespan

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

целое число

Срок действия кода доступа для домена.

access_code_lifespan_login

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

целое число

Срок действия входа по коду доступа для домена.

access_code_lifespan_user_action

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

целое число

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

access_token_lifespan

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

целое число

Срок действия маркера доступа для домена.

access_token_lifespan_for_implicit_flow

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

целое число

Срок действия маркера доступа для неявного потока.

account_theme

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

строка

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

action_token_generated_by_admin_lifespan

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

целое число

Срок действия маркера действия, сгенерированного администратором.

action_token_generated_by_user_lifespan

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

целое число

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

admin_events_details_enabled

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

логический тип

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

Варианты:

  • false
  • true

admin_events_enabled

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

логический тип

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

Варианты:

  • false
  • true

admin_theme

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

строка

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

attributes

словарь

Атрибуты домена.

auth_client_id

строка

Идентификатор клиента OpenID Connect для аутентификации API.

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

auth_client_secret

строка

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

auth_keycloak_url

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

строка / обязательно

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

auth_password

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

строка

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

auth_realm

строка

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

auth_username

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

строка

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

browser_flow

aliases: browserFlow

string

Поток браузера для домена.

browser_security_headers

aliases: browserSecurityHeaders

dictionary

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

brute_force_protected

aliases: bruteForceProtected

boolean

Защита от атак brute force для домена.

Варианты:

  • false
  • true

client_authentication_flow

aliases: clientAuthenticationFlow

string

Поток аутентификации клиента для домена.

client_scope_mappings

aliases: clientScopeMappings

dictionary

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

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

Параметр realm edit username allowed.

Варианты:

  • false
  • true

email_theme

aliases: emailTheme

string

Тема realm для электронной почты.

enabled

boolean

Параметр realm enabled.

Варианты:

  • false
  • true

enabled_event_types

aliases: enabledEventTypes

list / elements=string

Включенные типы событий realm.

events_enabled

aliases: eventsEnabled

boolean

added in community.general 3.6.0

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

Варианты:

  • false
  • true

events_expiration

aliases: eventsExpiration

integer

Срок действия событий realm.

events_listeners

aliases: eventsListeners

list / elements=string

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

failure_factor

aliases: failureFactor

integer

Коэффициент ошибок realm.

http_agent

string

added in community.general 5.4.0

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

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

id

string

Realm для создания.

internationalization_enabled

aliases: internationalizationEnabled

boolean

Параметр realm internationalization enabled.

Варианты:

  • false
  • true

login_theme

aliases: loginTheme

string

Тема realm для входа.

login_with_email_allowed

aliases: loginWithEmailAllowed

boolean

Параметр realm login with email allowed.

Варианты:

  • false
  • true

max_delta_time_seconds

aliases: maxDeltaTimeSeconds

integer

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

max_failure_wait_seconds

aliases: maxFailureWaitSeconds

integer

Максимальное ожидание ошибки realm в секундах.

minimum_quick_login_wait_seconds

aliases: minimumQuickLoginWaitSeconds

integer

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

not_before

aliases: notBefore

integer

realm не раньше.

offline_session_idle_timeout

aliases: offlineSessionIdleTimeout

integer

Срок ожидания сеанса realm в режиме офлайн.
END_OF_DOCUMENT_MARKER

offline_session_max_lifespan

aliases: offlineSessionMaxLifespan

integer

Максимальное время жизни автономной сессии домена.

offline_session_max_lifespan_enabled

aliases: offlineSessionMaxLifespanEnabled

boolean

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

Выбираемые значения:

  • false
  • true

otp_policy_algorithm

aliases: otpPolicyAlgorithm

string

Алгоритм политики OTP домена.

otp_policy_digits

aliases: otpPolicyDigits

integer

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

otp_policy_initial_counter

aliases: otpPolicyInitialCounter

integer

Начальное значение счетчика в политике OTP домена.

otp_policy_look_ahead_window

aliases: otpPolicyLookAheadWindow

integer

Окно предвосхищения в политике OTP домена.

otp_policy_period

aliases: otpPolicyPeriod

integer

Период в политике OTP домена.

otp_policy_type

aliases: otpPolicyType

string

Тип политики OTP домена.

otp_supported_applications

aliases: otpSupportedApplications

list / elements=string

Поддерживаемые приложения OTP домена.

password_policy

aliases: passwordPolicy

string

Политика паролей домена.

permanent_lockout

aliases: permanentLockout

boolean

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

Выбираемые значения:

  • false
  • true

quick_login_check_milli_seconds

aliases: quickLoginCheckMilliSeconds

integer

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

realm

string

Имя домена.

refresh_token_max_reuse

aliases: refreshTokenMaxReuse

integer

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

registration_allowed

aliases: registrationAllowed

boolean

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

Выбираемые значения:

  • false
  • true

registration_email_as_username

aliases: registrationEmailAsUsername

boolean

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

Выбираемые значения:

  • false
  • true

registration_flow

aliases: registrationFlow

string

Процедура регистрации в домене.

remember_me

aliases: rememberMe

boolean

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

Варианты:

  • false
  • true

reset_credentials_flow

aliases: resetCredentialsFlow

string

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

reset_password_allowed

aliases: resetPasswordAllowed

boolean

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

Варианты:

  • false
  • true

revoke_refresh_token

aliases: revokeRefreshToken

boolean

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

Варианты:

  • false
  • true

smtp_server

aliases: smtpServer

dictionary

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

ssl_required

aliases: sslRequired

string

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

Варианты:

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

sso_session_idle_timeout

aliases: ssoSessionIdleTimeout

integer

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

sso_session_idle_timeout_remember_me

aliases: ssoSessionIdleTimeoutRememberMe

integer

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

sso_session_max_lifespan

aliases: ssoSessionMaxLifespan

integer

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

sso_session_max_lifespan_remember_me

aliases: ssoSessionMaxLifespanRememberMe

integer

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

state

string

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

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

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

Варианты:

  • "present" ← (default)
  • "absent"

supported_locales

aliases: supportedLocales

list / elements=string

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

token

string

added in community.general 3.0.0

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

user_managed_access_allowed

aliases: userManagedAccessAllowed

boolean

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

Варианты:

  • false
  • true

validate_certs

boolean

Проверка TLS-сертификатов (не отключайте это в рабочей среде).

Варианты:

  • false
  • true ← (default)

verify_email

aliases: verifyEmail

boolean

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

Варианты:

  • false
  • true

wait_increment_seconds

aliases: waitIncrementSeconds

integer

Приращение ожидания в секундах для домена.

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

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

diff_mode

Поддержка: полная

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

Примеры

- name: Create or update Keycloak realm (minimal example)
  community.general.keycloak_realm:
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    id: realm
    realm: realm
    state: present

- name: Delete a Keycloak realm
  community.general.keycloak_realm:
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    id: test
    state: absent

Возвращаемые значения

Общие значения возврата описаны здесь, следующие являются полями, уникальными для данного модуля:

Ключ

Описание

end_state

словарь

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

Возвращается: при успехе

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

existing

словарь

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

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

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

msg

строка

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

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

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

proposed

словарь

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

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

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

Авторы

  • Christophe Gilles (@kris2kris)

Ссылки на сборку

  • Система отслеживания задач
  • Репозиторий (источники)
  • Задайте вопрос
  • Отправить отчет об ошибке
  • Запросить новую функцию
  • Общение

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/keycloak_realm_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API