auth_user_groups - User Group Resource

Added in version 1.0.0.

Synopsis

User Group Resource.

Use API “/resource-api/v2/auth/user-groups”.

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
  • group_type type: strchoices: ['firewall', 'fsso']
  • local_users type: listelements: dict
    • primary_key type: str
    • datasource type: str
  • remote_user_groups type: listelements: dict
    • server type: dict
      • primary_key type: str
      • datasource type: strchoices: ['auth/ldap-servers', 'auth/radius-servers', 'auth/swg-saml-server', 'auth/vpn-saml-server']
    • matches type: listelements: str

Examples

- name: Auth User Groups
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "example_group"
  tasks:
    - name: Create/Update Auth User Groups
      fortinet.fortisase.auth_user_groups:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          group_type: "firewall"
          local_users:
            - primary_key: "example_user@example.com"
              datasource: "auth/users"
          remote_user_groups:
            - server:
                primary_key: "example_ldap_server"
                datasource: "auth/ldap-servers"
              matches: ["example_group"]
    - name: Delete Auth User Groups
      fortinet.fortisase.auth_user_groups:
        state: absent
        params:
          primary_key: "{{ primary_key }}"

Return Values

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

Authors

• Xinwei Du (@dux-fortinet)