Skip to main content

​
Endpoint

POST /passkey/register サインアップ時に新規ユーザーのパスキー登録を開始します。このエンドポイントはパスキー登録セッションを作成し、指定されたユーザープロファイルをデータベース接続のサインアップ属性に照らして検証したうえで、アプリケーションからプラットフォーム認証器に渡すWebAuthnの作成パラメータを返します。認証器からアテステーションが返された後、パスキーグラントを使用して/oauth/tokenでアサーションを交換することで、登録を完了します。

​
注記

  • アプリケーションのグラントタイプに、urn:okta:params:oauth:grant-type:webauthn が含まれている必要があります。
  • アプリケーションはファーストパーティアプリケーションである必要があります。サードパーティアプリケーションによるこのエンドポイントの呼び出しは許可されていません。
  • アプリケーションは OIDC 準拠である必要があります。
  • リクエストは、テナント用に構成されたカスタムドメインに対して行う必要があります。デフォルトの Auth0 ドメイン ({tenant}.auth0.com) への呼び出しは拒否されます。
  • user_profile には、接続でサインアップ時に required とマークされているすべての識別子 (通常は email、phone_number、または username) を含める必要があります。追加の識別子は optional にできます。
  • ユーザーは、構成されているいずれかの識別子によって既存ユーザーとして判定されます。送信された識別子のいずれかが既存のユーザーに一致した場合、リクエストは invalid_request で失敗します。

​
リクエスト本文

​
string
必須
アプリケーションの client_id。
​
string
アプリケーションの client_secret。client_secret_post トークンエンドポイント認証方式を使用する機密アプリケーションでは必須です。
​
string
ユーザーがサインアップするデータベース接続の名前。省略した場合、Auth0 はそのアプリケーションに対してテナントのデフォルトのデータベース接続を使用します。
​
string
ユーザーがサインインするAuth0 Organizationの ID。アプリケーションの organization_usage が require に設定されている場合は必須です。
​
object
必須
新規ユーザーのプロファイル属性。プロパティは、データベース接続で設定されたサインアップ属性 (required および optional) と一致している必要があります。認識されないプロパティが含まれている場合、リクエストは invalid_request で失敗します。
​
object
新規ユーザーに付加する任意のユーザーメタデータ。文字列フィールドは最大10個です。

​
レスポンス

成功時のレスポンスには、WebAuthn の作成パラメータと、後続のアテステーションをこの登録リクエストに紐付ける auth_session 値が含まれます。
​
string
不透明なセッション識別子。パスキー登録を完了するトークン交換リクエストで渡します。
​
object
プラットフォーム認証器で呼び出す WebAuthn PublicKeyCredentialCreationOptions。