Delete group assignment

Prev Next

Available in Classic and VPC

Delete group from an assignment.

Request

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

Method URI
POST /api/v1/groups/{groupId}/assignments/delete

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
assignmentIds Array Required Assignment ID list

Request example

The request example is as follows:

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/groups/12cfbd94-****-****-****-2ff725201395/assignments/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 '{
    "assignmentIds": [
        "14f396ae-****-****-****-388a3954e37e"
    ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - Assignment ID
nrn String - NAVER Cloud Platform resource identification value for assignment
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": "14f396ae-****-****-****-388a3954e37e",
        "nrn": "nrn:PUB:SSO::*******:Assignment/14f396ae-****-****-****-388a3954e37e",
        "success": true
    }
]