fmgd_user_saml – SAML server entry configuration.

Added in version 1.1.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 v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

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
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • user_saml - SAML server entry configuration. type: dict
    • adfs_claim (Alias name: 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: list more...
    • clock_tolerance (Alias name: clock-tolerance) Clock skew tolerance in seconds (0 - 300, default = 15, 0 = no tolerance). type: int more...
    • digest_method (Alias name: digest-method) Digest method algorithm (default = sha1). type: str choices: [sha1, sha256] more...
    • dynamic_mapping Dynamic mapping. type: list more...
      • _scope Scope. type: list more...
        • name Name. type: str more...
        • vdom Vdom. type: str more...
      • adfs_claim (Alias name: 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: list more...
      • clock_tolerance (Alias name: clock-tolerance) Clock skew tolerance in seconds (0 - 300, default = 15, 0 = no tolerance). type: int more...
      • digest_method (Alias name: digest-method) Digest method algorithm (default = sha1). type: str choices: [sha1, sha256] more...
      • entity_id (Alias name: entity-id) Sp entity id. type: str more...
      • group_claim_type (Alias name: 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 (Alias name: group-name) Group name in assertion statement. type: str more...
      • idp_cert (Alias name: idp-cert) Idp certificate name. type: list more...
      • idp_entity_id (Alias name: idp-entity-id) Idp entity id. type: str more...
      • idp_single_logout_url (Alias name: idp-single-logout-url) Idp single logout url. type: str more...
      • idp_single_sign_on_url (Alias name: idp-single-sign-on-url) Idp single sign-on url. type: str more...
      • limit_relaystate (Alias name: limit-relaystate) Enable/disable limiting of relay-state parameter when it exceeds saml 2. type: str choices: [disable, enable] more...
      • reauth Enable/disable signalling of idp to force user re-authentication (default = disable). type: str choices: [disable, enable] more...
      • single_logout_url (Alias name: single-logout-url) Sp single logout url. type: str more...
      • single_sign_on_url (Alias name: single-sign-on-url) Sp single sign-on url. type: str more...
      • user_claim_type (Alias name: 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 (Alias name: user-name) User name in assertion statement. type: str more...
      • auth_url (Alias name: auth-url) Url to verify authentication. type: str more...
      • scim_client (Alias name: scim-client) Scim client name. type: list more...
      • scim_group_attr_type (Alias name: scim-group-attr-type) Group attribute type used to match scim groups (default = display-name). type: str choices: [display-name, external-id] more...
      • scim_user_attr_type (Alias name: scim-user-attr-type) User attribute type used to match scim users (default = user-name). type: str choices: [display-name, external-id, user-name, email] more...
      • require_signed_resp_and_asrt (Alias name: require-signed-resp-and-asrt) Require both response and assertion from idp to be signed when fgt acts as sp (default = disable). type: str choices: [disable, enable] more...
    • entity_id (Alias name: entity-id) Sp entity id. type: str more...
    • group_claim_type (Alias name: 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 (Alias name: group-name) Group name in assertion statement. type: str more...
    • idp_cert (Alias name: idp-cert) Idp certificate name. type: list more...
    • idp_entity_id (Alias name: idp-entity-id) Idp entity id. type: str more...
    • idp_single_logout_url (Alias name: idp-single-logout-url) Idp single logout url. type: str more...
    • idp_single_sign_on_url (Alias name: idp-single-sign-on-url) Idp single sign-on url. type: str more...
    • limit_relaystate (Alias name: limit-relaystate) Enable/disable limiting of relay-state parameter when it exceeds saml 2. type: str choices: [disable, enable] more...
    • name Saml server entry name. type: str more...
    • single_logout_url (Alias name: single-logout-url) Sp single logout url. type: str more...
    • single_sign_on_url (Alias name: single-sign-on-url) Sp single sign-on url. type: str more...
    • user_claim_type (Alias name: 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 (Alias name: user-name) User name in assertion statement. type: str more...
    • reauth Enable/disable signalling of idp to force user re-authentication (default = disable). type: str choices: [disable, enable] more...
    • auth_url (Alias name: auth-url) Url to verify authentication. type: str more...
    • scim_user_attr_type (Alias name: scim-user-attr-type) User attribute type used to match scim users (default = user-name). type: str choices: [display-name, external-id, user-name, email] more...
    • scim_group_attr_type (Alias name: scim-group-attr-type) Group attribute type used to match scim groups (default = display-name). type: str choices: [display-name, external-id] more...
    • scim_client (Alias name: scim-client) Scim client name. type: list more...
    • require_signed_resp_and_asrt (Alias name: require-signed-resp-and-asrt) Require both response and assertion from idp to be signed when fgt acts as sp (default = disable). type: str choices: [disable, enable] 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SAML server entry configuration.
      fortinet.fmgdevice.fmgd_user_saml:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        user_saml:
          name: "your value" # Required variable, string
          # adfs_claim: <value in [disable, enable]>
          # cert: <list or string>
          # clock_tolerance: <integer>
          # digest_method: <value in [sha1, sha256]>
          # dynamic_mapping:
          #   - _scope:
          #       - name: <string>
          #         vdom: <string>
          #     adfs_claim: <value in [disable, enable]>
          #     cert: <list or string>
          #     clock_tolerance: <integer>
          #     digest_method: <value in [sha1, sha256]>
          #     entity_id: <string>
          #     group_claim_type: <value in [email, given-name, name, ...]>
          #     group_name: <string>
          #     idp_cert: <list or string>
          #     idp_entity_id: <string>
          #     idp_single_logout_url: <string>
          #     idp_single_sign_on_url: <string>
          #     limit_relaystate: <value in [disable, enable]>
          #     reauth: <value in [disable, enable]>
          #     single_logout_url: <string>
          #     single_sign_on_url: <string>
          #     user_claim_type: <value in [email, given-name, name, ...]>
          #     user_name: <string>
          #     auth_url: <string>
          #     scim_client: <list or string>
          #     scim_group_attr_type: <value in [display-name, external-id]>
          #     scim_user_attr_type: <value in [display-name, external-id, user-name, ...]>
          #     require_signed_resp_and_asrt: <value in [disable, enable]>
          # entity_id: <string>
          # group_claim_type: <value in [email, given-name, name, ...]>
          # group_name: <string>
          # idp_cert: <list or string>
          # idp_entity_id: <string>
          # idp_single_logout_url: <string>
          # idp_single_sign_on_url: <string>
          # limit_relaystate: <value in [disable, enable]>
          # single_logout_url: <string>
          # single_sign_on_url: <string>
          # user_claim_type: <value in [email, given-name, name, ...]>
          # user_name: <string>
          # reauth: <value in [disable, enable]>
          # auth_url: <string>
          # scim_user_attr_type: <value in [display-name, external-id, user-name, ...]>
          # scim_group_attr_type: <value in [display-name, external-id]>
          # scim_client: <list or string>
          # require_signed_resp_and_asrt: <value in [disable, enable]>

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 sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

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)