MENU
      서브 계정 조회

        서브 계정 조회


        기사 요약

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

        서브 계정의 상세 정보를 조회합니다.

        요청

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

        메서드URI
        GET/api/v1/sub-accounts/{subAccountId}

        요청 헤더

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

        요청 경로 파라미터

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

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

        요청 예시

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

        curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/89b556d0-****-****-****-***********' \
        --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'
        Shell

        응답

        응답 형식을 설명합니다.

        응답 바디

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

        필드타입필수 여부설명
        subAccountIdString-서브 계정 아이디
        subAccountNoInteger-서브 계정 번호
        loginIdString-서브 계정 로그인 아이디
        nameString-서브 계정 사용자 이름
        emailString-서브 계정 사용자 메일 주소
        needPasswordResetBoolean-서브 계정 로그인 비밀번호 재설정 알림 여부
        • 서브 계정으로 최초 로그인 시 비밀번호 변경 안내 여부
        • true | false
          • true: 알림
          • false: 알림 안 함
        canAPIGatewayAccessBoolean-서브 계정의 API Gateway 접근 가능 여부
        • Access Key를 생성하여 API Gateway에 등록된 API 사용 가능 여부
        • true | false
          • true: 가능
          • false: 불가
        canConsoleAccessBoolean-서브 계정의 콘솔 접근 가능 여부
        • true | false
          • true: 가능
          • false: 불가
        useConsolePermitIpBoolean-서브 계정의 콘솔 접근 가능 IP 대역 제한 여부
        • true | false
          • true: 지정한 IP 대역에서만 접근 가능
          • false: 모든 곳에서 접근 가능
        consolePermitIpsArray-서브 계정의 콘솔 접근 가능 IP 대역 목록
        useApiAllowSourceBoolean-서브 계정의 API 접근 가능 소스 제한 여부
        • true | false
          • true: 지정한 소스에서만 접근 가능
          • false: 모든 소스에서 접근 가능
        apiAllowSourcesArray-서브 계정의 API 접근 가능 소스 목록
        lastLoginTimeString-서브 계정 마지막 로그인 일시
        • ISO 8601 형식
        createTimeString-서브 계정 생성 일시
        • ISO 8601 형식
        memoString-서브 계정에 대한 설명
        activeBoolean-서브 계정 상태
        • true | false
          • true: 활성화
          • false: 비활성화
        modifiedTimeString-서브 계정 마지막 수정 일시
        • ISO 8601 형식
        groupsArray-그룹 정보
        policiesArray-정책 정보
        nrnString-서브 계정에 대한 네이버 클라우드 플랫폼 리소스 식별 값

        apiAllowSources

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

        필드타입필수 여부설명
        typeString-접근 소스 유형
        • IP | VPC | VPC_SERVER
          • IP: 서버 단일 IP 또는 서브넷을 포함한 IP 대역
          • VPC: 사용 중인 VPC
          • VPC_SERVER: 사용 중인 VPC 환경의 서버
        sourceString-접근 소스 정보
        • IP 주소 또는 인스턴스 번호

        groups

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

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

        policies

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

        필드타입필수 여부설명
        policyIdString-정책 아이디
        policyNameString-정책 이름
        policyTypeString-정책 유형
        • SYSTEM_MANAGED | USER_CREATED
          • SYSTEM_MANAGED: 관리형 정책
          • USER_CREATED: 사용자 정의 정책
        policyDescString-정책에 대한 설명
        nrnString-정책에 대한 네이버 클라우드 플랫폼 리소스 식별 값

        응답 상태 코드

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

        응답 예시

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

        {
            "subAccountId": "89b556d0-****-****-****-***********",
            "subAccountNo": 16***,
            "loginId": "h***",
            "name": "h***",
            "email": "l*****@*******.com",
            "needPasswordReset": false,
            "canAPIGatewayAccess": true,
            "canConsoleAccess": true,
            "useConsolePermitIp": true,
            "consolePermitIps": [
                "***.***.***.***"
            ],
            "useApiAllowSource": true,
            "apiAllowSources": [
                {
                    "type": "IP",
                    "source": "***.***.***.***"
                }
            ],
            "lastLoginTime": "2025-01-01T23:48:07Z",
            "createTime": "2024-09-30T04:57:47Z",
            "memo": "",
            "active": true,
            "modifiedTime": "2024-12-23T06:28:14Z",
            "groups": [
                {
                    "groupId": "040164b0-****-****-****-***********",
                    "groupName": "mygrp",
                    "nrn": "nrn:PUB:IAM::5*****8:Group/040164b0-****-****-****-***********"
                }
            ],
            "policies": [
                {
                    "policyId": "24f1aa30-****-****-****-***********",
                    "policyName": "NCP_ADMINISTRATOR",
                    "policyType": "SYSTEM_MANAGED",
                    "policyDesc": "포털, 콘솔에 접근할 수 있는 권한이 메인 계정과 동일한 권한",
                    "nrn": "nrn:PUB:IAM:::Policy/24f1aa30-****-****-****-***********"
                }
            ],
            "nrn": "nrn:PUB:IAM::5*****8:SubAccount/89b556d0-****-****-****-***********"
        }
        JSON

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.