グループ Assignmentリストの照会

Prev Next

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

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

リクエスト

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

メソッド URI
GET /api/v1/groups/{groupId}/assignments

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
groupId String Required グループ ID

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

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

フィールド タイプ 必須の有無 説明
page Integer Optional ページ番号
  • 0~N (デフォルト: 0)
size Integer Optional ページの出力数
  • 1~N (デフォルト: 20)

リクエスト例

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/groups/12cfbd94-****-****-****-2ff725201395/assignments?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 - Assignmentリスト

items

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

フィールド タイプ 必須の有無 説明
assignmentId String - Assignment ID
assignmentName String - Assignment名
description String - Assignmentの説明
nrn String - Assignmentに対する NAVERクラウドプラットフォームリソースの識別値
status String - Assignmentの状態
  • active | suspended
    • active: 使用中(有効化)
    • suspended: 停止(無効化)
iamRoleNrn String - Sub Accountサービスに作成された SSOロールの NRN
  • IAM roleに対する NAVERクラウドプラットフォームリソースの識別値
createdAt String - Assignmentの作成日時
  • ISO 8601形式
updatedAt String - Assignmentの最終更新日時
  • ISO 8601形式
accountMbrNo Number - アカウントの会員番号(MemberNo)
accountName String - アカウントのユーザー名
permissionSetId String - Permission Set ID

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

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

レスポンス例

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

{
    "page": 0,
    "totalPages": 1,
    "totalItems": 1,
    "isFirst": true,
    "isLast": true,
    "hasPrevious": false,
    "hasNext": false,
    "items": [
        {
            "assignmentId": "14f396ae-****-****-****-388a3954e37e",
            "assignmentName": "assignment000",
            "description": "assignment000 description",
            "nrn": "nrn:PUB:SSO::*******:Assignment/14f396ae-****-****-****-388a3954e37e",
            "status": "active",
            "iamRoleNrn": "nrn:PUB:IAM::*******:Role/934786b0-****-****-****-005056a79baa",
            "consoleAccessAllowed": true,
            "consoleAccessRestricted": false,
            "apiAccessAllowed": true,
            "apiAccessRestricted": false,
            "createdAt": "2025-01-14T00:50:39Z",
            "updatedAt": "2025-01-14T00:51:35Z",
            "accountMbrNo": *******,
            "accountName": "田中太郎",
            "permissionSetId": "87512735-****-****-****-ab5b164127f5"
        }
    ]
}