OATHのOTP検証¶
ネームスペースにあるOATHのOTP(ワンタイムパスワード)の真偽を検証します。
※ネームスペースは、APIキーのネームスペースになります。
APIキーに必要な権限¶
OATH : VERIFY_OTP
メソッド¶
GET
URL¶
/v1/oath/verify
URLパラメータ¶
| パラメータ名 | 必須 | 型 | 内容 |
|---|---|---|---|
| device_id | ● | 文字列 | OATHのデバイスID。 |
| otp | ● | 文字列 | OATHのワンタイムパスワード。 |
リクエスト例¶
curl \
-H "X-DAUTH-API-KEY: <API-KEY>" \
"https://api.d-auth.com/v1/oath/verify?device_id=xxxxxxxxxxxx&otp=123456"
<API-KEY>: 使用するAPIキー
レスポンス例¶
ステータスライン / レスポンスヘッダ¶
HTTP/1.1 200 OK
Content-Type:application/json;charset=utf-8
レスポンスボディ¶
{
"status": "OK"
}
statusの内容は下記のとおりです。
| status | 内容 |
|---|---|
| OK | 正しいOTPです。 |
| BAD_OTP | 誤ったOTPです。 |
エラーレスポンス¶
次の404エラーのときは、API KEYと同じネームスペースにOATHが存在していません。 OATHがネームスペースに存在するときは、OATHの設定が無効になっている可能性があります。
{
"errors": [{
"code": "NoResourceError",
"message":"OATH '<device_id>' not found."
}]
}
詳細はこちらをご参照ください。