fortinet / fortinet.fortios / 1.1.7 / module / fortios_system_saml Global settings for SAML authentication in Fortinet's FortiOS and FortiGate. | "added in version" 2.10 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_system_saml (1.1.7) — module
Install with ansible-galaxy collection install fortinet.fortios:==1.1.7
collections: - name: fortinet.fortios version: 1.1.7
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and saml category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.0
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Global settings for SAML authentication. fortios_system_saml: vdom: "{{ vdom }}" system_saml: cert: "<your_own_value> (source certificate.local.name)" default_login_page: "normal" default_profile: "<your_own_value> (source system.accprofile.name)" entity_id: "<your_own_value>" idp_cert: "<your_own_value> (source certificate.remote.name)" idp_entity_id: "<your_own_value>" idp_single_logout_url: "<your_own_value>" idp_single_sign_on_url: "<your_own_value>" life: "11" portal_url: "<your_own_value>" role: "identity-provider" server_address: "<your_own_value>" service_providers: - assertion_attributes: - name: "default_name_17" type: "username" idp_entity_id: "<your_own_value>" idp_single_logout_url: "<your_own_value>" idp_single_sign_on_url: "<your_own_value>" name: "default_name_22" prefix: "<your_own_value>" sp_cert: "<your_own_value> (source certificate.remote.name)" sp_entity_id: "<your_own_value>" sp_portal_url: "<your_own_value>" sp_single_logout_url: "<your_own_value>" sp_single_sign_on_url: "<your_own_value>" single_logout_url: "<your_own_value>" single_sign_on_url: "<your_own_value>" status: "enable" tolerance: "32"
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 system_saml: default: null description: - Global settings for SAML authentication. suboptions: cert: description: - Certificate to sign SAML messages. Source certificate.local.name. type: str default_login_page: choices: - normal - sso description: - Choose default login page. type: str default_profile: description: - Default profile for new SSO admin. Source system.accprofile.name. type: str entity_id: description: - SP entity ID. type: str idp_cert: description: - IDP certificate name. Source 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 life: description: - Length of the range of time when the assertion is valid (in minutes). type: int portal_url: description: - SP portal URL. type: str role: choices: - identity-provider - service-provider description: - SAML role. type: str server_address: description: - Server address. type: str service_providers: description: - Authorized service providers. suboptions: assertion_attributes: description: - Customized SAML attributes to send along with assertion. suboptions: name: description: - Name. required: true type: str type: choices: - username - email - profile-name description: - Type. type: str type: list 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 name: description: - Name. required: true type: str prefix: description: - Prefix. type: str sp_cert: description: - SP certificate name. Source certificate.remote.name. type: str sp_entity_id: description: - SP entity ID. type: str sp_portal_url: description: - SP portal URL. type: str sp_single_logout_url: description: - SP single logout URL. type: str sp_single_sign_on_url: description: - SP single sign-on URL. type: str type: list single_logout_url: description: - SP single logout URL. type: str single_sign_on_url: description: - SP single sign-on URL. type: str status: choices: - enable - disable description: - Enable/disable SAML authentication . type: str tolerance: description: - Tolerance to the range of time when the assertion is valid (in minutes). type: int type: dict access_token: description: - Token-based authentication. Generated from GUI of Fortigate. required: false 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