user.delete

Delete user id.

The delete_group option deletes the user primary group if it is not being used by any other user.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the user account to delete.

Parameter 2: options

options

Type: object

Options controlling the user deletion process.

No Additional Properties

delete_group

Delete Group

Type: boolean Default: true

Delete the user primary group if it is not being used by any other user.

Return value

Result

Type: integer

ID of the deleted user account.

Required roles: ACCOUNT_WRITE