fmgr_user_saml – SAML server entry configuration.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- user_saml - no description type: dict
- cert - Certificate to sign SAML messages. type: str more...
- entity-id - SP entity ID. type: str more...
- group-name - Group name in assertion statement. type: str more...
- idp-cert - IDP Certificate 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...
- name - SAML server entry name. 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...
- user-name - User name in assertion statement. type: str more...
- adfs-claim - Enable/disable ADFS Claim for user/group attribute in assertion statement (default = disable). type: str choices: [disable, enable] more...
- digest-method - Digest Method Algorithm. type: str choices: [sha1, sha256] more...
- group-claim-type - Group claim in assertion statement. type: str 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] more...
- limit-relaystate - Enable/disable limiting of relay-state parameter when it exceeds SAML 2. type: str choices: [disable, enable] more...
- user-claim-type - User name claim in assertion statement. type: str 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] more...
- clock-tolerance - Clock skew tolerance in seconds (0 - 300, default = 15, 0 = no tolerance). type: int more...
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: no description
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, ...]>
clock-tolerance: <value of integer>
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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict