v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Groups

Delete a Group

Deprecated: Group deletion via SCIM is disabled. This action must be performed via the Admin Group page.

OAuth Scope required: scim.groups.deleteGroups

delete/Groups/{groupId}

Path parameters

groupIdstring required

A group's unique id can be identified using the Retrieve all Groups endpoint with a filter parameter

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.