역할 조회
- 인쇄
- PDF
역할 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
역할을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /api/v1/roles/{roleNo} |
요청 헤더
Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
roleNo | String | Required | 역할 아이디
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v1//roles/5d0d4d80-****-****-****-246e96591a38' \
--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'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
nrn | String | - | 역할에 대한 네이버 클라우드 플랫폼 리소스 식별 값 |
roleNo | String | - | 역할 아이디 |
roleName | String | - | 역할 이름 |
roleType | String | - | 역할 유형
|
sessionExpirationSec | Integer | - | 세션 만료 시간(초)
|
descCont | String | - | 역할에 대한 설명 |
active | Boolean | - | 역할 상태
|
createTime | String | - | 역할 생성 일시
|
modifiedTime | String | - | 역할 마지막 수정 일시
|
lastUseTime | String | - | 역할 마지막 사용 일시
|
policies | Array | - | 역할에 부여된 정책 목록 |
entities | Array | - | 역할이 적용된 대상 목록 |
policies
policies에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
policyId | String | - | 정책 아이디 |
policyName | String | - | 정책 이름 |
policyType | String | - | 정책 유형
|
policyDesc | String | - | 정책에 대한 설명 |
nrn | String | - | 정책에 대한 네이버 클라우드 플랫폼 리소스 식별 값 |
entities
entities에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
id | String | - | 역할 적용 대상 아이디 |
type | String | - | 역할 적용 대상 유형
|
entityType | String | - | 역할 적용 대상 유형
|
entityId | Integer | - | 역할 적용 대상 아이디 |
참고
entityType, entityId는 추후 지원 종료 예정이므로 사용 시 참고해 주십시오.
응답 상태 코드
Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"nrn": "nrn:PUB:IAM::*******:Role/5d0d4d80-****-****-****-246e96591a38",
"roleNo": "5d0d4d80-****-****-****-246e96591a38",
"roleName": "role002",
"roleType": "Account",
"sessionExpirationSec": 600,
"descCont": "Role 설명",
"active": true,
"createTime": "2024-12-12T23:32:34Z",
"modifiedTime": "2024-12-26T08:29:30Z",
"lastUseTime": "2025-01-02T01:26:02Z",
"policies": [
{
"policyId": "7938a9f0-****-****-****-005056a7ecf2",
"policyName": "policy010",
"policyType": "USER_CREATED",
"policyDesc": "policy",
"nrn": "nrn:PUB:IAM::*******:Policy/7938a9f0-****-****-****-005056a7ecf2"
}
],
"entities": [
{
"id": "*******",
"type": "Account",
"entityType": "Account",
"entityId": *******
}
]
}
이 문서가 도움이 되었습니까?