MENU
      SubAccount 개요
        • PDF

        SubAccount 개요

        • PDF

        기사 요약

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

        Sub Account는 여러 사용자가 같은 리소스를 이용하고 관리할 수 있는 서브 계정을 제공하는 네이버 클라우드 플랫폼의 서비스입니다. Sub Account 서비스에서는 서브 계정, 그룹, 정책, 역할, External Access 기능에 대한 API를 RESTful 형태로 제공합니다.

        Sub Account 공통 설정

        Sub Account API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

        요청

        공통 요청 형식을 설명합니다.

        API URL

        요청 API URL은 다음과 같습니다.

        서브 계정, 그룹, 정책, 역할: https://subaccount.apigw.ntruss.com
        외부 접근 권한: https://externalaccess.apigw.ntruss.com
        HTTP

        요청 헤더

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

        필드필수 여부설명
        x-ncp-apigw-timestampRequired1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
        • API Gateway 서버와 5분 이상 시간 차 발생 시 유효하지 않은 요청으로 간주
        • Unix Timestamp 형식
        x-ncp-iam-access-keyRequired네이버 클라우드 플랫폼에서 발급받은 Access Key
        x-ncp-apigw-signature-v2Required네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명
        AcceptOptional응답 데이터의 형식
        • application/json
        Content-typeOptional요청 데이터의 형식
        • application/json

        응답

        공통 응답 형식을 설명합니다.

        응답 데이터 타입

        공통 응답 데이터 타입을 설명합니다.

        ProcessResult
        ProcessResult는 API 처리 결과를 정의합니다. ProcessResult에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        successBooleanRequiredAPI 처리 결과
        • true | false
          • true: 성공
          • false: 실패
        idStringOptional생성/수정 결과 아이디
        • 생성, 다중 추가/삭제 API에서 사용
        messageStringOptionalAPI 처리 결과 메시지

        ProcessResult의 구문과 응답 예시는 다음과 같습니다.

        • 구문
          ProcessResult {
            Boolean success;
            String id;
            String message;
          }
          Plain text
        • 예시
          {
            "id": "",
            "success": true
          }
          JSON

        ErrorResponse
        ErrorResponse는 API 호출 실패 시 실패에 대한 내용을 정의합니다. ErrorResponse에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        errorCodeIntegerRequiredRequired
        messageStringRequiredString

        ErrorResponse의 구문과 예시는 다음과 같습니다.

        • 구문
          ErrorResponse {
            int errorCode;
            String message;
          }
          Plain text
        • 예시
          {
            "errorCode": 9011,
            "message": "이미 존재하는 역할명입니다."
          }
          JSON

        응답 상태 코드

        응답 상태 코드에 대한 설명은 다음과 같습니다.

        HTTP 상태 코드코드메시지설명
        200-최대 허용값을 초과하였습니다.최대 허용값 초과
        400120중복된 ID입니다. 다른 ID를 입력해 주세요.중복된 아이디 입력
        40030잘못된 subAccountId입니다.존재하지 않는 서브 계정 아이디 입력
        40030잘못된 groupNo 입니다.존재하지 않는 그룹 아이디 입력
        400400Request format is not json입력 값 형식 오류
        400400sessionExpirationDays is required, Request format is not json파라미터 입력 오류
        400400접근 제한 IP 대역 수는 최대 100개 입니다.가능한 IP 대역 수 초과
        • 콘솔 접근 제한 IP 대역 수는 최대 100개
        400400역할 명을 입력 해 주세요 : [roleName]역할 이름 누락
        • 3~100자로 입력
        400400역할 명은 3~100자 사이로 입력 해 주세요. : [roleName]역할 이름 글자 수 오류
        400400역할 타입을 지정 해 주세요 : [roleType]역할 타입 입력 오류
        • 역할 타입 지정
        400400역할 타입이 잘못 되었습니다.역할 타입 입력 오류
        • 허용된 역할 타입 지정
        400400isMyAccount가 누락 되었습니다. : [isMyAccount]isMyAccount 파라미터 누락
        4009001계정이름을 입력해주세요.계정 이름 누락 또는 오류
        4009001로그인ID를 입력해주세요.로그인 아이디 입력 필요
        4009002역할 타입이 Server일 때 미사용 세션 만료 시간은 허용되지 않습니다.파라미터 입력 오류
        • 세션 만료 시간을 지정할 수 없는 역할 타입
        4009002세션 만료 시간은 [600, 1800, 3600, 10800] 초 만 설정할 수 있습니다.세션 만료 시간 입력 오류
        4009010문자, 숫자, 특수 문자 ., _, -를 허용하며, 문자로 시작하는 문자열을 3자~100자 이내로 입력해 주십시오.입력값 오류
        • 3~100자로 영문자, 숫자, 특수문자 사용
        4009010영문 소문자, 숫자를 허용하며, 3자~20자 이내로 입력해 주십시오.URL 형식 오류
        • 3~20자로 영문 소문자, 숫자 허용
        4009011이미 존재하는 역할명입니다.이미 사용 중인 역할 이름 입력
        4009015안전하지 않은 비밀번호입니다.사용할 수 없는 비밀번호 입력
        400904유효하지 않은 API Key입니다.존재하지 않는 Access Key 입력
        40130잘못된 subAccountId입니다.존재하지 않는 서브 계정 아이디 입력
        40430잘못된 idNo입니다.존재하지 않는 서브 계정 아이디 입력
        40430잘못된 roleNo입니다.존재하지 않는 역할 아이디 입력
        404404등록되지 않은 정책입니다.존재하지 않는 정책 아이디 입력
        404910역할에 맞지 않는 엔티티가 있습니다.역할 유형에 맞지 않는 적용 대상 존재
        4099012대상 Role에 등록 가능한 엔티티 갯수를 초과하였습니다.역할 적용 대상의 허용 개수 초과
        4099012최대 허용값을 초과하였습니다.최대 허용값 초과
        500500Internal Server Error내부 서버 오류
        참고

        네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

        Sub Account API

        Sub Account 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

        서브 계정

        서브 계정 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        서브 계정 목록 조회서브 계정 목록 조회
        서브 계정 조회서브 계정 단건 상세 조회
        서브 계정 생성서브 계정 생성
        서브 계정 수정서브 계정 정보 수정
        서브 계정 삭제서브 계정 삭제
        Access Key 조회서브 계정 Access Key 조회
        Access Key 생성서브 계정 Access Key 생성
        Access Key 삭제서브 계정 Access Key 삭제
        Access Key 상태 설정서브 계정 Access Key 활성화 또는 비활성화 설정
        로그인 접속키 조회서브 계정 로그인 주소에 사용되는 로그인 접속키 조회
        로그인 접속키 설정서브 계정 로그인 주소에 사용되는 로그인 접속키 설정
        로그인 아이디 체크서브 계정 로그인 아이디 유효성 및 중복 여부 확인
        로그인 비밀번호 체크서브 계정 로그인 비밀번호 유효성 및 복잡도 확인
        유휴 세션 만료 시간 조회서브 계정 유휴 세션 만료 시간 조회
        유휴 세션 만료 시간 설정서브 계정 유휴 세션 만료 시간 설정
        로그인 비밀번호 만료일 조회서브 계정 로그인 비밀번호 만료일(변경 주기) 조회
        로그인 비밀번호 만료일 설정서브 계정 로그인 비밀번호 만료일(변경 주기) 설정
        로그인 비밀번호 재설정서브 계정 로그인 비밀번호 수정
        정책 할당서브 계정에 정책 할당
        정책 삭제서브 계정에 할당된 정책 삭제
        그룹 추가서브 계정을 그룹에 추가
        그룹 삭제서브 계정을 그룹에서 삭제
        콘솔 접근 규칙 조회서브 계정 콘솔 접근 규칙 조회
        콘솔 접근 규칙 수정서브 계정 콘솔 접근 규칙 수정
        API 접근 규칙 조회서브 계정 API 접근 규칙 조회
        API 접근 규칙 수정서브 계정 API 접근 규칙 수정
        2차 인증 정보 조회서브 계정 2차 인증 정보 조회
        태그 조회서브 계정에 추가된 태그 조회
        태그 추가서브 계정에 태그 추가
        태그 삭제서브 계정에 추가된 태그 삭제
        사용자 정보 조회권한이 부여된 서브 계정 사용자 정보 조회
        사용자 아이디 조회서브 계정 아이디 조회

        그룹

        그룹 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        그룹 목록 조회그룹 목록 조회
        그룹 조회그룹 단건 상세 조회
        그룹 생성그룹 생성
        그룹 수정그룹 정보 수정
        그룹 삭제그룹 삭제
        서브 계정 추가그룹에 서브 계정 추가
        서브 계정 삭제그룹에서 서브 계정 삭제
        정책 할당그룹에 정책 할당
        정책 삭제그룹에 할당된 정책 삭제
        태그 조회그룹에 추가된 태그 조회
        태그 추가그룹에 태그 추가
        태그 삭제그룹에 추가된 태그 삭제

        정책

        정책 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        정책 목록 조회정책 목록 조회
        정책 조회정책 단건 상세 조회
        정책 유효성 확인사용자 정의 정책(User Created) 유효성 확인
        정책 생성사용자 정의 정책(User Created) 생성
        정책 수정사용자 정의 정책(User Created) 정보 수정
        정책 목록 삭제2개 이상의 사용자 정의 정책(User Created) 일괄 삭제
        정책 삭제사용자 정의 정책(User Created) 삭제
        정책 할당 리소스 조회정책 할당 리소스(서브 계정, 그룹, 역할) 조회
        태그 조회사용자 정의 정책(User Created)에 추가된 태그 조회
        태그 추가사용자 정의 정책(User Created)에 태그 추가
        태그 삭제사용자 정의 정책(User Created)에 추가된 태그 삭제

        역할

        역할 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        역할 목록 조회역할 목록 조회
        역할 조회역할 단건 상세 조회
        역할 생성역할 생성
        역할 수정역할 정보 수정
        역할 삭제역할 삭제
        정책 할당역할에 정책 할당
        정책 삭제역할에 할당된 정책 삭제
        역할(Account) 적용 대상 조회Account 역할 적용 대상 조회
        역할(Account) 적용 대상 추가Account 역할 적용 대상 추가
        역할(Account) 적용 대상 삭제Account 역할 적용 대상 삭제
        역할(Server, Service) 적용 대상 추가Server, Service 역할 적용 대상 추가
        역할(Server, Service) 적용 대상 삭제Server, Service 역할 적용 대상 삭제
        역할 목록 상태 설정2개 이상의 역할 활성화 또는 비활성화 일괄 설정
        역할 상태 설정역할 활성화 또는 비활성화 설정
        태그 조회역할에 추가된 태그 조회
        태그 추가역할에 태그 추가
        태그 삭제역할에 추가된 태그 삭제
        전환 가능 역할 조회서브 계정에서 전환 가능한 역할 조회
        전환 가능 역할 등록서브 계정에서 전환 가능한 역할 등록
        전환 가능 역할 수정서브 계정에서 전환 가능한 역할 정보 수정
        전환 가능 역할 삭제서브 계정에서 전환 가능한 역할 삭제

        External Access

        External Access 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        Trust Anchor 목록 조회Trust Anchor 목록 조회
        Trust Anchor 조회Trust Anchor 단건 상세 조회
        Trust Anchor 생성Trust Anchor 생성
        Trust Anchor 수정Trust Anchor 정보 수정
        Trust Anchor 활성화Trust Anchor 상태 활성화 설정
        Trust Anchor 비활성화Trust Anchor 상태 비활성화 설정
        Trust Anchor 삭제Trust Anchor 삭제
        Profile 목록 조회Profile 목록 조회
        Profile 조회Profile 단건 상세 조회
        Profile 생성Profile 생성
        Profile 수정Profile 정보 수정
        Profile 활성화Profile 상태 활성화 설정
        Profile 비활성화Profile 상태 비활성화 설정
        Profile 삭제Profile 삭제
        Subject 목록 조회Subject 목록 조회
        Subject 조회Subject 단건 상세 조회
        Subject Activity 목록 조회Subject Activity 목록(동일 Subject를 가진 인증서 상세 사용 이력) 조회
        CRL 목록 조회CRL(인증서 폐기 목록) 목록 조회
        CRL 조회CRL(인증서 폐기 목록) 단건 상세 조회
        CRL 생성CRL(인증서 폐기 목록) 생성
        CRL 수정CRL(인증서 폐기 목록) 정보 수정
        CRL 활성화CRL(인증서 폐기 목록) 상태 활성화 설정
        CRL 비활성화CRL(인증서 폐기 목록) 상태 비활성화 설정
        CRL 삭제CRL(인증서 폐기 목록) 삭제

        Sub Account 연관 리소스

        Sub Account API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.


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

        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.