사용자 정보 조회

Prev Next

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

서브 계정, 삭제된 서브 계정, 역할 사용자 등 계정에 권한이 부여된 서브 계정의 사용자 정보를 조회합니다.

요청

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

메서드 URI
GET /api/v1/users/{subAccountId}

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
subAccountId String Required 서브 계정 아이디

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
includeDeleted Boolean Optional 삭제된 계정 포함 여부
  • true | false (기본값)
    • true: 포함
    • false: 제외

요청 예시

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

curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v1/users/dfafe250-****-****-****-246e96591594?includeDeleted=true' \
--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'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
subAccountId String - 서브 계정 아이디
loginId String - 서브 계정 로그인 아이디
name String - 서브 계정 사용자 이름
groups Array - 서브 계정의 소속 그룹 목록
active Boolean - 서브 계정 상태
  • true | false
    • true: 활성화
    • false: 비활성화
deleted Boolean - 삭제된 계정 여부
  • true | false
    • true: 삭제된 계정
    • false: 삭제되지 않은 계정
createTime String - 서브 계정 생성 일시
  • ISO 8601 형식
principalType String - 서브 계정 유형
  • IamUser | IamRole
    • IamUser: 서브 계정
    • IamRole: 역할 사용자
sourceIdentity Object - 역할 사용자 정보
  • principalTypeIamRole인 경우, 표시
sourceIdentity.type String - 역할 사용자 유형
  • IamUser | Server | FederatedUser | NcloudService
    • IamUser: Account 역할
    • Server: Server 역할
    • FederatedUser: Single Sign-On 역할
    • NcloudService: Service 역할
  • principalTypeIamRole인 경우, 표시
sourceIdentity.id String - 역할 사용자 아이디
  • 역할 유형별 표시되는 정보
    • Account 역할: 서브 계정 아이디
    • Server 역할: 해당 없음
    • Single Sign-On 역할: SSO User 아이디
    • Service 역할: 서비스 리소스 아이디
  • principalTypeIamRole인 경우, 표시
sourceIdentity.provider String - 역할 사용자의 소속 구분
  • 역할 유형별 표시되는 정보
    • Account 역할: 회원 번호
    • Server 역할: 해당 없음
    • Single Sign-On 역할: SSO Tenant 아이디
    • Service 역할: 서비스 아이디
  • principalTypeIamRole인 경우, 표시
roleNrn String - 전환한 역할에 대한 네이버 클라우드 플랫폼 리소스 식별 값
  • principalTypeIamRole인 경우, 표시

groups

groups에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
groupId String - 그룹 아이디
groupName String - 그룹 이름
nrn String - 그룹에 대한 네이버 클라우드 플랫폼 리소스 식별 값

응답 상태 코드

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

응답 예시

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

{
    "subAccountId": "dfafe250-****-****-****-246e96591594",
    "loginId": "user000",
    "name": "user000",
    "groups": [
        {
            "groupId": "50b77400-****-****-****-246e96591a38",
            "groupName": "group002",
            "nrn": "nrn:PUB:IAM::*******:Group/50b77400-****-****-****-246e96591a38"
        }
    ],
    "active": true,
    "deleted": false,
    "createTime": "2024-12-10T00:15:34Z",
    "principalType": "IamUser"
}