fmgr_user_saml_dynamicmapping – SAML server entry configuration.

New in version 2.2.0.

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.
  • Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
False
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11
False False False False False False False False False False False
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12
False False False False False False False False False False False False False
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8
False False False False False True True True True
7.2.0 7.2.1 7.2.2 7.2.3
False True True True
7.4.0
True

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • saml - The parameter in requested url type: str required: true
  • user_saml_dynamicmapping - SAML server entry configuration. type: dict
    • _scope - No description for the parameter type: array more...
      • name - No description for the parameter type: str more...
      • vdom - No description for the parameter type: str more...
    • adfs-claim - Enable/disable ADFS Claim for user/group attribute in assertion statement (default = disable). type: str choices: [disable, enable] more...
    • cert - Certificate to sign SAML messages. type: str more...
    • clock-tolerance - Clock skew tolerance in seconds (0 - 300, default = 15, 0 = no tolerance). type: int more...
    • digest-method - Digest method algorithm (default = sha1). type: str choices: [sha1, sha256] more...
    • entity-id - SP entity ID. type: str 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...
    • 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...
    • limit-relaystate - Enable/disable limiting of relay-state parameter when it exceeds SAML 2. type: str choices: [disable, enable] more...
    • single-logout-url - SP single logout URL. type: str more...
    • single-sign-on-url - SP single sign-on URL. type: str 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...
    • user-name - User name in assertion statement. type: str more...
    • auth-url - URL to verify authentication. type: str 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: 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>

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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.