fortios_system_saml – Global settings for SAML authentication in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
Synopsis
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.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.2.0 -> 7.4.3
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
- system_saml - Global settings for SAML authentication. type: dict more...
- artifact_resolution_url - SP artifact resolution URL. type: str more...
- binding_protocol - IdP Binding protocol. type: str choices: post, redirect more...
- cert - Certificate to sign SAML messages. Source certificate.local.name. type: str more...
- default_login_page - Choose default login page. type: str choices: normal, sso more...
- default_profile - Default profile for new SSO admin. Source system.accprofile.name. type: str more...
- entity_id - SP entity ID. type: str more...
- idp_artifact_resolution_url - IDP artifact resolution URL. type: str more...
- idp_cert - IDP certificate name. Source certificate.remote.name. type: str more...
- idp_entity_id - IDP entity ID. type: str more...
- idp_single_logout_url - IDP single logout URL. type: str more...
- idp_single_sign_on_url - IDP single sign-on URL. type: str more...
- life - Length of the range of time when the assertion is valid (in minutes). type: int more...
- portal_url - SP portal URL. type: str more...
- role - SAML role. type: str choices: identity-provider, service-provider more...
- server_address - Server address. type: str more...
- service_providers - Authorized service providers. type: list member_path: service_providers:name more...
- assertion_attributes - Customized SAML attributes to send along with assertion. type: list member_path: service_providers:name/assertion_attributes:name more...
- name - Name. type: str required: true more...
- type - Type. type: str choices: username, email, profile-name more...
- idp_artifact_resolution_url - IDP artifact resolution URL. type: str more...
- idp_entity_id - IDP entity ID. type: str more...
- idp_single_logout_url - IDP single logout URL. type: str more...
- idp_single_sign_on_url - IDP single sign-on URL. type: str more...
- name - Name. type: str required: true more...
- prefix - Prefix. type: str more...
- sp_artifact_resolution_url - SP artifact resolution URL. type: str more...
- sp_binding_protocol - SP binding protocol. type: str choices: post, redirect more...
- sp_cert - SP certificate name. Source certificate.remote.name. type: str more...
- sp_entity_id - SP entity ID. type: str more...
- sp_portal_url - SP portal URL. type: str more...
- sp_single_logout_url - SP single logout URL. type: str more...
- sp_single_sign_on_url - SP single sign-on URL. type: str more...
- single_logout_url - SP single logout URL. type: str more...
- single_sign_on_url - SP single sign-on URL. type: str more...
- status - Enable/disable SAML authentication . type: str choices: enable, disable more...
- tolerance - Tolerance to the range of time when the assertion is valid (in minutes). type: int more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Global settings for SAML authentication.
fortinet.fortios.fortios_system_saml:
vdom: "{{ vdom }}"
system_saml:
artifact_resolution_url: "<your_own_value>"
binding_protocol: "post"
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_artifact_resolution_url: "<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: "30"
portal_url: "<your_own_value>"
role: "identity-provider"
server_address: "<your_own_value>"
service_providers:
-
assertion_attributes:
-
name: "default_name_20"
type: "username"
idp_artifact_resolution_url: "<your_own_value>"
idp_entity_id: "<your_own_value>"
idp_single_logout_url: "<your_own_value>"
idp_single_sign_on_url: "<your_own_value>"
name: "default_name_26"
prefix: "<your_own_value>"
sp_artifact_resolution_url: "<your_own_value>"
sp_binding_protocol: "post"
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: "5"
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.