модуль fortinet.fortimanager.fmgr_user_oidc — Пользовательский OIDC

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_user_oidc.

Добавлено в fortinet.fortimanager 2.12.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
user_oidc dictionary	Набор параметров верхнего уровня.
auth_method псевдонимы: auth-method string	Метод аутентификации. Варианты: `"client_secret_basic"` `"client_secret_post"` `"private_key_jwt"`
auth_type псевдонимы: auth-type string	Тип аутентификации. Варианты: `"client-secret"` `"private-key"`
authorization_url псевдонимы: authorization-url string	URL авторизации.
client_id псевдонимы: client-id string	Идентификатор клиента.
client_secret псевдонимы: client-secret string	Секретный ключ клиента.
clock_tolerance псевдонимы: clock-tolerance integer	Допустимое отклонение времени.
discovery_url псевдонимы: discovery-url string	URL обнаружения.
display_name псевдонимы: display-name string	Отображаемое имя.
domain_hint псевдонимы: domain-hint string	Подсказка домена.
group_attr_name псевдонимы: group-attr-name string	Имя атрибута группы.
icon_url псевдонимы: icon-url string	URL значка.
issuer string	Издатель.
jwks_uri псевдонимы: jwks-uri string	URI JWKS.
ldap_server псевдонимы: ldap-server list / элементы=string	Сервер LDAP.
name string / обязательный	Имя.
private_key псевдонимы: private-key list / элементы=string	Закрытый ключ.
token_url псевдонимы: token-url string	URL токена.
type string	Тип. Варианты: `"discovery"` `"manual"`
user_attr_name псевдонимы: user-attr-name string	Имя атрибута пользователя. Варианты: `"email"` `"sub"` `"preferred_username"`
user_regex псевдонимы: user-regex string	Регулярное выражение для пользователя.
verify_cert псевдонимы: verify-cert string	Проверка сертификата. Варианты: `"disable"` `"enable"`
verify_issuer псевдонимы: verify-issuer string	Проверка издателя. Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области; значение может быть global и другими, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout позволяют управлять этим режимом.
Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: User oidc
      fortinet.fortimanager.fmgr_user_oidc:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_oidc:
          name: "your value" # Required variable, string
          # auth_method: <value in [client_secret_basic, client_secret_post, private_key_jwt]>
          # auth_type: <value in [client-secret, private-key]>
          # authorization_url: <string>
          # client_id: <string>
          # client_secret: <string>
          # clock_tolerance: <integer>
          # discovery_url: <string>
          # display_name: <string>
          # domain_hint: <string>
          # group_attr_name: <string>
          # icon_url: <string>
          # issuer: <string>
          # jwks_uri: <string>
          # ldap_server: <list or string>
          # private_key: <list or string>
          # token_url: <string>
          # type: <value in [discovery, manual]>
          # user_attr_name: <value in [email, sub, preferred_username]>
          # user_regex: <string>
          # verify_cert: <value in [disable, enable]>
          # verify_issuer: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при наличии сложных данных

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortinet/fortimanager/fmgr_user_oidc_module.html