Locked API仕様(v1)

概要

ベースURLは https:locked.jp/ です。

POST/PUT時の入力および成功時の出力はJSON(application/json)です。

RFCに準拠したJSONを指定してください。

X-LOCKED-API-KEY ヘッダ(必須): 環境毎に生成されるLockedのAPIキーです。

ユーザの認証(ログイン)

POST https://locked.jp/api/v1/client/authenticate

ユーザーのログイン認証を行います。

Request Body

Name	Type	Description
user_id	string	Lockedのシステム上でユーザーを一意に識別する値 （e.g. ユーザーID）
event	string	現在は'$login.attempt'のみ対応
user_ip	string	ログインを試みているユーザーのIPアドレス
user_agent	string	ログインを試みているユーザーのUserAgent
email	string	ログインを試みているユーザーのメールアドレス （メールでユーザーに通知したい場合は必須）
sms	string	ログインを試みているユーザーの電話番号 （SMSでユーザーに通知したい場合は必須）
sms_country_code	string	ログインを試みているユーザーの電話番号の国コード （SMSでユーザーに通知したい場合は必須、また、現在はJPのみ対応）
callback_url	string	ユーザーがログイン承認後にリダイレクトされるページURL
device_uuid	string	ユーザーのCookieに保存されているUUID （key_name: _locked_device_uuid）
fingerprint_hash	string	ユーザーのCookieに保存されているフィンガープリントのハッシュ値 （key_name: _locked_hash）

200 レスポンスに応じて設定してください

認証許可の場合

// 認証が許可されました。エンドユーザーのログインを許可してください。
{
  success: true,
  status: 200,
  data: {
    action: 'allow'
  }
}

再認証

// 確認が必要なログインです。Lockedによる二段階認証を実行しました。エンドユーザーをログインさせず、
// ログイン認証を要求する旨を伝えてください。
{
  success: true,
  status: 200,
  data: {
    action: 'verify'
    verify_token: '256文字の一意な値'
  }
}

不審なリクエスト

// 不審なリクエストです。ログインを拒否してください。
{
  success: true,
  status: 200,
  data: {
    action: 'deny'
  }
}

設定により、すべてのログインに２段階認証を実行することが可能です。

認証の結果はユーザーのログイン履歴、ダッシュボードから設定できるセキュリティレベル等によって決定されます。

レスポンスが再認証の場合、verify_tokenが返ってきます。

長さが256文字で各認証処理毎に一意な値となっており、有効期限付きで管理されています。詳細な扱い方についてはこちらをご覧ください

認証モードが必須です

​カスタム認証の結果送信

PATCH https://locked.jp/api/v1/client/login_verify

再認証の処理をお客様が独自で実装される場合、/client/authenticateの処理の結果、Lockedのシステムが再認証が必要だと判断してもユーザーに対して直接通知を行いません。 お客様のシステム上でユーザーに対して再認証を行っていただいた後、Lockedに対して確認結果を送信し、ユーザーの状況について同期をとるためのエンドポイントです。

Path Parameters

Name	Type	Description
token	string	/client/authenticateで受け取った、verify_token
confirm	string	ユーザーの確認結果。allowまたはdeny
enduser_ip	string	ユーザーのIPアドレス

200

{
  success: true,
  status: 200
}