Deletes a group.

Prerequisites

The group that you want to delete is not associated with the following resources. If the group is associated with the resources, the deletion fails.

  • Users: You must remove users from the group. For more information, see RemoveUserFromGroup.
  • Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see DeleteAccessAssignment.

Usage notes

If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.

This topic provides an example on how to delete the group g-00jqzghi2n3o5hkh****.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteGroup

The operation that you want to perform. Set the value to DeleteGroup.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

GroupId String Yes g-00jqzghi2n3o5hkh****

The ID of the group.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String F723DE01-6276-5DC4-9B1F-9CBE3E1748B2

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=DeleteGroup
&DirectoryId=d-00fc2p61****
&GroupId=g-00jqzghi2n3o5hkh****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteGroupResponse>
    <RequestId>F723DE01-6276-5DC4-9B1F-9CBE3E1748B2</RequestId>
</DeleteGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "F723DE01-6276-5DC4-9B1F-9CBE3E1748B2"
}

Error codes

For a list of error codes, visit the API Error Center.