auth_users - User Resource

Added in version 1.0.0.

Synopsis

User Resource.

Use API “/resource-api/v2/auth/users”.

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 create or update the resource, "absent" means delete the resource.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
  • auth_type type: strchoices: ['ldap', 'password']
  • status type: strchoices: ['disable', 'enable']
  • email type: str
  • password type: str
  • ldap_server type: dict
    • primary_key type: str
    • datasource type: str

Examples

- name: Auth users
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "user_example@example.com"
  tasks:
    - name: Create auth user
      fortinet.fortisase.auth_users:
        state: present
        params:
          primary_key: "{{ primary_key }}"  # For SASE authenticated users, name must match email.
          auth_type: "password"
          password: "example_password"
          email: "{{ primary_key }}"
          status: "enable"
    # Only status can be updated, trying to update other parameters will fail
    - name: Update auth user
      fortinet.fortisase.auth_users:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          status: "disable"
    - name: Delete auth user
      fortinet.fortisase.auth_users:
        state: absent
        params:
          primary_key: "{{ primary_key }}"

Return Values

• http_code type: intreturned: always
• response type: rawreturned: always

Authors

• Xinwei Du (@dux-fortinet)