fortios_user_oidc – OpenID Connect server entry configuration in Fortinet’s FortiOS and FortiGate.
Added 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 oidc 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.16
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v8.0.0
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_oidc - OpenID Connect server entry configuration. type: dict more...
- authorization_url - OpenID Connect server authorization URL. type: str more...
- client_id - OpenID Connect server client ID. type: str more...
- client_secret - OpenID Connect server client secret. type: str more...
- clock_tolerance - Clock skew tolerance in seconds (0 - 300). type: int more...
- discovery_url - OpenID Connect server discovery URL. type: str more...
- domain_hint - Domain Hint. type: str more...
- issuer - OpenID Connect server issuer. type: str more...
- jwks_uri - URL of the OP"s JWK Set document. type: str more...
- ldap_server - LDAP server name(s). type: list member_path: ldap_server:name more...
- name - LDAP server name. Source user.ldap.name. type: str required: true more...
- name - OpenID Connect server entry name. type: str required: true more...
- token_url - OpenID Connect server token URL. type: str more...
- type - Type of OpenID Connect config. type: str choices: discovery, manual more...
- user_attr_name - Which field in ID token is username. type: str choices: email, sub, preferred_username more...
- user_regex - username must match this regex (case insensitive). type: str more...
- verify_issuer - Verify issuer in ID token . type: str choices: enable, disable more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: OpenID Connect server entry configuration.
fortinet.fortios.fortios_user_oidc:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_oidc:
authorization_url: "<your_own_value>"
client_id: "<your_own_value>"
client_secret: "<your_own_value>"
clock_tolerance: "15"
discovery_url: "<your_own_value>"
domain_hint: "<your_own_value>"
issuer: "<your_own_value>"
jwks_uri: "<your_own_value>"
ldap_server:
-
name: "default_name_12 (source user.ldap.name)"
name: "default_name_13"
token_url: "<your_own_value>"
type: "discovery"
user_attr_name: "email"
user_regex: "<your_own_value>"
verify_issuer: "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:
- 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.