Updated on 2024-04-10 GMT+08:00

Deleting a Group

Function

This API is used to delete an IAM Identity Center group based on the group ID.

URI

DELETE /v1/identity-stores/{identity_store_id}/groups/{group_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

identity_store_id

Yes

String

Globally unique ID of the identity source

Minimum length: 12

Maximum length: 12

group_id

Yes

String

Globally unique ID of an IAM Identity Center group in the identity source

Minimum length: 1

Maximum length: 64

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Maximum length: 2048

Response Parameters

Status code: 400

Table 3 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Request ID

encoded_authorization_message

String

Authentication information

Status code: 403

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Request ID

encoded_authorization_message

String

Authentication information

Status code: 404

Table 5 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Request ID

encoded_authorization_message

String

Authentication information

Example Request

Deleting an IAM Identity Center group based on the group ID

DELETE https://{hostname}/v1/identity-stores/{identity_store_id}/groups/{group_id}

Example Response

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.