fmgd_system_saml – Global settings for SAML authentication.

Added in version 1.0.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.2.6 -> v7.2.12, v7.4.3 -> 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
  • 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
  • system_saml - Global settings for SAML authentication. type: dict
    • artifact_resolution_url (Alias name: artifact-resolution-url) Sp artifact resolution url. type: str more...
    • binding_protocol (Alias name: binding-protocol) Idp binding protocol. type: str choices: [post, redirect] more...
    • cert Certificate to sign saml messages. type: list more...
    • default_login_page (Alias name: default-login-page) Choose default login page. type: str choices: [normal, sso] more...
    • default_profile (Alias name: default-profile) Default profile for new sso admin. type: list more...
    • entity_id (Alias name: entity-id) Sp entity id. type: str more...
    • idp_artifact_resolution_url (Alias name: idp-artifact-resolution-url) Idp artifact resolution url. 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...
    • life Length of the range of time when the assertion is valid (in minutes). type: int more...
    • portal_url (Alias name: portal-url) Portal url. type: str more...
    • role Saml role. type: str choices: [IDP, SP, identity-provider, service-provider] more...
    • server_address (Alias name: server-address) Server address. type: str more...
    • service_providers (Alias name: service-providers) Service providers. type: list more...
      • assertion_attributes (Alias name: assertion-attributes) Assertion attributes. type: list more...
        • name Name. type: str more...
        • type Type. type: str choices: [username, email, privilege, profile-name] more...
      • idp_artifact_resolution_url (Alias name: idp-artifact-resolution-url) Idp artifact resolution url. type: str 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...
      • name Name. type: str more...
      • prefix Prefix. type: str more...
      • sp_artifact_resolution_url (Alias name: sp-artifact-resolution-url) Sp artifact resolution url. type: str more...
      • sp_binding_protocol (Alias name: sp-binding-protocol) Sp binding protocol. type: str choices: [post, redirect] more...
      • sp_cert (Alias name: sp-cert) Sp certificate name. type: list more...
      • sp_entity_id (Alias name: sp-entity-id) Sp entity id. type: str more...
      • sp_portal_url (Alias name: sp-portal-url) Sp portal url. type: str more...
      • sp_single_logout_url (Alias name: sp-single-logout-url) Sp single logout url. type: str more...
      • sp_single_sign_on_url (Alias name: sp-single-sign-on-url) Sp single sign-on url. type: str more...
    • single_logout_url (Alias name: single-logout-url) Single logout url. type: str more...
    • single_sign_on_url (Alias name: single-sign-on-url) Single sign on url. type: str more...
    • status Enable/disable saml authentication (default = disable). type: str choices: [disable, enable] more...
    • tolerance Tolerance to the range of time when the assertion is valid (in minutes). type: int 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: Global settings for SAML authentication.
      fortinet.fmgdevice.fmgd_system_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>
        system_saml:
          # artifact_resolution_url: <string>
          # binding_protocol: <value in [post, redirect]>
          # cert: <list or string>
          # default_login_page: <value in [normal, sso]>
          # default_profile: <list or string>
          # entity_id: <string>
          # idp_artifact_resolution_url: <string>
          # idp_cert: <list or string>
          # idp_entity_id: <string>
          # idp_single_logout_url: <string>
          # idp_single_sign_on_url: <string>
          # life: <integer>
          # portal_url: <string>
          # role: <value in [IDP, SP, identity-provider, ...]>
          # server_address: <string>
          # service_providers:
          #   - assertion_attributes:
          #       - name: <string>
          #         type: <value in [username, email, privilege, ...]>
          #     idp_artifact_resolution_url: <string>
          #     idp_entity_id: <string>
          #     idp_single_logout_url: <string>
          #     idp_single_sign_on_url: <string>
          #     name: <string>
          #     prefix: <string>
          #     sp_artifact_resolution_url: <string>
          #     sp_binding_protocol: <value in [post, redirect]>
          #     sp_cert: <list or string>
          #     sp_entity_id: <string>
          #     sp_portal_url: <string>
          #     sp_single_logout_url: <string>
          #     sp_single_sign_on_url: <string>
          # single_logout_url: <string>
          # single_sign_on_url: <string>
          # status: <value in [disable, enable]>
          # tolerance: <integer>
          # 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)