정책 목록 조회

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

정책 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v1/policies

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`page`	Integer	Optional	페이지 번호 0~N (기본값: 0)
`size`	Integer	Optional	페이지 출력 수 1~N (기본값: 10)
`searchColumn`	String	Optional	검색 컬럼 `policyName` `policyName`: 정책 이름
`searchWord`	String	Optional	검색 키워드
`type`	String	Optional	정책 유형 `SYSTEM_MANAGED` \| `USER_CREATED` `SYSTEM_MANAGED`: 관리형 정책 `USER_CREATED`: 사용자 정의 정책

요청 예시

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

curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v1/policies?type=SYSTEM_MANAGED' \
--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'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`page`	Integer	-	페이지 번호
`totalPages`	Integer	-	전체 페이지 수
`totalItems`	Integer	-	응답 결과 수
`hasPrevious`	Boolean	-	이전 페이지 존재 여부 `true` \| `false` `true`: 존재 `false`: 존재 안 함
`hasNext`	Boolean	-	다음 페이지 존재 여부 `true` \| `false` `true`: 존재 `false`: 존재 안 함
`items`	Array	-	정책 목록
`isFirst`	Boolean	-	첫 페이지 여부 `true` \| `false` `true`: 첫 페이지 `false`: 첫 페이지 아님
`isLast`	Boolean	-	마지막 페이지 여부 `true` \| `false` `true`: 마지막 페이지 `false`: 마지막 페이지 아님

`items`

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

필드	타입	필수 여부	설명
`policyId`	String	-	정책 아이디
`policyName`	String	-	정책 이름
`policyType`	String	-	정책 유형 `SYSTEM_MANAGED` \| `USER_CREATED` `SYSTEM_MANAGED`: 관리형 정책 `USER_CREATED`: 사용자 정의 정책
`policyDesc`	String	-	정책에 대한 설명
`nrn`	String	-	정책에 대한 네이버 클라우드 플랫폼 리소스 식별 값

응답 상태 코드

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

응답 예시

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

{
    "page": 0,
    "totalPages": 88,
    "totalItems": 264,
    "hasPrevious": false,
    "hasNext": true,
    "items": [
        {
            "policyId": "7a0760f0-****-****-****-246e966ebec4",
            "policyName": "NCP_NCLOUD_STORAGE_VIEWER",
            "policyType": "SYSTEM_MANAGED",
            "policyDesc": "Ncloud Storage 서비스 내 조회 기능만 이용할 수 있는 권한",
            "nrn": "nrn:PUB:IAM:::Policy/7a0760f0-****-****-****-246e966ebec4"
        },
        {
            "policyId": "7a05b340-****-****-****-246e966ebec4",
            "policyName": "NCP_NCLOUD_STORAGE_MANAGER",
            "policyType": "SYSTEM_MANAGED",
            "policyDesc": "Ncloud Storage 서비스 내 모든 기능을 이용할 수 있는 권한",
            "nrn": "nrn:PUB:IAM:::Policy/7a05b340-****-****-****-246e966ebec4"
        },
        {
            "policyId": "6869c8e0-****-****-****-246e966ebec4",
            "policyName": "NCP_COST_EXPLORER_VIEWER",
            "policyType": "SYSTEM_MANAGED",
            "policyDesc": "Cost Explorer 서비스 내 조회 기능만 이용할 수 있는 권한",
            "nrn": "nrn:PUB:IAM:::Policy/6869c8e0-****-****-****-246e966ebec4"
        }
    ],
    "isFirst": true,
    "isLast": false
}