group.delete

Delete group id.

The delete_users option deletes all users that have this group as their primary group.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

API identifier of the group to delete.
Parameter 2: options

options

Type: object Default: {"delete_users": false}

Options controlling group deletion behavior.

 No Additional Properties

Delete Users

Type: boolean Default: false

Deletes all users that have this group as their primary group.

Result

Type: integer

The API identifier of the deleted group.


Required roles: ACCOUNT_WRITE