BEbeyondidentity
Groups

Delete users from a group

To delete users from a group, send a POST request to /v2/groups/$GROUP_ID:deleteUsers. The request may contain up to 1000 users to delete. Users which already do not belong to the group will be ignored.

Note that this endpoint does not support deleting users from permission groups. If the request attempts to delete users from a permission group, you'll receive a 403 error.

post/v2/groups/{group_id}:deleteUsers

Request

Path parameters

group_idstring required
Example:25f94daf-63d8-4b40-b0ea-4843971d1d8e

A unique identifier for a group.

Request body

idstring

ID of the group.

user_idsstring[]

IDs of the users to be deleted from the group.

Response

The response is a JSON object containing standard group attributes.

idstring

A unique identifier for the group within a tenant that is automatically generated on creation. This field is immutable and read-only.

create_timestring date-time

A time value in the ISO8601 combined date and time format that gets generated automatically and represents the time the group gets created. This field is immutable and read-only.

update_timestring date-time

A time value in the ISO8601 combined date and time format that gets generated automatically and represents the time the group gets updated. This field is read-only.

tenant_idstring

A unique identifier for the group's tenant that is set automatically on creation. This field is immutable and read-only.

namestring

A required unique name for the group within the tenant.

descriptionstring

A required description for the group within the tenant.

sourcestring

The source that created the group. This field is immutable and read-only.

Example response

{
  "id": "25f94daf-63d8-4b40-b0ea-4843971d1d8e",
  "create_time": "2022-04-12T05:53:07.119Z",
  "update_time": "2022-06-16T14:31:03.770Z",
  "tenant_id": "acme-corp",
  "name": "Acme Group",
  "description": "Members of the Acme Group",
  "source": "scim"
}

Changes

No recorded changes to this operation across all 1 revision of this API.