ロールの照会

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

ロールを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/roles/{roleNo}

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1//roles/5d0d4d80-****-****-****-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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`nrn`	String	-	ロールに対する NAVERクラウドプラットフォームリソースの識別値
`roleNo`	String	-	ロール ID
`roleName`	String	-	ロール名
`roleType`	String	-	ロールタイプ `Server` \| `Account` \| `Service` `Server`: VPC環境のサーバリソースに割り当て。Access Keyなしでサービスやリソースにアクセス可能 `Account`: メインアカウントのポータルとコンソールへのアクセス権限をサブアカウントに割り当て。ロールの切り替えにより対象アカウントのリソースにアクセス可能 `Service`: サービスに割り当て。他のサービスのリソースにアクセス可能
`sessionExpirationSec`	Integer	-	セッションタイムアウト(秒) `600` \| `1800` \| `3600` \| `10800`
`descCont`	String	-	ロールの説明
`active`	Boolean	-	ロールの状態 `true` \| `false` `true`: 有効化 `false`: 無効化
`createTime`	String	-	ロールの作成日時 ISO 8601形式
`modifiedTime`	String	-	ロールの最終更新日時 ISO 8601形式
`lastUseTime`	String	-	ロールの最終使用日時 ISO 8601形式
`policies`	Array	-	ロールに付与されたポリシーリスト
`entities`	Array	-	ロールが適用された対象リスト

`policies`

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

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

`entities`

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

フィールド	タイプ	必須の有無	説明
`id`	String	-	ロール適用対象の ID
`type`	String	-	ロール適用対象のタイプ `Server` \| `Account` \| `Service` `Server`: VPC環境のサーバ `Account`: アカウント `Service`: サービス
`entityType`	String	-	ロール適用対象のタイプ `Server` \| `Account` \| `Service` `Server`: VPC環境のサーバ `Account`: アカウント `Service`: サービス
`entityId`	Integer	-	ロール適用対象の ID

参考

entityType、entityIdは今後サポート終了が予定されています。

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

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

レスポンス例

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

{
    "nrn": "nrn:PUB:IAM::*******:Role/5d0d4d80-****-****-****-246e96591a38",
    "roleNo": "5d0d4d80-****-****-****-246e96591a38",
    "roleName": "role002",
    "roleType": "Account",
    "sessionExpirationSec": 600,
    "descCont": "Roleの説明",
    "active": true,
    "createTime": "2024-12-12T23:32:34Z",
    "modifiedTime": "2024-12-26T08:29:30Z",
    "lastUseTime": "2025-01-02T01:26:02Z",
    "policies": [
        {
            "policyId": "7938a9f0-****-****-****-005056a7ecf2",
            "policyName": "policy010",
            "policyType": "USER_CREATED",
            "policyDesc": "policy",
            "nrn": "nrn:PUB:IAM::*******:Policy/7938a9f0-****-****-****-005056a7ecf2"
        }
    ],
    "entities": [
        {
            "id": "*******",
            "type": "Account",
            "entityType": "Account",
            "entityId": *******
        }
    ]
}