- Collection Index
- Collections in the Fortinet Namespace
- Fortinet.Fortios
- fortinet.fortios.fortios_user_external_identity_provider module – Configure external identity provider in Fortinet’s FortiOS and FortiGate.
-
'; */ // Create a banner if we're not on the official docs site if (location.host == "docs.testing.ansible.com") { document.write('
' + '
This is the testing site for Ansible Documentation. Unless you are reviewing pre-production changes, please visit the official documentation website.
' + '
'); } // Create a banner current_url_path = window.location.pathname; var important = false; var msg = '
'; if (startsWith(current_url_path, "/ansible-core/")) { msg += 'You are reading documentation for Ansible Core, which contains no plugins except for those in ansible.builtin. For documentation of the Ansible package, go to the latest documentation.'; } else if (startsWithOneOf(current_url_path, ["/ansible/latest/", "/ansible/10/"])) { /* temp extra banner to advertise something */ banner += extra_banner; msg += 'This is the latest (stable) Ansible community documentation. For Red Hat Ansible Automation Platform subscriptions, see Life Cycle for version details.'; } else if (startsWith(current_url_path, "/ansible/2.9/")) { msg += 'You are reading the latest Red Hat released version of the Ansible documentation. Community users can use this version, or select latest from the version selector to the left for the most recent community version.'; } else if (startsWith(current_url_path, "/ansible/devel/")) { /* temp extra banner to advertise something */ banner += extra_banner; msg += 'You are reading the devel version of the Ansible documentation - this version is not guaranteed stable. Use the version selection to the left if you want the latest (stable) released version.'; } else { msg += 'You are reading an older version of the Ansible documentation. Use the version selection to the left if you want the latest (stable) released version.'; /* temp extra banner to advertise something - this is for testing*/ banner += extra_banner; } msg += '
'; banner += '
'; banner += important ? '
' : ''; banner += msg; banner += important ? '
' : ''; banner += '
'; document.write(banner);
Note
This module is part of the fortinet.fortios collection (version 2.3.6).
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:
|
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:
|
state string / required | Indicates whether to create or remove the object. Choices:
|
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:
|
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:
|
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:
|
user_attr_name string | User attribute name in authentication query. |
version string | External identity API version. Choices:
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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"
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: |
http_method string | Last method used to provision the content into FortiGate Returned: always Sample: |
http_status string | Last result given by FortiGate on last operation applied Returned: always Sample: |
mkey string | Master key (id) used in the last call to FortiGate Returned: success Sample: |
name string | Name of the table used to fulfill the request Returned: always Sample: |
path string | Path of the table used to fulfill the request Returned: always Sample: |
revision string | Internal revision number Returned: always Sample: |
serial string | Serial number of the unit Returned: always Sample: |
status string | Indication of the operation’s result Returned: always Sample: |
vdom string | Virtual domain used Returned: always Sample: |
version string | Version of the FortiGate Returned: always Sample: |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)
