Available in Classic and VPC
Expire an active session of an SSO user.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v1/users/{userId}/sessions/expire |
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 |
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
sessionIds |
Array | Required | Session ID list |
Request example
The request example is as follows:
curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/users/ba0def04-****-****-****-ff0b962016f7/sessions/expire' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"sessionIds": [
"203c0711-****-****-****-b21a454d0b2d"
]
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
id |
String | - | Session ID |
success |
Boolean | - | API processing result
|
message |
String | - | Result message
|
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": "203c0711-****-****-****-b21a454d0b2d",
"success": true
}
]