fortios_user_saml.rst

source:	fortios_user_saml.py
orphan:

fortios_user_saml -- SAML server entry configuration in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and saml category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_user_saml	v6.2.0 -> latest

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• user_saml - SAML server entry configuration. type: dict more...

  	Supported Version Ranges
  user_saml	v6.2.0 -> latest

• adfs_claim - Enable/disable ADFS Claim for user/group attribute in assertion statement . type: str choices: enable, disable more...

  	Supported Version Ranges
  adfs_claim	v7.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• auth_url - URL to verify authentication. type: str more...

  	Supported Version Ranges
  auth_url	v7.2.1 -> latest

• cert - Certificate to sign SAML messages. Source vpn.certificate.local.name. type: str more...

  	Supported Version Ranges
  cert	v6.2.0 -> latest

• clock_tolerance - Clock skew tolerance in seconds (0 - 300). type: int more...

  	Supported Version Ranges
  clock_tolerance	v7.0.4 -> latest

• digest_method - Digest method algorithm . type: str choices: sha1, sha256 more...

  	Supported Version Ranges
  digest_method	v7.0.0 -> latest
  [sha1]	v6.0.0 -> latest
  [sha256]	v6.0.0 -> latest

• entity_id - SP entity ID. type: str more...

  	Supported Version Ranges
  entity_id	v6.2.0 -> latest

• group_claim_type - Group claim in assertion statement. type: str 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 more...

  	Supported Version Ranges
  group_claim_type	v7.0.0 -> latest
  [email]	v6.0.0 -> latest
  [given-name]	v6.0.0 -> latest
  [name]	v6.0.0 -> latest
  [upn]	v6.0.0 -> latest
  [common-name]	v6.0.0 -> latest
  [email-adfs-1x]	v6.0.0 -> latest
  [group]	v6.0.0 -> latest
  [upn-adfs-1x]	v6.0.0 -> latest
  [role]	v6.0.0 -> latest
  [sur-name]	v6.0.0 -> latest
  [ppid]	v6.0.0 -> latest
  [name-identifier]	v6.0.0 -> latest
  [authentication-method]	v6.0.0 -> latest
  [deny-only-group-sid]	v6.0.0 -> latest
  [deny-only-primary-sid]	v6.0.0 -> latest
  [deny-only-primary-group-sid]	v6.0.0 -> latest
  [group-sid]	v6.0.0 -> latest
  [primary-group-sid]	v6.0.0 -> latest
  [primary-sid]	v6.0.0 -> latest
  [windows-account-name]	v6.0.0 -> latest

• group_name - Group name in assertion statement. type: str more...

  	Supported Version Ranges
  group_name	v6.2.0 -> latest

• idp_cert - IDP Certificate name. Source vpn.certificate.remote.name. type: str more...

  	Supported Version Ranges
  idp_cert	v6.2.0 -> latest

• idp_entity_id - IDP entity ID. type: str more...

  	Supported Version Ranges
  idp_entity_id	v6.2.0 -> latest

• idp_single_logout_url - IDP single logout url. type: str more...

  	Supported Version Ranges
  idp_single_logout_url	v6.2.0 -> latest

• idp_single_sign_on_url - IDP single sign-on URL. type: str more...

  	Supported Version Ranges
  idp_single_sign_on_url	v6.2.0 -> latest

• limit_relaystate - Enable/disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes). type: str choices: enable, disable more...

  	Supported Version Ranges
  limit_relaystate	v7.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• name - SAML server entry name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• reauth - Enable/disable signalling of IDP to force user re-authentication . type: str choices: enable, disable more...

  	Supported Version Ranges
  reauth	v7.4.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• single_logout_url - SP single logout URL. type: str more...

  	Supported Version Ranges
  single_logout_url	v6.2.0 -> latest

• single_sign_on_url - SP single sign-on URL. type: str more...

  	Supported Version Ranges
  single_sign_on_url	v6.2.0 -> latest

• user_claim_type - User name claim in assertion statement. type: str 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 more...

  	Supported Version Ranges
  user_claim_type	v7.0.0 -> latest
  [email]	v6.0.0 -> latest
  [given-name]	v6.0.0 -> latest
  [name]	v6.0.0 -> latest
  [upn]	v6.0.0 -> latest
  [common-name]	v6.0.0 -> latest
  [email-adfs-1x]	v6.0.0 -> latest
  [group]	v6.0.0 -> latest
  [upn-adfs-1x]	v6.0.0 -> latest
  [role]	v6.0.0 -> latest
  [sur-name]	v6.0.0 -> latest
  [ppid]	v6.0.0 -> latest
  [name-identifier]	v6.0.0 -> latest
  [authentication-method]	v6.0.0 -> latest
  [deny-only-group-sid]	v6.0.0 -> latest
  [deny-only-primary-sid]	v6.0.0 -> latest
  [deny-only-primary-group-sid]	v6.0.0 -> latest
  [group-sid]	v6.0.0 -> latest
  [primary-group-sid]	v6.0.0 -> latest
  [primary-sid]	v6.0.0 -> latest
  [windows-account-name]	v6.0.0 -> latest

• user_name - User name in assertion statement. type: str more...

  	Supported Version Ranges
  user_name	v6.2.0 -> latest

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: SAML server entry configuration.
  fortinet.fortios.fortios_user_saml:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_saml:
          adfs_claim: "enable"
          auth_url: "<your_own_value>"
          cert: "<your_own_value> (source vpn.certificate.local.name)"
          clock_tolerance: "15"
          digest_method: "sha1"
          entity_id: "<your_own_value>"
          group_claim_type: "email"
          group_name: "<your_own_value>"
          idp_cert: "<your_own_value> (source vpn.certificate.remote.name)"
          idp_entity_id: "<your_own_value>"
          idp_single_logout_url: "<your_own_value>"
          idp_single_sign_on_url: "<your_own_value>"
          limit_relaystate: "enable"
          name: "default_name_16"
          reauth: "enable"
          single_logout_url: "<your_own_value>"
          single_sign_on_url: "<your_own_value>"
          user_claim_type: "email"
          user_name: "<your_own_value>"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

• build - Build number of the fortigate image returned: always type: str sample: 1547
• http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
• http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
• mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
• name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
• path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
• revision - Internal revision number returned: always type: str sample: 17.0.2.10658
• serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
• status - Indication of the operation's result returned: always type: str sample: success
• vdom - Virtual domain used returned: always type: str sample: root
• version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.