역할 목록 조회

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

역할 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v1/roles

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`page`	Integer	Optional	페이지 번호 0~N (기본값: 0)
`size`	Integer	Optional	페이지 출력 수 1~N (기본값: 10)
`searchColumn`	String	Optional	검색 컬럼 `roleName` \| `roleType` \| `nrn` `roleName`: 역할 이름 `roleType`: 역할 유형 `nrn`: 역할에 대한 네이버 클라우드 플랫폼 리소스 식별 값
`searchWord`	String	Optional	검색 키워드

요청 예시

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

curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v1/roles?page=0&size=10' \
--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에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`nrn`	String	-	역할에 대한 네이버 클라우드 플랫폼 리소스 식별 값
`roleNo`	String	-	역할 아이디
`roleName`	String	-	역할 이름
`roleType`	String	-	역할 유형 `Server` \| `Account` \| `Service` `Server`: VPC 환경의 서버 리소스에 할당. Access Key 없이 서비스 및 리소스 접근 가능 `Account`: 메인 계정의 포털 및 콘솔 접근 권한을 서브 계정에 할당. 역할 전환을 통해 대상 계정의 리소스 접근 가능 `Service`: 서비스에 할당. 다른 서비스의 리소스 접근 가능
`sessionExpirationSec`	Integer	-	세션 만료 시간(초) `600` \| `1800` \| `3600` \| `10800`
`descCont`	String	-	역할에 대한 설명
`active`	Boolean	-	역할 상태 `true` \| `false` `true`: 활성화 `false`: 비활성화
`createTime`	String	-	역할 생성 일시 ISO 8601 형식
`modifiedTime`	String	-	역할 마지막 수정 일시 ISO 8601 형식
`lastUseTime`	String	-	역할 마지막 사용 일시 ISO 8601 형식

응답 상태 코드

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

응답 예시

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

{
  "page": 0,
  "totalPages": 1,
  "totalItems": 2,
  "hasPrevious": false,
  "hasNext": false,
  "items": [
    {
      "nrn": "nrn:PUB:IAM::5*****8:Role/76a744f0-****-****-****-246e966ebeb4",
      "roleNo": "76a744f0-****-****-****-246e966ebeb4",
      "roleName": "service1",
      "roleType": "Service",
      "descCont": "",
      "active": true,
      "createTime": "2024-12-23T02:41:51Z",
      "modifiedTime": "2024-12-24T02:25:16Z",
      "lastUseTime": "2025-01-02T01:26:02Z"
    },
    {
      "nrn": "nrn:PUB:IAM::5*****8:Role/6e1de560-****-****-****-246e966ebec4",
      "roleNo": "6e1de560-****-****-****-246e966ebec4",
      "roleName": "NcloudStorageManagementRole",
      "roleType": "NcloudStorage",
      "active": true,
      "createTime": "2024-11-07T05:23:32Z",
      "modifiedTime": "2024-11-07T05:23:32Z"
    }
  ],
  "isFirst": true,
  "isLast": true
}