getRoleAccount

이 가이드는 API 명세를 기반으로 자동 생성했습니다.

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

Ncloud API 표준 규격을 적용한 API입니다.

역할 ID로 지정한 역할이 전환할 수 있는 대상 계정을 조회합니다. 연결된 대상 계정이 없으면 404를 반환합니다. 대상 계정 소유자의 이름과 로그인 아이디는 마스킹된 값으로 반환합니다.

요청

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

메서드	URI
GET	/roles/{roleId}/account

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`roleId`	String (uuid)	Required	대상 역할의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80

요청 예시

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

curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v2/roles/4e066e50-9c3a-11e7-8a66-1e5021fa7c80/account' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`ownAccount`	Boolean	-	대상 계정이 호출자 본인의 계정인지 여부 `true` \| `false` `true`: 역할에 연결된 대상 계정이 호출자 본인의 계정 `false`: 역할에 연결된 대상 계정이 다른 계정 <예시> false
`accountName`	String	-	대상 계정 소유자의 이름. 앞뒤 일부 문자만 남기고 나머지를 마스킹한 값을 반환 <예시> 홍*동
`loginId`	String	-	대상 계정 소유자의 로그인 아이디(이메일 형식). @ 앞의 아이디 부분은 앞 2자만 남기고 나머지를 마스킹하며, @ 이하의 도메인 부분은 마스킹하지 않고 그대로 반환 <예시> my*********@example.com

응답 상태 코드

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

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	역할에 연결된 대상 계정을 반환. 계정 소유자의 이름과 로그인 아이디는 마스킹된 값
400	BadRequest	The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.	유효하지 않은 요청. roleId 값의 형식·허용 범위 검증에 실패
403	Forbidden	You do not have sufficient permissions to perform this action.	요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환
404	RoleNotFound	The specified role could not be found.	지정한 역할이 존재하지 않음
404	NotFound	One or more of the resources in the request does not exist in the system.	역할에 연결된 대상 계정 없음

응답 예시

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

{
  "ownAccount": false,
  "accountName": "홍*동",
  "loginId": "my*********@example.com"
}