전환 가능 역할 조회

Prev Next

서브 계정에서 전환 가능한 역할 목록을 조회합니다. 서브 계정으로만 호출이 가능합니다.

요청

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

메서드 URI
GET /api/v1/switchable-roles

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
searchColumn String Optional 검색 컬럼
  • nrn | roleDisplayName
    • nrn: 역할에 대한 네이버 클라우드 플랫폼 리소스 식별 값
    • roleDisplayName: 역할 이름
searchWord String Optional 검색 키워드

요청 예시

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

curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v1/switchable-roles' \
--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'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
roleNo String - 역할 아이디
roleNrn String - 역할에 대한 네이버 클라우드 플랫폼 리소스 식별 값
displayName String - 역할 이름
description String - 역할에 대한 설명
isCurrentRole Boolean - 현재 사용 여부
  • true | false
    • true: 사용 중
    • false: 사용 안 함

응답 상태 코드

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

응답 예시

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

[
  {
    "roleNo": "9ba09190-****-****-****-246e966ebec4",
    "roleNrn": "nrn:PUB:IAM::5*****8:Role/9ba09190-****-****-****-246e966ebec4",
    "displayName": "Adm",
    "description": "admin",
    "isCurrentRole": false
  }
]