Delete group list

Available in Classic and VPC

Delete one or more groups.

Request

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

Method	URI
POST	/api/v1/groups/delete

Request headers

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

Request body

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

Field	Type	Required	Description
`groupIds`	Array	Required	Group ID list See Get group list

Request example

The request example is as follows:

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/groups/delete' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "groupIds": [
        "eeca2b23-****-****-****-c1226dea835d",
        "7e278a99-****-****-****-584329d9c543"
    ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`id`	String	-	Group ID
`nrn`	String	-	NAVER Cloud Platform resource identification value for group
`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:

[
    {
        "id" : "eeca2b23-****-****-****-c1226dea835d",
        "nrn" : "nrn:PUB:SSO::*******:Group/eeca2b23-****-****-****-c1226dea835d",
        "success" : true
    },
    {
        "id" : "7e278a99-****-****-****-584329d9c543",
        "nrn" : "nrn:PUB:SSO::*******:Group/7e278a99-****-****-****-584329d9c543",
        "success" : true
    }
]