fortinet.fortimanager.fmgr_user_saml – SAML server entry configuration.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

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 version 2.10: of fortinet.fortimanager

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		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean		Choices: no ← yes	Enable/Disable logging for task
proposed_method string		Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		Choices: present absent	the directive to create, update or delete an object
user_saml dictionary			the top level parameters set
	adfs-claim string	Choices: disable enable	Enable/disable ADFS Claim for user/group attribute in assertion statement (default = disable).
	cert string		Certificate to sign SAML messages.
	digest-method string	Choices: sha1 sha256	Digest Method Algorithm. (default = sha1).
	entity-id string		SP entity ID.
	group-claim-type string	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 claim in assertion statement.
	group-name string		Group name in assertion statement.
	idp-cert string		IDP Certificate name.
	idp-entity-id string		IDP entity ID.
	idp-single-logout-url string		IDP single logout url.
	idp-single-sign-on-url string		IDP single sign-on URL.
	limit-relaystate string	Choices: disable enable	Enable/disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes).
	name string		SAML server entry name.
	single-logout-url string		SP single logout URL.
	single-sign-on-url string		SP single sign-on URL.
	user-claim-type string	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 claim in assertion statement.
	user-name string		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		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: SAML server entry configuration.
     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: <value in [present, absent]>
        user_saml:
           cert: <value of string>
           entity-id: <value of string>
           group-name: <value of string>
           idp-cert: <value of string>
           idp-entity-id: <value of string>
           idp-single-logout-url: <value of string>
           idp-single-sign-on-url: <value of string>
           name: <value of string>
           single-logout-url: <value of string>
           single-sign-on-url: <value of string>
           user-name: <value of 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, ...]>

Return Values

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

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_user_saml_module.html

Docs

Docs4dev

Title here