fortinet.fortimanager.fmgr_user_saml 模块 – SAML 服务器条目配置。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_user_saml。

fortinet.fortimanager 2.1.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包括所有需要在使用前调整为数据源的参数和值。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ← (默认) true
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。 选项 "update" "set" "add"
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。 选项 "present" "absent"
user_saml 字典	设置的顶级参数。
adfs_claim 别名：adfs-claim 字符串	启用/禁用断言语句中用户/组属性的 ADFS Claim 选项 "disable" "enable"
auth_url 别名：auth-url 字符串	用于验证身份验证的 URL。
cert 字符串	用于签署 SAML 消息的证书。
clock_tolerance 别名：clock-tolerance 整数	以秒为单位的时钟偏差容限
digest_method 别名：digest-method 字符串	摘要方法算法。 选项 "sha1" "sha256"
dynamic_mapping 列表 / 元素=字典	动态映射。
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
adfs_claim 别名：adfs-claim 字符串	启用/禁用断言语句中用户/组属性的 ADFS Claim 选项 "disable" "enable"
auth_url 别名：auth-url 字符串	用于验证身份验证的 URL。
cert 字符串	用于签署 SAML 消息的证书。
clock_tolerance 别名：clock-tolerance 整数	以秒为单位的时钟偏差容限
digest_method 别名：digest-method 字符串	摘要方法算法 选项 "sha1" "sha256"
entity_id 别名：entity-id 字符串	SP 实体 ID。
group_claim_type 别名：group-claim-type 字符串	断言语句中的组声明。 选项 "email" "given-name" "name" "upn" "common-name" "email-adfs-1x" "group" "upn-adfs-1x" "role" "sur-name" "ppid" "name-identifier" "authentication-method" "deny-only-group-sid" "deny-only-primary-sid" "deny-only-primary-group-sid" "group-sid" "primary-group-sid" "primary-sid" "windows-account-name"
group_name 别名：group-name 字符串	断言语句中的组名。
idp_cert 别名：idp-cert 字符串	IDP 证书名称。
idp_entity_id 别名：idp-entity-id 字符串	IDP 实体 ID。
idp_single_logout_url 别名：idp-single-logout-url 字符串	IDP 单点注销 URL。
idp_single_sign_on_url 别名：idp-single-sign-on-url 字符串	IDP 单点登录 URL。
limit_relaystate 别名：limit-relaystate 字符串	启用/禁用限制 relay-state 参数（当其超过 SAML 2 规范时）。 选项 "disable" "enable"
reauth 字符串	启用/禁用向 IDP 发出信号以强制用户重新身份验证。 选项 "disable" "enable"
scim_client 别名：scim-client 任意	(列表) SCIM 客户端名称。
single_logout_url 别名：single-logout-url 字符串	SP 单点注销 URL。
single_sign_on_url 别名：single-sign-on-url 字符串	SP 单点登录 URL。
user_claim_type 别名：user-claim-type 字符串	断言语句中的用户名声明。 选项 "email" "given-name" "name" "upn" "common-name" "email-adfs-1x" "group" "upn-adfs-1x" "role" "sur-name" "ppid" "name-identifier" "authentication-method" "deny-only-group-sid" "deny-only-primary-sid" "deny-only-primary-group-sid" "group-sid" "primary-group-sid" "primary-sid" "windows-account-name"
user_name 别名：user-name 字符串	断言语句中的用户名。
entity_id 别名：entity-id 字符串	SP 实体 ID。
group_claim_type 别名：group-claim-type 字符串	断言语句中的组声明。 选项 "email" "given-name" "name" "upn" "common-name" "email-adfs-1x" "group" "upn-adfs-1x" "role" "sur-name" "ppid" "name-identifier" "authentication-method" "deny-only-group-sid" "deny-only-primary-sid" "deny-only-primary-group-sid" "group-sid" "primary-group-sid" "primary-sid" "windows-account-name"
group_name 别名：group-name 字符串	断言语句中的组名。
idp_cert 别名：idp-cert 字符串	IDP 证书名称。
idp_entity_id 别名：idp-entity-id 字符串	IDP 实体 ID。
idp_single_logout_url 别名：idp-single-logout-url 字符串	IDP 单点注销 URL。
idp_single_sign_on_url 别名：idp-single-sign-on-url 字符串	IDP 单点登录 URL。
limit_relaystate 别名：limit-relaystate 字符串	启用/禁用限制 relay-state 参数（当其超过 SAML 2 规范时）。 选项 "disable" "enable"
name 字符串 / 必需	SAML 服务器条目名称。
reauth 字符串	启用/禁用向 IDP 发出信号以强制用户重新身份验证。 选项 "disable" "enable"
scim_client 别名：scim-client 任意	(列表) SCIM 客户端名称。
single_logout_url 别名：single-logout-url 字符串	SP 单点注销 URL。
single_sign_on_url 别名：single-sign-on-url 字符串	SP 单点登录 URL。
user_claim_type 别名：user-claim-type 字符串	断言语句中的用户名声明。 选项 "email" "given-name" "name" "upn" "common-name" "email-adfs-1x" "group" "upn-adfs-1x" "role" "sur-name" "ppid" "name-identifier" "authentication-method" "deny-only-group-sid" "deny-only-primary-sid" "deny-only-primary-group-sid" "group-sid" "primary-group-sid" "primary-sid" "windows-account-name"
user_name 别名：user-name 字符串	断言语句中的用户名。
workspace_locking_adom 字符串	在工作区模式下运行 FortiManager 时要锁定的 ADOM，值可以是 global 和其他包括 root。
workspace_locking_timeout 整数	等待其他用户释放工作区锁的最大时间（秒）。 默认值： 300

