コンテンツにスキップ

NJS ATKeyのOTP検証

ネームスペースにあるNJS ATKeyのOTP(ワンタイムパスワード)の真偽を検証します。

※ネームスペースは、APIキーのネームスペースになります。

APIキーに必要な権限

NJS ATKey : VERIFY_OTP

メソッド

GET

URL

/v1/njsatkeys/verify

URLパラメータ

パラメータ名 必須 内容
otp 文字列 NJS ATKeyのワンタイムパスワード。

リクエスト例

curl \
  -H "X-DAUTH-API-KEY: <API-KEY>" \
  "https://api.d-auth.com/v1/njsatkeys/verify?otp=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  • <API-KEY> : 使用するAPIキー

レスポンス例

ステータスライン / レスポンスヘッダ

HTTP/1.1 200 OK 
Content-Type:application/json;charset=utf-8 

レスポンスボディ

{
    "status": "OK"
} 

statusの内容は下記のとおりです。

status 内容
OK 正しいOTPです。
REPLAYED_OTP 過去のOTPです。
BAD_OTP 誤ったOTPです。

エラーレスポンス

次の404エラーのときは、API KEYと同じネームスペースにNJS ATKeyが存在していません。 NJS ATKeyがネームスペースに存在するときは、NJS ATKeyの設定が無効になっている可能性があります。

{
  "errors": [{
    "code": "NoResourceError",
    "message": "NJS ATKey '<device_id>' not found."
  }]
}

詳細はこちらをご参照ください。