Classic/VPC環境で利用できます。
SSO Userのアクティブセッションを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /api/v1/users/{userId}/sessions |
リクエストヘッダ
Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
userId |
String | Required | SSO User IDリスト |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/users/ba0def04-****-****-****-ff0b962016f7/sessions' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
sessionId |
String | - | セッション ID |
clientIp |
String | - | クライアント IPアドレス |
mbrNm |
String | - | セッションを使用しているアカウントのユーザー名 |
mbrNo |
String | - | セッションを使用しているアカウントの会員番号(MemberNo) |
permissionSetId |
String | - | セッションを使用している Permission Set ID |
permissionSetName |
String | - | セッションを使用している Permission Set名 |
createdAt |
String | - | 作成日時
|
レスポンスステータスコード
Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
[
{
"sessionId": "203c0711-****-****-****-b21a454d0b2d",
"clientIp": "**.**.**.**",
"mbrNm": "田中太郎",
"mbrNo": "*******",
"permissionSetId": "63920339-****-****-****-aaf6c9ce927e",
"permissionSetName": "permissionset000",
"createdAt": "2025-01-20T07:42:17Z"
}
]