정책 생성

Prev Next

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

사용자 정의 정책(User Created)을 생성합니다.

참고

정책은 최대 500개까지 생성할 수 있습니다.

요청

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

메서드 URI
POST /api/v1/policies

요청 헤더

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

요청 바디

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

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

permissions

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

필드 타입 필수 여부 설명
effect String Required 권한 허용 여부
  • Allow (유효 값)
targets Array Required 권한 허용 대상
condition Object Optional 정책 컨디션
condition.{operator} Object Optional 정책 컨디션 연산자
condition.{operator}.{key} Object Optional 정책 컨디션 키
condition.{operator}.{value} Array Optional 정책 컨디션 값

targets

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

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

요청 예시

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

curl --location --request POST 'https://subaccount.apigw.gov-ntruss.com/api/v1/policies' \
--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": "mypolicy2",
    "permissions": [
        {
            "effect": "Allow",
            "targets": [
                {
                    "product": "AiTEMS",
                    "actions": [
                        "View*", "Change*"
                    ],
                    "resourceNrns": [
                        "*"
                    ]
                }
            ]
        }
    ],
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
policyId String - 정책 아이디
policyName String - 정책 이름
description String - 정책에 대한 설명
validationResult Object - 유효성 확인 결과
validationResult.details Array - 유효성 확인 상세 결과
validationResult.success Boolean - 유효성 확인 결과
  • true | false
    • true: 유효함
    • false: 유효하지 않음

validationResult.details

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

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

응답 상태 코드

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

응답 예시

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

{
    "policyId": "ec5a5dd0-****-****-****-246e966ebeb4",
    "policyName": "mypolicy2",
    "validationResult": {
        "details": [],
        "success": true
    }
}