getLoginAlias

Prev Next

이 가이드는 API 명세를 기반으로 자동 생성했습니다.

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

Ncloud API 표준 규격을 적용한 API입니다.

서브 계정 로그인 URL을 구성하는 데 사용되는 테넌트의 로그인 별칭을 반환. 요청 인증에 사용된 계정을 기준으로 테넌트가 결정됩니다.

요청

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

메서드 URI
GET /login-alias

요청 헤더

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

요청 예시

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

curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v2/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}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
loginAlias String - 서브 계정 로그인 URL을 구성하는 테넌트의 로그인 별칭. 서브 계정은 이 별칭이 포함된 URL로 콘솔에 로그인
  • <예시> mycompany

응답 상태 코드

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

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드 코드 메시지 설명
200 - - 테넌트의 로그인 별칭을 반환
403 Forbidden You do not have sufficient permissions to perform this action. 요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환

응답 예시

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

{
  "loginAlias": "mycompany"
}