注释

注意

• 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将参数（例如“var-name”）更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

• 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。

• 要创建或更新对象，请使用 state present 指令。

• 要删除对象，请使用 state absent 指令。

• 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SAML server entry configuration.
      fortinet.fortimanager.fmgr_user_saml:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_saml:
          cert: <string>
          entity_id: <string>
          group_name: <string>
          idp_cert: <string>
          idp_entity_id: <string>
          idp_single_logout_url: <string>
          idp_single_sign_on_url: <string>
          name: <string>
          single_logout_url: <string>
          single_sign_on_url: <string>
          user_name: <string>
          adfs_claim: <value in [disable, enable]>
          digest_method: <value in [sha1, sha256]>
          group_claim_type: <value in [email, given-name, name, ...]>
          limit_relaystate: <value in [disable, enable]>
          user_claim_type: <value in [email, given-name, name, ...]>
          clock_tolerance: <integer>
          dynamic_mapping:
            -
              _scope:
                -
                  name: <string>
                  vdom: <string>
              adfs_claim: <value in [disable, enable]>
              cert: <string>
              clock_tolerance: <integer>
              digest_method: <value in [sha1, sha256]>
              entity_id: <string>
              group_claim_type: <value in [email, given-name, name, ...]>
              group_name: <string>
              idp_cert: <string>
              idp_entity_id: <string>
              idp_single_logout_url: <string>
              idp_single_sign_on_url: <string>
              limit_relaystate: <value in [disable, enable]>
              single_logout_url: <string>
              single_sign_on_url: <string>
              user_claim_type: <value in [email, given-name, name, ...]>
              user_name: <string>
              auth_url: <string>
              reauth: <value in [disable, enable]>
              scim_client: <list or string>
          auth_url: <string>
          reauth: <value in [disable, enable]>
          scim_client: <list or string>

返回值

常见的返回值已在此处 记录，以下是此模块独有的字段

键	描述
meta 字典	请求的结果。 返回：始终
request_url 字符串	请求的完整 URL。 返回：始终 示例： "/sys/login/user"
response_code 整数	API 请求的状态。 返回：始终 示例： 0
response_data 列表 / 元素=字符串	API 响应。 返回：始终
response_message 字符串	API 响应的描述性消息。 返回：始终 示例： "OK."
system_information 字典	目标系统的信息。 返回：始终
rc 整数	请求的状态。 返回：始终 示例： 0
version_check_warning 列表 / 元素=字符串	如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回：复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李兴 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑林 (@chillancezen)

• 沈方 (@fshen01)

• 卢洪斌 (@fgtdev-hblu)

资源链接

• 问题跟踪器
• 主页
• 代码仓库