getUser

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

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

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

서브 계정 또는 역할을 맡은 사용자를 주체 단위로 식별하는 정보를 반환합니다. 주체 유형(principalType)과 역할 전환 정보(sourceIdentity·roleNrn), 소속 그룹을 확인할 때 사용하며, 삭제된 사용자는 조회되지 않습니다. 접근 규칙·정책·메모 등 서브 계정 자원의 상세 정보는 GET /sub-accounts/{subAccountId}로, 태그는 GET /sub-accounts/{subAccountId}/tags로 조회합니다.

요청

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

메서드	URI
GET	/users/{subAccountId}

요청 헤더

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

요청 경로 파라미터

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

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

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`subAccountId`	String (uuid)	-	서브 계정의 고유 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80
`loginId`	String	-	서브 계정의 로그인 아이디 <예시> myloginid01
`name`	String	-	서브 계정의 표시 이름 <예시> 홍길동
`email`	String (email)	-	서브 계정의 이메일 주소 <예시> user@example.com
`groups`	List<GroupSummary>	-	서브 계정이 속한 그룹 목록
`active`	Boolean	-	서브 계정 활성화 상태 `true` \| `false` `true`: 서브 계정이 활성 상태 `false`: 서브 계정이 비활성 상태여서 로그인·API 호출 불가 <예시> true
`deleted`	Boolean	-	서브 계정 삭제 여부 `true` \| `false` `true`: 삭제된 서브 계정 `false`: 삭제되지 않은 서브 계정 <예시> false
`createdDateTime`	String (date-time)	-	서브 계정의 생성 시각 <예시> 2024-01-01T00:00:00Z
`principalType`	String	-	서브 계정의 주체 유형. 값은 V1 API와 같은 주체 유형 코드를 그대로 사용 `MainAccount` \| `IamUser` \| `Server` \| `IamRole` \| `NcloudService` \| `FederatedUser` `MainAccount`: 메인 계정 `IamUser`: 서브 계정 `Server`: 서버 인스턴스 `IamRole`: IAM 역할 `NcloudService`: 서비스 역할을 사용하는 네이버 클라우드 플랫폼 서비스 `FederatedUser`: 외부 ID 공급자로 인증한 사용자 <예시> IamUser
`sourceIdentity`	Object<SourceIdentity>	-	조회한 서브 계정이 IAM 역할인 경우, 해당 역할을 맡은 원래 주체의 자격 증명 정보
`roleNrn`	String	-	서브 계정에 연결된 IAM 역할의 NRN <예시> nrn:GOV:IAM::25000000:Role/4e066e50-9c3a-11e7-8a66-1e5021fa7c80

GroupSummary

그룹 요약 정보. 서브 계정 응답의 소속 그룹 목록에 사용

필드	타입	필수 여부	설명
`groupId`	String (uuid)	-	그룹의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80
`groupName`	String	-	그룹의 이름 <예시> my-group
`nrn`	String	-	그룹의 NRN(Ncloud Resource Name) <예시> nrn:GOV:IAM::25000000:Group/4e066e50-9c3a-11e7-8a66-1e5021fa7c80

SourceIdentity

요청을 발생시킨 소스 자격 증명 정보

필드	타입	필수 여부	설명
`id`	String	-	소스 자격 증명 주체의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80
`provider`	String	-	소스 자격 증명을 발급한 공급자 <예시> ncloud
`type`	String	-	소스 자격 증명의 주체 유형. 값은 V1 API와 같은 주체 유형 코드를 그대로 사용 `MainAccount` \| `IamUser` \| `Server` \| `IamRole` \| `NcloudService` \| `FederatedUser` `MainAccount`: 메인 계정 `IamUser`: 서브 계정 `Server`: 서버 인스턴스 `IamRole`: IAM 역할 `NcloudService`: 서비스 역할을 사용하는 네이버 클라우드 플랫폼 서비스 `FederatedUser`: 외부 ID 공급자로 인증한 사용자 <예시> IamRole

응답 상태 코드

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

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

HTTP 상태 코드	코드	메시지	설명
200	-	-	요청한 서브 계정 사용자 정보를 반환. 조회 대상이 IAM 역할인 경우에만 sourceIdentity와 roleNrn이 포함
400	BadRequest	The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.	유효하지 않은 요청. subAccountId 값의 형식·허용 범위 검증에 실패
403	Forbidden	You do not have sufficient permissions to perform this action.	요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환
404	SubAccountNotFound	The specified sub account could not be found.	지정한 서브 계정이 존재하지 않음

응답 예시

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

{
  "subAccountId": "4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
  "loginId": "myloginid01",
  "name": "홍길동",
  "email": "user@example.com",
  "groups": [
    {
      "groupId": "4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
      "groupName": "my-group",
      "nrn": "nrn:GOV:IAM::25000000:Group/4e066e50-9c3a-11e7-8a66-1e5021fa7c80"
    }
  ],
  "active": true,
  "deleted": false,
  "createdDateTime": "2024-01-01T00:00:00Z",
  "principalType": "IamUser",
  "sourceIdentity": {
    "id": "4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
    "provider": "ncloud",
    "type": "IamRole"
  },
  "roleNrn": "nrn:GOV:IAM::25000000:Role/4e066e50-9c3a-11e7-8a66-1e5021fa7c80"
}