ポリシーの照会

Prev Next

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

ポリシーの詳細情報を照会します。

リクエスト

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

メソッド URI
GET /api/v1/policies/{policyId}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
policyId String Required ポリシー ID

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

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

フィールド タイプ 必須の有無 説明
withPermissions Boolean Optional ポリシーの詳細権限を表示するかどうか
  • true | false (デフォルト)
    • true: 表示
    • false: 表示しない

リクエスト例

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

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/policies/48ac3260-****-****-****-246e96591594?withPermissions=true' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
policyId String - ポリシー ID
policyName String - ポリシー名
policyType String - ポリシータイプ
  • SYSTEM_MANAGED | USER_CREATED
    • SYSTEM_MANAGED: 管理型ポリシー
    • USER_CREATED: ユーザー定義ポリシー
policyDesc String - ポリシーの説明
nrn String - ポリシーに対する NAVERクラウドプラットフォームリソースの識別値
permissions Array - 許可権限リスト
  • withPermissionsがtrueの場合に表示

permissions

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

フィールド タイプ 必須の有無 説明
effect String - 権限を許可するかどうか
  • Allow (有効な値)
targets Array - 権限許可の対象
condition Object - ポリシーコンディション
  • ポリシーにコンディションが存在する場合に表示
condition.{operator} Object - ポリシーコンディション演算子
condition.{operator}.{key} Object - ポリシーコンディションキー
condition.{operator}.{value} Array - ポリシーコンディションの値

targets

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

フィールド タイプ 必須の有無 説明
product String - 許可対象のサービスコード
actions Array - 許可対象のアクション
resourceNrns Array - 許可対象に対する NAVERクラウドプラットフォームリソースの識別値

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

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

レスポンス例

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

{
  "policyId": "b38802f0-****-****-****-246e966ebec4",
  "policyName": "mypolicy",
  "policyType": "USER_CREATED",
  "policyDesc": "my policy",
  "nrn": "nrn:PUB:IAM::5*****8:Policy/b38802f0-****-****-****-246e966ebec4",
  "permissions": [
    {
      "effect": "Allow",
      "targets": [
        {
          "product": "VPCServer",
          "actions": [
            "Change*",
            "View*"
          ],
          "resourceNrns": [
            "nrn:PUB:VPCServer::5*****8:*"
          ]
        }
      ],
      "condition": {
        "StringEquals": {
          "ncp:principalName": [
            "abc"
          ]
        }
      }
    },
    {
      "effect": "Allow",
      "targets": [
        {
          "product": "ExternalAccess",
          "actions": [
            "Change*",
            "View*"
          ],
          "resourceNrns": [
            "nrn:PUB:ExternalAccess::5*****8:*"
          ]
        }
      ],
      "condition": {}
    }
  ]
}