Classic/VPC環境で利用できます。
SSO Userが属するグループの詳細情報を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /api/v1/users/{userId}/groups/{groupId} |
リクエストヘッダ
Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
userId |
String | Required | SSO User ID |
groupId |
String | Required | グループ ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/users/ba0def04-****-****-****-ff0b962016f7/groups/12cfbd94-****-****-****-2ff725201395' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
groupId |
String | - | グループ ID |
groupName |
String | - | グループ名 |
nrn |
String | - | グループに対する NAVERクラウドプラットフォームリソースの識別値 |
description |
String | - | グループの説明 |
createdAt |
String | - | グループの作成日時
|
updatedAt |
String | - | グループの更新日時
|
relationCreatedAt |
String | - | グループの追加日時
|
レスポンスステータスコード
Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"groupId": "12cfbd94-****-****-****-2ff725201395",
"groupName": "group000",
"nrn": "nrn:PUB:SSO::*******:Group/12cfbd94-****-****-****-2ff725201395",
"description": "group000 description",
"createdAt": "2025-01-13T02:04:15Z",
"updatedAt": "2025-01-13T02:07:21Z",
"relationCreatedAt": "2025-01-13T02:07:21Z"
}