Delete SSO user

Prev Next

Available in Classic and VPC

Delete an SSO user.

Request

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

Method URI
DELETE /api/v1/users/{userId}

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
userId String Required SSO user ID list

Request example

The request example is as follows:

curl --location --request DELETE 'https://sso.apigw.ntruss.com/api/v1/users/ba0def04-****-****-****-ff0b962016f7' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

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": "ba0def04-****-****-****-ff0b962016f7",
    "nrn": "nrn:PUB:SSO::*******:User/ba0def04-****-****-****-ff0b962016f7",
    "success": true
}