MENU
      서브 계정 생성

        서브 계정 생성


        기사 요약

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

        서브 계정을 생성합니다. 서브 계정을 생성하면 계정별 권한 설정이 가능하여 안전하고 안정적으로 서비스를 운영할 수 있습니다.

        참고

        서브 계정은 최대 500개까지 생성할 수 있습니다.

        요청

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

        메서드URI
        POST/api/v1/sub-accounts

        요청 헤더

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

        요청 바디

        요청 바디에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        activeBooleanRequired서브 계정 상태
        • true | false
          • true: 활성화
          • false: 비활성화
        apiAllowSourcesArrayOptional서브 계정의 API 접근 가능 소스 목록
        canAPIGatewayAccessBooleanRequired서브 계정의 API Gateway 접근 가능 여부
        • Access Key를 생성하여 API Gateway에 등록된 API 사용 가능 여부
        • true | false
          • true: 가능
          • false: 불가
        canConsoleAccessBooleanRequired서브 계정의 콘솔 접근 가능 여부
        • true | false
          • true: 가능
          • false: 불가
        consolePermitIpsArrayOptional서브 계정의 콘솔 접근 가능 IP 대역 목록
        emailStringOptional서브 계정 사용자 메일 주소
        • 6~100자
        isMfaMandatoryBooleanOptional서브 계정의 2차 인증 필수 여부
        • true | false (기본값)
          • true: 필수
          • false: 선택
        loginIdStringRequired서브 계정 로그인 아이디
        memoStringOptional서브 계정에 대한 설명(Bytes)
        • 0~300
        nameStringRequired서브 계정 사용자 이름
        • 2~30자
        needPasswordGenerateBooleanOptional서브 계정 로그인 비밀번호 생성 방식
        • true | false (기본값)
          • true: 자동 생성
          • false: 직접 입력
        needPasswordResetBooleanRequired서브 계정 로그인 비밀번호 재설정 알림 여부
        • 서브 계정으로 최초 로그인 시 비밀번호 변경 안내 여부
        • true | false
          • true: 알림
          • false: 알림 안 함
        passwordStringConditional서브 계정 로그인 비밀번호
        • needPasswordGeneratefalse인 경우 반드시 입력
        • 영어 대소문자, 숫자, 특수문자를 조합하여 8~16자
        • 로그인 비밀번호 체크를 통해 비밀번호 유효성 확인 가능
        useApiAllowSourceBooleanOptional서브 계정의 API 접근 가능 소스 제한 여부
        • true | false
          • true: 지정한 소스에서만 접근 가능
          • false: 모든 소스에서 접근 가능
        useConsolePermitIpBooleanOptional서브 계정의 콘솔 접근 가능 IP 대역 제한 여부
        • true | false
          • true: 지정한 IP 대역에서만 접근 가능
          • false: 모든 곳에서 접근 가능

        apiAllowSources

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

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

        요청 예시

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

        curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts' \
        --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' \
        --header 'Content-Type: application/json' \
        --data '{
            "active": true,
            "apiAllowSources": [
                {
                    "type": "IP",
                    "source": "***.***.***.***"
                }
            ],
            "canAPIGatewayAccess": true,
            "canConsoleAccess": true,
            "consolePermitIps": [
                "***.***.***.***"
            ],
            "email": "email@ncloud.com",
            "isMfaMandatory": false,
            "loginId": "testuser33",
            "memo": "testuser account",
            "name": "userts3",
            "needPasswordGenerate": true,
            "needPasswordReset": true,
            "useApiAllowSource": true,
            "useConsolePermitIp": true
        }'
        Shell

        응답

        응답 형식을 설명합니다.

        응답 바디

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

        필드타입필수 여부설명
        idString-서브 계정 아이디
        successBoolean-API 호출 성공 여부
        • true | false
          • true: 성공
          • false: 실패
        generatedPasswordString-서브 계정 비밀번호
        • needPasswordGeneratetrue인 경우 표시

        응답 상태 코드

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

        응답 예시

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

        {
          "id": "e60b75d0-****-****-****-***********",
          "success": true,
          "generatedPassword": "*****************"
        }
        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.