drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_user_saml_dynamicmapping SAML server entry configuration. | "added in version" 2.2.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_user_saml_dynamicmapping (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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_dynamicmapping: 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> saml: <your own value> state: <value in [present, absent]> user_saml_dynamicmapping: _scope: - name: <value of string> vdom: <value of string> adfs-claim: <value in [disable, enable]> cert: <value of string> clock-tolerance: <value of integer> digest-method: <value in [sha1, sha256]> entity-id: <value of string> group-claim-type: <value in [email, given-name, name, ...]> 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> limit-relaystate: <value in [disable, enable]> single-logout-url: <value of string> single-sign-on-url: <value of string> user-claim-type: <value in [email, given-name, name, ...]> user-name: <value of string> auth-url: <value of string>
adom: description: the parameter (adom) in requested url required: true type: str saml: description: the parameter (saml) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str user_saml_dynamicmapping: description: the top level parameters set required: false suboptions: _scope: description: description elements: dict suboptions: name: description: no description type: str vdom: description: no description type: str type: list adfs-claim: choices: - disable - enable 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. type: str clock-tolerance: description: Clock skew tolerance in seconds 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. 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: - disable - enable description: Enable/disable limiting of relay-state parameter when it exceeds SAML 2. 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 workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list