Classic/VPC環境で利用できます。
サブアカウントに使用するログインパスワードの有効性と複雑さをチェックします。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /api/v1/join/check-password |
リクエストヘッダ
Sub Account APIで共通して使用されるヘッダの詳細は、Sub Accountのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
password |
String | Required | サブアカウントログインパスワード
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/join/check-password?password=*************' \
--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
}
チェックの結果、使用できないパスワードの場合
チェックの結果、使用できないパスワードの場合のレスポンスのサンプルコードは次の通りです。
{
"success": false,
"message": "安全でないパスワードです。"
}