Check login ID

Available in Classic and VPC

Check the validity and duplication of the login ID to be used for a sub account.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Sub Account APIs, see Sub Account request headers.

Request query parameters

You can use the following query parameters with your request:

Request example

The request example is as follows:

curl --location --request GET 'https://subaccount.apigw.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'

Response

This section describes the response format.

Response body

The response body includes the following data:

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

Response example

The response example is as follows:

If the check shows that the ID is available

The following is a sample response if the check result is an available ID.

{
    "success": true,
    "message": ""
}

If the check shows that the ID is unavailable

The following is a sample response if the check result is an unavailable ID.

{
    "success": false,
    "message": "English letters, numbers, and special characters ".", "@", "-", and "_" are allowed. Enter a string that begins with an English letter and is between 3 and 60 characters long."
}