Delete group tag

Prev Next

Available in Classic and VPC

Delete a tag added to a group.

Request

This section describes the request format. The method and URI are as follows:

Method URI
DELETE /api/v1/groups/{groupId}/tags

Request headers

For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
groupId String Required Group ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
tagKey String Required Tag key
tagValue String Required Tag value

Request example

The request example is as follows:

curl --location --request DELETE 'https://sso.apigw.ntruss.com/api/v1/groups/12cfbd94-****-****-****-2ff725201395/tags' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "tagKey": "key1",
    "tagValue": "value1"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API processing result
  • true | false
    • true: Succeeded
    • false: Failed
message String - Result message
  • Displayed if success is false.

Response status codes

For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.

Response example

The response example is as follows:

{
    "success": true
}