auth_swg_saml_server - SWG User SSO Resource
Added in version 1.0.0.
Synopsis
SWG User SSO Resource.
Use API “/resource-api/v2/auth/swg-saml-server”.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.17.0
Parameters
- state The state of the module. "present" means update the resource. This resource can't be deleted, and does not support "absent" state.type: strchoices: ['present', 'absent']default: present
- force_behavior Specify this option to force the method to use to interact with the resource.type: strchoices: ['none', 'read', 'create', 'update', 'delete']default: none
- bypass_validation Bypass validation of the module.type: booldefault: False
- params The parameters of the module.[Required]type: dict
- primary_key [Required]type: str
- enabled type: bool
- idp_entity_id type: str
- idp_sign_on_url type: str
- idp_log_out_url type: str
- username type: str
- group_name type: str
- group_match type: str
- sp_cert type: dict
- primary_key type: str
- datasource type: str
- idp_certificate type: dict
- primary_key type: str
- datasource type: str
- digest_method type: strchoices: ['sha1', 'sha256']
- scim_enabled type: bool
- scim type: dict
- scim_url type: str
- auth_method type: strchoices: ['token']
- token type: str
Examples
- name: Auth SWG SAML Server
hosts: fortisase
gather_facts: false
vars:
primary_key: "$sase-global"
tasks:
# To configure this resource, please enable proxy configuration.
- name: Create/Update Auth SWG SAML Server
fortinet.fortisase.auth_swg_saml_server:
params:
primary_key: "{{ primary_key }}"
enabled: true
digest_method: "sha256"
idp_entity_id: "https://sts.windows.net/example/"
idp_sign_on_url: "https://login.microsoftonline.com/example/saml2"
idp_log_out_url: "https://login.microsoftonline.com/example/saml2"
idp_certificate:
primary_key: "certificate"
datasource: "system/certificate/remote-certificates"
username: "username"
group_name: "group"
group_match: ""
sp_cert:
primary_key: "FortiSASE Default Certificate"
datasource: "system/certificate/local-certificates"
scim_enabled: false
- name: Delete Auth SWG SAML Server
fortinet.fortisase.auth_swg_saml_server:
params:
primary_key: "{{ primary_key }}"
enabled: false
Return Values
- http_code type: intreturned: always
- response type: rawreturned: always