Check SSO user login ID

Available in Classic and VPC

Check the validity and duplication of an SSO user login ID.

Request

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

Request headers

For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On 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://sso.apigw.ntruss.com/api/v1/users/check-login-id?loginId=******%40ncloud.com' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Response status codes

For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response 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.

{
    "name": "******@ncloud.com",
    "success": true
}

If the check shows that the ID is unavailable

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

• If the login ID is already in use

  {
      "name": "******@ncloud.com",
      "success": false,
      "message": "Duplicate login ID."
  }
  

• If the login ID is invalid

  {
      "name": "userid",
      "success": false,
      "message": "Invalid login ID."
  }