fortios_user_external_identity_provider – Configure external identity provider in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v7.4.2 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- user_external_identity_provider - Configure external identity provider. type: dict more...
- group_attr_name - Group attribute name in authentication query. type: str more...
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
- name - External identity provider name. type: str required: true more...
- port - External identity provider service port number (0 to use default). type: int more...
- server_identity_check - Enable/disable server"s identity check against its certificate and subject alternative name(s). type: str choices: disable, enable more...
- source_ip - Use this IPv4/v6 address to connect to the external identity provider. type: str more...
- timeout - Connection timeout value in seconds . type: int more...
- type - External identity provider type. type: str choices: ms-graph more...
- user_attr_name - User attribute name in authentication query. type: str more...
- version - External identity API version. type: str choices: v1.0, beta more...
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.