リクエスト

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

メソッド	URI
GET	/api/v1/join/check-login-id

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`loginId`	String	Required	サブアカウントログイン ID 英字の大文字・小文字、数字、記号。「@ - _」を使用して3~60文字先頭文字は英字の大文字・小文字

リクエスト例

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

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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`success`	Boolean	-	サブアカウントログイン IDのチェック結果 `true` \| `false` `true`: 使用可能な ID `false`: 使用できない ID
`message`	String	-	使用できない理由 `success`が`false`の場合に表示

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

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

レスポンス例

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

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

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

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

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

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

{
    "success": false,
    "message": "英数字、記号の「.」、「@」、「-」、「_」を使用して3~60文字以内で入力してください。先頭文字は英字にします。"
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Sub Account