Модуль sensu.sensu_go.oidc_auth_provider – Управление провайдером аутентификации Sensu OIDC

Примечание

Этот модуль входит в коллекцию sensu.sensu_go (версия 1.14.0).

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

Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

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

Новинка в sensu.sensu_go 1.10.0

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

Описание

Создание, обновление или удаление провайдера аутентификации Sensu Go OIDC.
Дополнительную информацию см. в документации Sensu Go по адресу https://docs.sensu.io/sensu-go/latest/operations/control-access/oidc-auth/.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.7

Параметры

Параметр	Комментарии
additional_scopes список / элементы=строка	Свойства, которые необходимо включить в утверждения. По умолчанию: `["openid"]`
auth словарь	Параметры аутентификации. Каждый из них можно также определить в переменных окружения.
api_key строка добавлен в sensu.sensu_go 1.3.0	Ключ API, который должен использоваться при аутентификации. Если он не задан, будет проверен параметр переменной окружения SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
ca_path путь добавлен в sensu.sensu_go 1.5.0	Путь к пакету CA, который должен использоваться для проверки сертификата бэкенда. Если этот параметр не задан, модуль будет использовать пакет CA, используемый python. Также можно задать этот параметр через переменную окружения SENSU_CA_PATH.
password строка	Пароль пользователя Sensu. Если этот параметр не задан, будет проверена переменная окружения SENSU_PASSWORD. Этот параметр игнорируется, если установлен параметр auth.api_key. По умолчанию: `"P@ssw0rd!"`
url строка	Расположение API бэкенда Sensu. Если этот параметр не задан, будет проверена переменная окружения SENSU_URL. По умолчанию: `"http://localhost:8080"`
user строка	Имя пользователя для подключения к API Sensu. Если этот параметр не задан, будет проверена переменная окружения SENSU_USER. Этот параметр игнорируется, если установлен параметр auth.api_key. По умолчанию: `"admin"`
verify логическое добавлен в sensu.sensu_go 1.5.0	Флаг, контролирующий проверку сертификатов. При использовании самозаверяющих сертификатов можно установить этот параметр в `false`. ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! При использовании самозаверяющих сертификатов в рабочей среде, см. параметр auth.ca_path. Также можно задать этот параметр через переменную окружения SENSU_VERIFY. Варианты: `false` `true` ← (по умолчанию)
client_id строка	Идентификатор приложения-клиента поставщика OIDC. Требуется, если state равен `present`
client_secret строка	Секретный ключ приложения-клиента поставщика OIDC. Требуется, если state равен `present`
disable_offline_access логическое	Если `true`, поставщик OIDC не может включить область offline_access в запросе на аутентификацию. В противном случае, `false` Варианты: `false` ← (по умолчанию) `true`
groups_claim строка	Требуемое утверждение для формирования связанных групп RBAC.
groups_prefix строка	Префикс, добавляемый ко всем группам OIDC.
name строка / обязательно	Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где это применимо) однозначно идентифицирует ресурс, над которым Ansible выполняет операцию. Если ресурс с выбранным именем уже существует, Ansible-модуль обновит его, чтобы соответствовать спецификации в задаче. Подробную информацию о допустимых именах и других ограничениях см. в спецификации атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/.
redirect_uri строка	URL перенаправления, который необходимо предоставить поставщику OIDC.
server строка	Расположение сервера OIDC, с которым необходимо выполнить аутентификацию. Требуется, если state равен `present`
state строка	Целевое состояние объекта Sensu. Варианты: `"present"` ← (по умолчанию) `"absent"`
username_claim строка	Утверждение, используемое для формирования конечного имени пользователя RBAC. Требуется, если state равен `present`
username_prefix строка	Префикс, добавляемый ко всем именам пользователей OIDC.

END_OF_DOCUMENT_MARKER

Примечания

Примечание

Поддерживается только в версиях Sensu Go >= 6.

См. также

sensu.sensu_go.auth_provider_info: Список поставщиков аутентификации Sensu.
sensu.sensu_go.ldap_auth_provider: Управление поставщиком аутентификации Sensu LDAP.
sensu.sensu_go.ad_auth_provider: Управление поставщиком аутентификации Sensu AD.

Примеры

- name: Create a OIDC auth provider
  sensu.sensu_go.oidc_auth_provider:
    state: present
    name: oidc_name
    additional_scopes:
        - groups
        - email
    client_id: a8e43af034e7f2608780
    client_secret: b63968394be6ed2edb61c93847ee792f31bf6216
    disable_offline_access: false
    redirect_uri: http://127.0.0.1:8080/api/enterprise/authentication/v2/oidc/callback
    server: https://oidc.example.com:9031
    groups_claim: groups
    groups_prefix: 'oidc:'
    username_claim: email
    username_prefix: 'oidc:'

- name: Delete a OIDC auth provider
  sensu.sensu_go.oidc_auth_provider:
    name: oidc_name
    state: absent

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

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

Ключ	Описание
object словарь	Объект, представляющий поставщика аутентификации Sensu OIDC. Возвращается: success Пример: `{"additional_scopes": ["groups", "email"], "client_id": "a8e43af034e7f2608780", "disable_offline_access": false, "groups_claim": "groups", "groups_prefix": "oidc:", "metadata": {"created_by": "admin", "name": "oidc_name"}, "redirect_uri": "http://sensu-backend.example.com:8080/api/enterprise/authentication/v2/oidc/callback", "server": "https://oidc.example.com:9031", "username_claim": "email", "username_prefix": "oidc:"}`

Ключ

Описание

object

словарь

Объект, представляющий поставщика аутентификации Sensu OIDC.

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

Пример: {"additional_scopes": ["groups", "email"], "client_id": "a8e43af034e7f2608780", "disable_offline_access": false, "groups_claim": "groups", "groups_prefix": "oidc:", "metadata": {"created_by": "admin", "name": "oidc_name"}, "redirect_uri": "http://sensu-backend.example.com:8080/api/enterprise/authentication/v2/oidc/callback", "server": "https://oidc.example.com:9031", "username_claim": "email", "username_prefix": "oidc:"}

Авторы

Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Miha Dolinar (@mdolin)
Tadej Borovsak (@tadeboro)

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

© 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/sensu/sensu_go/oidc_auth_provider_module.html