SSO Userグループリストの照会

Classic/VPC環境で利用できます。

SSO Userが属するグループリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/users/{userId}/groups

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`userId`	String	Required	SSO User ID SSO Userリストの照会を参照

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`searchColumn`	String	Conditional	検索カラム `groupName` \| `groupNrn` \| `groupId` `groupName`: グループ名 `groupNrn`: グループに対する NAVERクラウドプラットフォームリソースの識別値 `groupId`: グループ ID `searchWord`を入力する場合、必須
`searchWord`	String	Optional	検索キーワード検索カラムのオプション(`groupName`、`groupNrn`、`groupId`)と全体または一部が一致しない値を入力した場合、レスポンス時に`items`は空の値の`[]`で表示 `searchColumn`なしでリクエストする場合、全リストを表示
`page`	Integer	Optional	ページ番号 0~N (デフォルト: 0)
`size`	Integer	Optional	ページの出力数 1~N (デフォルト: 20)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/users/ba0def04-****-****-****-ff0b962016f7/groups?searchColumn=groupName&searchWord=group000&page=0&size=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`page`	Number	-	ページ番号
`totalPages`	Number	-	ページの総数
`totalItems`	Number	-	レスポンス結果数
`isFirst`	Boolean	-	最初のページかどうか `true` \| `false` `true`: 最初のページ `false`: 最初のページではない
`isLast`	Boolean	-	最後のページかどうか `true` \| `false` `true`: 最後のページ `false`: 最後のページではない
`hasPrevious`	Boolean	-	以前のページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`hasNext`	Boolean	-	次のページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`items`	Array	-	グループリスト

`items`

itemsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`groupId`	String	-	グループ ID
`groupName`	String	-	グループ名
`nrn`	String	-	グループに対する NAVERクラウドプラットフォームリソースの識別値
`description`	String	-	グループの説明
`createdAt`	String	-	グループの作成日時 ISO 8601形式
`updatedAt`	String	-	グループの更新日時 ISO 8601形式
`relationCreatedAt`	String	-	グループの追加日時 ISO 8601形式

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "page" : 0,
    "totalPages" : 1,
    "totalItems" : 1,
    "isFirst" : true,
    "isLast" : true,
    "hasPrevious" : false,
    "hasNext" : false,
    "items" : [
        {
            "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"
        }
    ]
}