endpoint_group_invitation_codes - Group-Based Invitation Code Resource

Added in version 1.0.0.

Synopsis

Group-Based Invitation Code Resource.

Use API “/resource-api/v2/endpoint/group-invitation-codes”.

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
  • expire_date type: str
  • group_assignment type: dict
    • enabled type: bool
    • group type: dict
      • id type: int
      • path type: str

Examples

- name: Endpoint group invitation codes
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "group1"
  tasks:
    - name: Create/Update endpoint group invitation codes
      fortinet.fortisase.endpoint_group_invitation_codes:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          expire_date: "2026-03-08T12:45:30Z"
          group_assignment:
            enabled: true
            group:
              id: "1"
              path: "All Groups"
    - name: Delete endpoint group invitation codes
      fortinet.fortisase.endpoint_group_invitation_codes:
        state: absent
        params:
          primary_key: "{{ primary_key }}"

Return Values

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

Authors

• Xinwei Du (@dux-fortinet)