Set SSO user status

Available in Classic and VPC

Set one or more SSO user as In use (enabled) or Suspended (disabled) status.

Request

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

Method	URI
POST	/api/v1/users/{enable\|disable}

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:

When setting SSO user as In use (enabled) status

The following is a sample request when setting an SSO user as In use (enabled) status.

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/users/enable' \
--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": [
        "ba0def04-****-****-****-ff0b962016f7",
        "e019a8b4-****-****-****-887b25e7961d"
    ]
}'

When setting SSO user as Suspended (disabled) status

The following is a sample request when setting an SSO user as Suspended (disabled) status.

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/users/disable' \
--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": [
        "ba0def04-****-****-****-ff0b962016f7",
        "e019a8b4-****-****-****-887b25e7961d"
    ]
}'

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
    },
    {
        "id": "e019a8b4-****-****-****-887b25e7961d",
        "nrn": "nrn:PUB:SSO::*******:User/e019a8b4-****-****-****-887b25e7961d",
        "success": true
    }
]