Delete SSO user list

Available in Classic and VPC

Delete one or more SSO users.

Request

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

Method	URI
POST	/api/v1/users/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
`userIds`	Array	Required	SSO user ID list See Get SSO user list

Request example

The request example is as follows:

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/users/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 '{
    "userIds": [
        "6b0d0df7-****-****-****-1a11f29b5c34",
        "80d9ba0d-****-****-****-76afe6ea5b33"
    ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`id`	String	-	SSO user ID
`nrn`	String	-	NAVER Cloud Platform resource identification value for SSO user
`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" : "6b0d0df7-****-****-****-1a11f29b5c34",
        "nrn" : "nrn:PUB:SSO::*******:User/6b0d0df7-****-****-****-1a11f29b5c34",
        "success" : true
    },
    {
        "id" : "80d9ba0d-****-****-****-76afe6ea5b33",
        "nrn" : "nrn:PUB:SSO::*******:User/80d9ba0d-****-****-****-76afe6ea5b33",
        "success" : true
    }
]