정책 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

정책의 상세 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /api/v1/policies/{policyId}

요청 헤더

Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
policyId String Required 정책 아이디

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
withPermissions Boolean Optional 정책의 상세 권한 표시 여부
  • true | false (기본값)
    • true: 표시
    • false: 표시 안 함

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://subaccount.apigw.gov-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 - 정책 아이디
policyName String - 정책 이름
policyType String - 정책 유형
  • SYSTEM_MANAGED | USER_CREATED
    • SYSTEM_MANAGED: 관리형 정책
    • USER_CREATED: 사용자 정의 정책
policyDesc String - 정책에 대한 설명
nrn String - 정책에 대한 네이버 클라우드 플랫폼 리소스 식별 값
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 - 허용 대상에 대한 네이버 클라우드 플랫폼 리소스 식별 값

응답 상태 코드

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": {}
    }
  ]
}