fortinet.fortimanager.fmgr_user_saml module – SAML server entry configuration.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_saml.

New in fortinet.fortimanager 2.1.0

Synopsis 

This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters 

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: `"present"` `"absent"`
user_saml dictionary	The top level parameters set.
adfs-claim string	Deprecated, please rename it to adfs_claim. Enable/disable ADFS Claim for user/group attribute in assertion statement Choices: `"disable"` `"enable"`
auth-url string	Deprecated, please rename it to auth_url. URL to verify authentication.
cert string	Certificate to sign SAML messages.
clock-tolerance integer	Deprecated, please rename it to clock_tolerance. Clock skew tolerance in seconds
digest-method string	Deprecated, please rename it to digest_method. Digest Method Algorithm. Choices: `"sha1"` `"sha256"`
dynamic_mapping list / elements=dictionary	Dynamic mapping.
_scope list / elements=dictionary	Scope.
name string	Name.
vdom string	Vdom.
adfs-claim string	Deprecated, please rename it to adfs_claim. Enable/disable ADFS Claim for user/group attribute in assertion statement Choices: `"disable"` `"enable"`
auth-url string	Deprecated, please rename it to auth_url. URL to verify authentication.
cert string	Certificate to sign SAML messages.
clock-tolerance integer	Deprecated, please rename it to clock_tolerance. Clock skew tolerance in seconds
digest-method string	Deprecated, please rename it to digest_method. Digest method algorithm Choices: `"sha1"` `"sha256"`
entity-id string	Deprecated, please rename it to entity_id. SP entity ID.
group-claim-type string	Deprecated, please rename it to group_claim_type. Group claim in assertion statement. Choices: `"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 string	Deprecated, please rename it to group_name. Group name in assertion statement.
idp-cert string	Deprecated, please rename it to idp_cert. IDP Certificate name.
idp-entity-id string	Deprecated, please rename it to idp_entity_id. IDP entity ID.
idp-single-logout-url string	Deprecated, please rename it to idp_single_logout_url. IDP single logout url.
idp-single-sign-on-url string	Deprecated, please rename it to idp_single_sign_on_url. IDP single sign-on URL.
limit-relaystate string	Deprecated, please rename it to limit_relaystate. Enable/disable limiting of relay-state parameter when it exceeds… Choices: `"disable"` `"enable"`
reauth string	Enable/disable signalling of IDP to force user re-authentication Choices: `"disable"` `"enable"`
scim-client any	(list) Deprecated, please rename it to scim_client. SCIM client name.
single-logout-url string	Deprecated, please rename it to single_logout_url. SP single logout URL.
single-sign-on-url string	Deprecated, please rename it to single_sign_on_url. SP single sign-on URL.
user-claim-type string	Deprecated, please rename it to user_claim_type. User name claim in assertion statement. Choices: `"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 string	Deprecated, please rename it to user_name. User name in assertion statement.
entity-id string	Deprecated, please rename it to entity_id. SP entity ID.
group-claim-type string	Deprecated, please rename it to group_claim_type. Group claim in assertion statement. Choices: `"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 string	Deprecated, please rename it to group_name. Group name in assertion statement.
idp-cert string	Deprecated, please rename it to idp_cert. IDP Certificate name.
idp-entity-id string	Deprecated, please rename it to idp_entity_id. IDP entity ID.
idp-single-logout-url string	Deprecated, please rename it to idp_single_logout_url. IDP single logout url.
idp-single-sign-on-url string	Deprecated, please rename it to idp_single_sign_on_url. IDP single sign-on URL.
limit-relaystate string	Deprecated, please rename it to limit_relaystate. Enable/disable limiting of relay-state parameter when it exceeds SAML 2. Choices: `"disable"` `"enable"`
name string / required	SAML server entry name.
reauth string	Enable/disable signalling of IDP to force user re-authentication Choices: `"disable"` `"enable"`
scim-client any	(list) Deprecated, please rename it to scim_client. SCIM client name.
single-logout-url string	Deprecated, please rename it to single_logout_url. SP single logout URL.
single-sign-on-url string	Deprecated, please rename it to single_sign_on_url. SP single sign-on URL.
user-claim-type string	Deprecated, please rename it to user_claim_type. User name claim in assertion statement. Choices: `"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 string	Deprecated, please rename it to user_name. User name in assertion statement.
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: `300`

Notes 

Note

Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples 

- 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>

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

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

fortinet.fortimanager.fmgr_user_saml module – SAML server entry configuration.

Synopsis

Parameters

Notes

Examples

Return Values