Classic/VPC 환경에서 이용 가능합니다.
서브 계정에 사용할 로그인 아이디의 유효성 및 중복 여부를 체크합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /api/v1/join/check-login-id |
요청 헤더
Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
loginId |
String | Required | 서브 계정 로그인 아이디
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v1/join/check-login-id?loginId=subaccount' \
--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'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success |
Boolean | - | 서브 계정 로그인 아이디 체크 결과
|
message |
String | - | 사용 불가능 이유
|
응답 상태 코드
Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
체크 결과 사용 가능 아이디인 경우
체크 결과 사용 가능 아이디인 경우의 응답 예시는 다음과 같습니다.
{
"success": true,
"message": ""
}
체크 결과 사용 불가능 아이디인 경우
체크 결과 사용 불가능 아이디인 경우의 응답 예시는 다음과 같습니다.
{
"success": false,
"message": "영문자, 숫자, 특수 문자 '.', '@', '-', '_'를 허용하며, 영문자로 시작하는 문자열을 3자~60자 이내로 입력해 주십시오."
}