community.general.keycloak_clienttemplate – Позволяет администрировать шаблоны клиентов Keycloak через API Keycloak

• Обзор
• Параметры
• Примечания
• Примеры
• Значения возврата

Обзор

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

Параметры

Примечания

Примеры

- name: Create or update Keycloak client template (minimal)
  local_action:
    module: keycloak_clienttemplate
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    realm: master
    name: this_is_a_test

- name: Delete Keycloak client template
  local_action:
    module: keycloak_clienttemplate
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    realm: master
    state: absent
    name: test01

- name: Create or update Keycloak client template (with a protocol mapper)
  local_action:
    module: keycloak_clienttemplate
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    realm: master
    name: this_is_a_test
    protocol_mappers:
      - config:
          access.token.claim: True
          claim.name: "family_name"
          id.token.claim: True
          jsonType.label: String
          user.attribute: lastName
          userinfo.token.claim: True
        consentRequired: True
        consentText: "${familyName}"
        name: family name
        protocol: openid-connect
        protocolMapper: oidc-usermodel-property-mapper
    full_scope_allowed: false
    id: bce6f5e9-d7d3-4955-817e-c5b7f8d65b3f

Значения возврата

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

Авторы

• Eike Frost (@eikef)