fortinet / fortinet.fortios / 2.3.6 / module / fortios_user_saml SAML server entry configuration in Fortinet's FortiOS and FortiGate. | "added in version" 2.0.0 of fortinet.fortios" Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico) preview | supported by communityfortinet.fortios.fortios_user_saml (2.3.6) — module
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections: - name: fortinet.fortios version: 2.3.6
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
- 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>"
vdom: default: root description: - 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 state: choices: - present - absent description: - Indicates whether to create or remove the object. required: true type: str user_saml: default: null description: - SAML server entry configuration. suboptions: adfs_claim: choices: - enable - disable description: - Enable/disable ADFS Claim for user/group attribute in assertion statement . type: str auth_url: description: - URL to verify authentication. type: str cert: description: - Certificate to sign SAML messages. Source vpn.certificate.local.name. type: str clock_tolerance: description: - Clock skew tolerance in seconds (0 - 300). type: int digest_method: choices: - sha1 - sha256 description: - Digest method algorithm . type: str entity_id: description: - SP entity ID. type: str group_claim_type: 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 description: - Group claim in assertion statement. type: str group_name: description: - Group name in assertion statement. type: str idp_cert: description: - IDP Certificate name. Source vpn.certificate.remote.name. type: str idp_entity_id: description: - IDP entity ID. type: str idp_single_logout_url: description: - IDP single logout url. type: str idp_single_sign_on_url: description: - IDP single sign-on URL. type: str limit_relaystate: choices: - enable - disable description: - Enable/disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes). type: str name: description: - SAML server entry name. required: true type: str reauth: choices: - enable - disable description: - Enable/disable signalling of IDP to force user re-authentication . type: str single_logout_url: description: - SP single logout URL. type: str single_sign_on_url: description: - SP single sign-on URL. type: str user_claim_type: 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 description: - User name claim in assertion statement. type: str user_name: description: - User name in assertion statement. type: str type: dict enable_log: default: false description: - Enable/Disable logging for task. required: false type: bool member_path: description: - Member attribute path to operate on. - Delimited by a slash character if there are more than one attribute. - Parameter marked with member_path is legitimate for doing member operation. type: str access_token: description: - Token-based authentication. Generated from GUI of Fortigate. required: false type: str member_state: choices: - present - absent description: - Add or delete a member under specified attribute path. - When member_state is specified, the state option is ignored. type: str
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str