로그인 접속키 설정

Prev Next

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

서브 계정 로그인 접속키를 설정합니다.

참고

서브 계정 로그인 접속키는 다음과 같이 서브 계정 로그인 주소에 사용됩니다.

  • https://www.ncloud.com/nsa/{loginAlias}

요청

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

메서드 URI
PUT /api/v1/login-alias

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
loginAlias String Required 서브 계정 로그인 접속키
  • 영어 소문자, 숫자를 사용하여 3~20자

요청 예시

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

curl --location --request PUT 'https://subaccount.apigw.gov-ntruss.com/api/v1/login-alias' \
--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 '{
    "loginAlias": "test123123"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
success Boolean - API 호출 성공 여부
  • true | false
    • true: 성공
    • false: 실패

응답 상태 코드

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

응답 예시

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

{
    "success": true
}