W3cubDocs

/Ansible

fortinet.fortios.fortios_user_external_identity_provider module – Configure external identity provider in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_user_external_identity_provider.

New in fortinet.fortios 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and external_identity_provider category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.15

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)
  • true

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"
  • "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"
  • "absent"

user_external_identity_provider

dictionary

Configure external identity provider.

group_attr_name

string

Group attribute name in authentication query.

interface

string

Specify outgoing interface to reach server. Source system.interface.name.

interface_select_method

string

Specify how to select outgoing interface to reach server.

Choices:

  • "auto"
  • "sdwan"
  • "specify"

name

string / required

External identity provider name.

port

integer

External identity provider service port number (0 to use default).

server_identity_check

string

Enable/disable server”s identity check against its certificate and subject alternative name(s).

Choices:

  • "disable"
  • "enable"

source_ip

string

Use this IPv4/v6 address to connect to the external identity provider.

timeout

integer

Connection timeout value in seconds .

type

string

External identity provider type.

Choices:

  • "ms-graph"

user_attr_name

string

User attribute name in authentication query.

version

string

External identity API version.

Choices:

  • "v1.0"
  • "beta"

vrf_select

integer

VRF ID used for connection to server.

vdom

string

Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Default: "root"

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
  • The module supports check_mode.

Examples

- name: Configure external identity provider.
  fortinet.fortios.fortios_user_external_identity_provider:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_external_identity_provider:
          group_attr_name: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          name: "default_name_6"
          port: "0"
          server_identity_check: "disable"
          source_ip: "84.230.14.43"
          timeout: "5"
          type: "ms-graph"
          user_attr_name: "<your_own_value>"
          version: "v1.0"
          vrf_select: "0"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_external_identity_provider_module.html