リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/groups/50b77400-****-****-****-246e96591a38' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`groupId`	String	-	グループ ID
`groupName`	String	-	グループ名
`subAccounts`	Array	-	グループに属するサブアカウントリスト
`policies`	Array	-	グループに割り当てられたポリシーリスト
`nrn`	String	-	グループに対する NAVERクラウドプラットフォームリソースの識別値

`subAccounts`

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

フィールド	タイプ	必須の有無	説明
`subAccountId`	String	-	サブアカウント ID
`loginId`	String	-	サブアカウントログイン ID
`name`	String	-	サブアカウントのユーザー名
`nrn`	String	-	サブアカウントに対する NAVERクラウドプラットフォームリソースの識別値

`policies`

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

フィールド	タイプ	必須の有無	説明
`policyId`	String	-	ポリシー ID
`policyName`	String	-	ポリシー名
`policyType`	String	-	ポリシータイプ `SYSTEM_MANAGED` \| `USER_CREATED` `SYSTEM_MANAGED`: 管理型ポリシー `USER_CREATED`: ユーザー定義ポリシー
`policyDesc`	String	-	ポリシーの説明
`nrn`	String	-	ポリシーに対する NAVERクラウドプラットフォームリソースの識別値

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

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

レスポンス例

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

{
    "groupId": "50b77400-****-****-****-246e96591a38",
    "groupName": "group001",
    "subAccounts": [
        {
            "subAccountId": "dfafe250-****-****-****-246e96591594",
            "loginId": "user000",
            "name": "user000",
            "nrn": "nrn:PUB:IAM::2768364:SubAccount/dfafe250-****-****-****-246e96591594"
        }
    ],
    "policies": [
        {
            "policyId": "56377a60-****-****-****-246e96591594",
            "policyName": "NCP_ADMINISTRATOR",
            "policyType": "SYSTEM_MANAGED",
            "policyDesc": "ポータル、コンソールにアクセスする権限がメインアカウントと同じ権限",
            "nrn": "nrn:PUB:IAM:::Policy/56377a60-****-****-****-246e96591594"
        },
        {
            "policyId": "f9a2ba60-****-****-****-000000008000",
            "policyName": "NCP_FINANCE_MANAGER",
            "policyType": "SYSTEM_MANAGED",
            "policyDesc": " Cost Explorerサービスとポータル内マイページの利用管理メニューと決済手段管理メニューにアクセスする権限",
            "nrn": "nrn:PUB:IAM:::Policy/f9a2ba60-****-****-****-000000008000"
        }
    ],
    "nrn": "nrn:PUB:IAM::2768364:Group/50b77400-****-****-****-246e96591a38"
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Sub Account