MENU
      정책 유효성 확인

        정책 유효성 확인


        기사 요약

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

        정책을 생성하기 전에 정책 상세 내용의 유효성을 확인합니다.

        요청

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

        메서드URI
        POST/api/v1/policy/validation

        요청 헤더

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

        요청 바디

        요청 바디에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        policyNameStringRequired정책 이름
        • 한글, 영어 대소문자, 일어, 특수문자 . _ -를 사용하여 3~30자
        • 첫 글자는 한글, 영어 대소문자, 일어
        descriptionStringOptional정책에 대한 설명(Bytes)
        • 0~300
        permissionsArrayRequired허용 권한 목록

        permissions

        permissions에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        effectStringRequired권한 허용 여부
        • Allow (유효 값)
        targetsArrayRequired권한 허용 대상
        conditionObjectOptional정책 컨디션
        condition.{operator}ObjectOptional정책 컨디션 연산자
        condition.{operator}.{key}ObjectOptional정책 컨디션 키
        condition.{operator}.{value}ArrayOptional정책 컨디션 값

        targets

        targets에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        productStringRequired허용 대상 서비스 코드
        actionsArrayRequired허용 대상 액션
        • 서비스별 권한 정보를 참조하여 다음과 같이 적용
          • 상세 액션 단위: 액션 이름 입력
          • 모든 조회 단위: View* 입력
          • 모든 변경 단위: Change* 입력
          • 서비스 단위: 별표(*) 입력
        resourceNrnsArrayRequired허용 대상에 대한 네이버 클라우드 플랫폼 리소스 식별 값
        • 지정하지 않을 경우, 별표(*) 입력

        요청 예시

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

        curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/policy/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' \
        --header 'Content-Type: application/json' \
        --data '{
            "policyName": "policy",
            "description": "테스트",
            "permissions": [
                {
                    "effect": "Allow",
                    "targets": [
                        {
                            "product": "Server",
                            "actions": [
                                "View*"
                            ],
                            "resourceNrns": [
                                "*"
                            ]
                        }
                    ]
                }
            ]
        }
        Shell

        응답

        응답 형식을 설명합니다.

        응답 바디

        응답 바디에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        detailsArray-유효성 확인 상세 결과
        successBoolean-유효성 확인 결과
        • true | false
          • true: 유효함
          • false: 유효하지 않음

        details

        details에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        typeString-확인 결과 유형
        • INFO | WARNING | ERROR
        • ERROR인 경우, 유효성 확인 실패
        codeString-상세 코드
        locationString-확인 위치
        messageString-확인 결과 메시지

        응답 상태 코드

        Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.

        응답 예시

        응답 예시는 다음과 같습니다.

        확인 결과 유효한 정책인 경우

        확인 결과 유효한 정책인 경우의 응답 예시는 다음과 같습니다.

        {
          "success": true
        }
        JSON

        확인 결과 유효하지 않은 정책인 경우

        확인 결과 유효하지 않은 정책인 경우의 응답 예시는 다음과 같습니다.

        {
          "details": [
            {
              "type": "WARNING",
              "code": "iam.policy.missingRelatedAction",
              "location": "",
              "message": "연관액션이 누락되었습니다. {Server=[View/getInitScriptList, Change/changeInitScript, View/getRootPasswordServerInstanceList, Change/setDetailedMonitoring]}"
            }
          ],
          "success": false
        }
        JSON

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.