модуль community.general.keycloak_realm_localization — управление переопределениями локализации realm Keycloak через API Keycloak

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: community.general.keycloak_realm_localization.

Новое в community.general 12.4.0

Краткое описание
Параметры
Атрибуты
См. также
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет управлять переопределениями сообщений для отдельных локалей realm Keycloak с помощью REST API администратора Keycloak.
Для доступа требуется OpenID Connect; у подключающегося пользователя/клиента должны быть необходимые привилегии.
Названия параметров модуля представляют собой имена из API Keycloak в формате snake_case.

Параметры

Параметр	Комментарии
auth_client_id string	OpenID Connect `client_id` для аутентификации в API. По умолчанию: `"admin-cli"`
auth_client_secret string	Секрет клиента, используемый вместе с `auth_client_id` (если требуется).
auth_keycloak_url псевдонимы: url string / обязательный	URL экземпляра Keycloak.
auth_password псевдонимы: password string	Пароль для аутентификации при доступе к API.
auth_realm string	Имя realm Keycloak для аутентификации при доступе к API.
auth_username псевдонимы: username string	Имя пользователя для аутентификации при доступе к API.
connection_timeout integer добавлен в community.general 4.5.0	Задает время ожидания HTTP-соединений с API Keycloak (в секундах). По умолчанию: `10`
force boolean	Если `false`, этот модуль изменяет только ключи, перечисленные в `overrides`. Все остальные существующие ключи игнорируются. Если `true`, все переопределения локали приводятся в соответствие с конфигурацией этого модуля. Например, все ключи, отсутствующие в `overrides`, удаляются независимо от значения `state`. Варианты: `false` ← (по умолчанию) `true`
http_agent string добавлен в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
locale string / обязательный	Код локали, к которой применяются переопределения (например, `en`, `fi`, `de`).
overrides list / элементы=dictionary	Список переопределений, которые должны быть заданы для локали при `state=present`. Каждый элемент представляет собой отображение с `overrides[].key` записи и ее `overrides[].value`. Игнорируется, если `state=absent`. По умолчанию: `[]`
key string / обязательный	Ключ сообщения, который необходимо переопределить.
value string	Значение переопределения для ключа сообщения. Если не указано, по умолчанию используется пустая строка. По умолчанию: `""`
parent_id string / обязательный	Имя realm, которому принадлежат переопределения локали.
refresh_token string добавлен в community.general 10.3.0	Токен обновления для аутентификации в API Keycloak.
state string	Желаемое состояние переопределений локализации для указанной локали. При `present` набор переопределений локали приводится в соответствие с `overrides`. Если `force` имеет значение `true`, ключи, не указанные в `overrides`, удаляются, а перечисленные ключи создаются или обновляются. Если `force` имеет значение `false`, ключи, не указанные в `overrides`, игнорируются, а перечисленные ключи создаются или обновляются. При `absent` переопределения локали удаляются. Если `force` имеет значение `true`, удаляются все ключи. Если `force` имеет значение `false`, удаляются только ключи, перечисленные в `overrides`. Варианты: `"present"` ← (по умолчанию) `"absent"`
token string добавлен в community.general 3.0.0	Токен аутентификации для API Keycloak.
validate_certs boolean	Проверять сертификаты TLS (не отключайте эту проверку в рабочей среде). Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.keycloak	Используйте `group/community.general.keycloak` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз состояния изменений, не изменяя целевой объект.
diff_mode	Поддержка: полная	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

См. также

community.general.keycloak_realm: Список поддерживаемых локалей можно указать с помощью supported_locales.

Примеры

- name: Replace all overrides for locale "en" (credentials auth)
  community.general.keycloak_realm_localization:
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    parent_id: my-realm
    locale: en
    state: present
    force: true
    overrides:
      - key: greeting
        value: "Hello"
      - key: farewell
        value: "Bye"
  delegate_to: localhost

- name: Replace listed overrides for locale "en" (credentials auth)
  community.general.keycloak_realm_localization:
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    parent_id: my-realm
    locale: en
    state: present
    force: false
    overrides:
      - key: greeting
        value: "Hello"
      - key: farewell
        value: "Bye"
  delegate_to: localhost

- name: Ensure only one override exists for locale "fi" (token auth)
  community.general.keycloak_realm_localization:
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
    parent_id: my-realm
    locale: fi
    state: present
    force: true
    overrides:
      - key: app.title
        value: "Sovellukseni"
  delegate_to: localhost

- name: Remove all overrides for locale "de"
  community.general.keycloak_realm_localization:
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    parent_id: my-realm
    locale: de
    state: absent
    force: true
  delegate_to: localhost

- name: Remove only the listed overrides for locale "de"
  community.general.keycloak_realm_localization:
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    parent_id: my-realm
    locale: de
    state: absent
    force: false
    overrides:
      - key: app.title
      - key: foo
      - key: bar
  delegate_to: localhost

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

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

Ключ	Описание
end_state dictionary	Итоговое состояние переопределений локализации для локали после выполнения модуля. Содержит `locale` и список `overrides` в виде элементов «ключ/значение». Возвращается: при успешном выполнении
locale string	Код затронутой локали. Возвращается: при успешном выполнении Пример: `"en"`
overrides list / элементы=dictionary	Список переопределений, существующих после выполнения модуля. Возвращается: при успешном выполнении Пример: `[{"key": "greeting", "value": "Hello"}, {"key": "farewell", "value": "Bye"}]`

Авторы

Jakub Danek (@danekja)

Ссылки на коллекцию

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