SSO Userログイン IDのチェック

Classic/VPC環境で利用できます。

SSO Userログイン IDの有効性と重複チェックを行います。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

チェックの結果、使用可能な IDの場合

チェックの結果、使用可能な IDの場合のレスポンスのサンプルコードは次の通りです。

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

チェックの結果、使用できない IDの場合

チェックの結果、使用できない IDの場合のレスポンスのサンプルコードは次の通りです。

• ログイン IDが既に使用されている場合

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

  JSON

  Copy

• ログイン IDが有効でない場合

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

  JSON

  Copy