Passage by 1Password - Auth (独立系発行者) (プレビュー)
Passage は、1Password の 17 年以上にわたる業界をリードするセキュリティの専門知識によって支えられています。 既存の認証フローを完全に置き換えるか、パスワードレス認証と顧客 ID 管理のための堅牢なソリューションを最初から構築します。 パスキー、マジック リンク、ログイン コードを活用したログイン フローを実装することで、パスワードを排除することによるセキュリティ、ビジネス、ユーザー エクスペリエンスの完全なメリットを実現します。
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Troy Taylor |
[URL] | https://www.hitachisolutions.com |
メール | ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
発行者 | Troy Taylor |
Web サイト | https://passage.1password.com/ |
プライバシー ポリシー | https://storage.googleapis.com/passage-docs/passage-privacy-policy.pdf |
カテゴリ | セキュリティ |
接続の作成
コネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | Description | Required |
---|---|---|---|
API キー ('Bearer YOUR_API_KEY' の形式) | securestring | この API に対する API キー ('Bearer YOUR_API_KEY' の形式) | True |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
JWKS を取得する |
アプリの JWKS を取得します。 JWT 内の KID を使用して適切な JWK を照合し、JWK の公開キーを使用して JWT を検証できます。 |
OAuth2 を認証トークンに交換します |
OAuth2 接続データを認証トークンと交換します。 |
OAuth2 コールバックを処理する |
OAuth2 フロー コールバックを処理します。 |
OAuth2 フローの開始 |
https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest で説明されている接続プロバイダー要求パラメータを使用して OAuth2 フローを開始します |
OpenID の構成を取得 |
アプリの OpenID 構成を取得します。 |
OTP でログイン |
ユーザーにログイン メールまたは SMS を送信します。 ユーザーには、ログインを完了するためのワンタイム パスコードが記載された電子メールまたはテキストが送信されます。 |
OTP で登録する |
ユーザーを作成し、登録メールまたは SMS をユーザーに送信します。 ユーザーには、登録を完了するためのワンタイム パスコードが記載された電子メールまたはテキストが送信されます。 |
Web |
現在のユーザーの WebAuthn デバイス追加操作を完了します。 ユーザーはベアラー トークンを介して認証される必要があります。 |
Web |
現在のユーザーの WebAuthn デバイス追加操作を開始します。 この エンドポイント は、ブラウザから登録儀式を実行するために使用される WebAuthn 認証情報作成チャレンジを作成します。 ユーザーはベアラー トークンを介して認証される必要があります。 |
Web |
WebAuthn ログインを完了し、ユーザーを認証します。 |
Web |
ユーザーの WebAuthn ログインを開始します。 このエンドポイントは、ブラウザからログイン セレモニーを実行するために使用される WebAuthn 資格証明アサーションのチャレンジを作成します。 |
Web |
WebAuthn 登録を完了し、ユーザーを認証します。 |
Web |
WebAuthn 登録を開始し、ユーザーを作成します。 この エンドポイント は、ブラウザから登録儀式を実行するために使用される WebAuthn 認証情報作成チャレンジを作成します。 |
アカウントと接続のリンク |
既存のアカウントを OAuth2 接続にリンクします。 |
アプリの入手 |
アプリケーションに関する情報を取得します。 |
ソーシャルの接続の削除 |
現在のユーザーのソーシャル接続を削除します。 ユーザーはベアラー トークンを介して認証される必要があります。 |
ソーシャル接続の取得 |
現在のユーザーのソーシャル接続を取得します。 ユーザーはベアラー トークンを介して認証される必要があります。 |
デバイスの取り消し |
現在のユーザーの ID に基づいてデバイスを取り消します。 ユーザーはベアラー トークンを介して認証される必要があります。 |
デバイスを一覧表示 |
認証されたユーザーのすべての WebAuthn デバイスのリストを取得します。 ユーザーはベアラー トークンを介して認証される必要があります。 |
デバイスを更新する |
現在のユーザーの ID に基づいてデバイスを更新します。 現在、更新できる唯一のフィールドはフレンドリ名です。 ユーザーはベアラー トークンを介して認証される必要があります。 |
マジック リンクでログイン |
ユーザーにログイン メールまたは SMS を送信します。 ユーザーは、ログインを完了するためのリンクが記載された電子メールまたはテキストメッセージを受け取ります。 |
マジック リンクで登録 |
ユーザーを作成し、登録メールまたは SMS をユーザーに送信します。 ユーザーは、登録を完了するためのリンクが記載された電子メールまたはテキストメッセージを受け取ります。 |
マジック リンクの状態 |
マジック リンクが有効化されているかどうかを確認します。 マジック リンクが有効化されると、このエンド ポイントはユーザー用の認証トークンを返します。 この エンドポイント を使用すると、あるデバイスでログインを開始し、別のデバイスでポーリングしてログインが完了するのを待機することができます。 |
マジック リンクを認証する |
ユーザーのマジック リンクを認証します。 この エンドポイント は、マジック リンクが有効であることを確認し、ユーザーの認証トークンを返します。 |
ユーザーを作成 |
ユーザーを作成します。 |
ユーザーを取得する |
ユーザーが存在する場合は、ユーザー情報を取得します。 この エンドポイント を使用すると、ユーザーが既存のアカウントを持っているかどうか、ログインする必要があるか登録する必要があるかを判断できます。 |
ユーザー写真のメタデータを取得する |
現在のユーザーのユーザー メタデータを取得します。 |
ユーザー写真のメタデータを更新する |
現在のユーザーのメタデータを更新します。 有効なメタデータ フィールドのみが受け入れられます。 無効なメタデータ フィールドが存在すると、更新が中止されます。 ユーザーはベアラー トークンを介して認証される必要があります。 |
新しい認証を作成してトークンを更新する |
新しい認証トークンと新しい更新トークンを作成して返します。 |
更新トークンの取り消し |
更新トークン取り消します。 |
現在のユーザーを取得 |
現在ベアラー トークンを介して認証されているユーザーに関する情報を取得します。 |
認証 OTP |
ユーザーのワンタイム パスコードを認証します。 この エンドポイント は、ワンタイム パスコードが有効であることを確認し、ユーザーの認証トークンを返します。 |
電子メールの変更 |
認証されたユーザーの電子メールの変更を開始します。 電子メールの変更には検証が必要であるため、電子メールの変更が有効になる前に確認する必要がある電子メールがユーザーに送信されます。 |
電話の変更 |
認証ユーザーの電話番号変更を開始します。 電話番号の変更には認証が必要なため、リンク付きの SMS がユーザーに送信され、ユーザーは電話番号の変更が有効になる前に認証を行う必要があります。 |
JWKS を取得する
アプリの JWKS を取得します。 JWT 内の KID を使用して適切な JWK を照合し、JWK の公開キーを使用して JWT を検証できます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
戻り値
- Body
- JWKResponse
OAuth2 を認証トークンに交換します
OAuth2 接続データを認証トークンと交換します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
OAuth2 コード
|
code | True | string |
OAuth2 リダイレクトから得られるコードです。 |
検証者
|
verifier | True | string |
クライアントが最初に OAuth2 プロバイダーに送信した検証子。 |
戻り値
- Body
- AuthResponse
OAuth2 コールバックを処理する
OAuth2 フロー コールバックを処理します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
OAuth2 コード
|
code | True | string |
OAuth2 プロバイダーによって返された認証コードです。 |
状態
|
state | string |
OAuth2 プロバイダーによって返された状態です。 |
|
Error
|
error | string |
OAuth2 プロバイダーによって返されたエラーです。 |
|
Error
|
error_description | string |
OAuth2 プロバイダーによって返された説明です。 |
戻り値
OAuth2 フローの開始
https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest で説明されている接続プロバイダー要求パラメータを使用して OAuth2 フローを開始します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
リダイレクト URI
|
redirect_uri | True | string |
OAuth2 フローの完了後にリダイレクトされる URL です。 |
状態
|
state | string |
リダイレクト URI に渡される状態です。 |
|
コード チャレンジ
|
code_challenge | True | string |
コード チャレンジです。 |
コード チャレンジ方式
|
code_challenge_method | True | string |
コード チャレンジの方式です。 |
接続の種類
|
connection_type | True | string |
接続タイプ; google、github、apple、またはログインに使用するパッセージ。 |
戻り値
OpenID の構成を取得
アプリの OpenID 構成を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
戻り値
- Body
- OpenIdConfiguration
OTP でログイン
ユーザーにログイン メールまたは SMS を送信します。 ユーザーには、ログインを完了するためのワンタイム パスコードが記載された電子メールまたはテキストが送信されます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ID
|
identifier | True | string |
有効なメールアドレスまたは E164 の電話番号です。 |
Language
|
language | string |
送信する電子メールの言語 (オプション) です。 |
戻り値
OTP で登録する
ユーザーを作成し、登録メールまたは SMS をユーザーに送信します。 ユーザーには、登録を完了するためのワンタイム パスコードが記載された電子メールまたはテキストが送信されます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ID
|
identifier | True | string |
有効なメールアドレスまたは E164 の電話番号です。 |
Language
|
language | string |
送信する電子メールの言語 (オプション) です。 |
戻り値
WebAuthn デバイスの追加を完了する
現在のユーザーの WebAuthn デバイス追加操作を完了します。 ユーザーはベアラー トークンを介して認証される必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ハンドシェイク ID
|
handshake_id | True | string |
ハンドシェイクの識別子です。 |
認証子の添付ファイル
|
authenticatorAttachment | string |
認証子の添付ファイルです。 |
|
ID
|
id | string |
資格情報の識別子です。 識別子の要件は、資格情報の種類ごとに異なります。 たとえば、ユーザー名とパスワードのタプルのユーザー名を表す場合があります。 |
|
生 ID
|
rawId | string |
生の識別子です。 |
|
構成証明オブジェクト
|
attestationObject | string |
構成証明オブジェクトは attestationObject のバイト スライス バージョンです。 この属性には、クライアントに対して不透明であり、クライアントによる改ざんから暗号的に保護されている証明書オブジェクトが含まれています。 構成証明オブジェクトには、認証データと構成証明ステートメントの両方が含まれます。 前者には、AAGUID、一意の資格情報 ID、および資格情報の公開キーが含まれています。 構成証明ステートメントの内容は、認証者が使用する構成証明ステートメントの形式によって決まります。 また、証明書利用者のサーバーが構成証明ステートメントを検証するため、および認証データと JSON シリアル化されたクライアント データをデコードして検証するために必要な追加情報も含まれます。 |
|
クライアント データ JSON
|
clientDataJSON | string |
この属性には、create() または get() の呼び出しでクライアントによって認証システムに渡されるクライアント データの JSON シリアル化が含まれます。 |
|
転送
|
transports | array of string |
転送です。 |
|
転送
|
transports | array of string |
転送です。 |
|
タイプ
|
type | string |
オブジェクトのインターフェイス オブジェクトの [[type]] slot の値です。このオブジェクトによって表される資格情報の種類を指定します。 これは、Webauthn 資格情報のタイプ「公開キー」である必要があります。 |
|
User ID
|
user_id | True | string |
ユーザー識別子。 |
戻り値
- Body
- CurrentUserDevice
WebAuthn デバイスの追加を開始する
現在のユーザーの WebAuthn デバイス追加操作を開始します。 この エンドポイント は、ブラウザから登録儀式を実行するために使用される WebAuthn 認証情報作成チャレンジを作成します。 ユーザーはベアラー トークンを介して認証される必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
認証子の添付ファイル
|
authenticator_attachment | string |
この WebAuthN フロー リクエストで使用される認証のタイプを選択します。 |
戻り値
WebAuthn ログインを完了する
WebAuthn ログインを完了し、ユーザーを認証します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ハンドシェイク ID
|
handshake_id | True | string |
ハンドシェイクの識別子です。 |
認証子の添付ファイル
|
authenticatorAttachment | string |
認証子の添付ファイルです。 |
|
ID
|
id | string |
資格情報の識別子です。 識別子の要件は、資格情報の種類ごとに異なります。 たとえば、ユーザー名とパスワードのタプルのユーザー名を表す場合があります。 |
|
生 ID
|
rawId | string |
生の識別子です。 |
|
Authenticator データ
|
authenticatorData | string |
Authenticator データです。 |
|
クライアント データ JSON
|
clientDataJSON | string |
この属性には、create() または get() の呼び出しでクライアントによって認証システムに渡されるクライアント データの JSON シリアル化が含まれます。 |
|
署名
|
signature | string |
署名です。 |
|
User
|
userHandle | string |
ユーザーのハンドルです。 |
|
タイプ
|
type | string |
オブジェクトのインターフェイス オブジェクトの [[type]] slot の値です。このオブジェクトによって表される資格情報の種類を指定します。 これは、Webauthn 資格情報のタイプ「公開キー」である必要があります。 |
|
User ID
|
user_id | string |
ユーザー識別子。 |
戻り値
- Body
- AuthResponse
WebAuthn ログインを開始する
ユーザーの WebAuthn ログインを開始します。 このエンドポイントは、ブラウザからログイン セレモニーを実行するために使用される WebAuthn 資格証明アサーションのチャレンジを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ID
|
identifier | string |
有効なメールアドレスまたは E164 の電話番号です。 |
戻り値
WebAuthn 登録の完了
WebAuthn 登録を完了し、ユーザーを認証します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ハンドシェイク ID
|
handshake_id | True | string |
ハンドシェイクの識別子です。 |
認証子の添付ファイル
|
authenticatorAttachment | string |
認証子の添付ファイルです。 |
|
ID
|
id | string |
資格情報の識別子です。 識別子の要件は、資格情報の種類ごとに異なります。 たとえば、ユーザー名とパスワードのタプルのユーザー名を表す場合があります。 |
|
生 ID
|
rawId | string |
生の識別子です。 |
|
構成証明オブジェクト
|
attestationObject | string |
構成証明オブジェクトは attestationObject のバイト スライス バージョンです。 この属性には、クライアントに対して不透明であり、クライアントによる改ざんから暗号的に保護されている証明書オブジェクトが含まれています。 構成証明オブジェクトには、認証データと構成証明ステートメントの両方が含まれます。 前者には、AAGUID、一意の資格情報 ID、および資格情報の公開キーが含まれています。 構成証明ステートメントの内容は、認証者が使用する構成証明ステートメントの形式によって決まります。 また、証明書利用者のサーバーが構成証明ステートメントを検証するため、および認証データと JSON シリアル化されたクライアント データをデコードして検証するために必要な追加情報も含まれます。 |
|
クライアント データ JSON
|
clientDataJSON | string |
この属性には、create() または get() の呼び出しでクライアントによって認証システムに渡されるクライアント データの JSON シリアル化が含まれます。 |
|
転送
|
transports | array of string |
転送です。 |
|
転送
|
transports | array of string |
転送です。 |
|
タイプ
|
type | string |
オブジェクトのインターフェイス オブジェクトの [[type]] slot の値です。このオブジェクトによって表される資格情報の種類を指定します。 これは、Webauthn 資格情報のタイプ「公開キー」である必要があります。 |
|
User ID
|
user_id | True | string |
ユーザー識別子。 |
戻り値
- Body
- AuthResponse
WebAuthn 登録の開始
WebAuthn 登録を開始し、ユーザーを作成します。 この エンドポイント は、ブラウザから登録儀式を実行するために使用される WebAuthn 認証情報作成チャレンジを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ID
|
identifier | True | string |
有効なメールアドレスまたは E164 の電話番号です。 |
認証子の添付ファイル
|
authenticator_attachment | string |
この WebAuthN フロー リクエストで使用される認証のタイプを選択します。 |
戻り値
アカウントと接続のリンク
既存のアカウントを OAuth2 接続にリンクします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
OAuth2 コード
|
code | True | string |
OAuth2 リダイレクトから得られるコードです。 |
検証者
|
verifier | True | string |
クライアントが最初に OAuth2 プロバイダーに送信した検証子。 |
アプリの入手
アプリケーションに関する情報を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
戻り値
- Body
- GetAppResponse
ソーシャルの接続の削除
現在のユーザーのソーシャル接続を削除します。 ユーザーはベアラー トークンを介して認証される必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ソーシャル接続タイプ
|
social_connection_type | True | string |
ソーシャル接続のタイプです。 |
ソーシャル接続の取得
現在のユーザーのソーシャル接続を取得します。 ユーザーはベアラー トークンを介して認証される必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
戻り値
デバイスの取り消し
現在のユーザーの ID に基づいてデバイスを取り消します。 ユーザーはベアラー トークンを介して認証される必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
Device ID
|
device_id | True | string |
デバイス ID です。 |
デバイスを一覧表示
認証されたユーザーのすべての WebAuthn デバイスのリストを取得します。 ユーザーはベアラー トークンを介して認証される必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
戻り値
- Body
- CurrentUserDevices
デバイスを更新する
現在のユーザーの ID に基づいてデバイスを更新します。 現在、更新できる唯一のフィールドはフレンドリ名です。 ユーザーはベアラー トークンを介して認証される必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
Device ID
|
device_id | True | string |
デバイス ID です。 |
フレンドリ名
|
friendly_name | True | string |
フレンドリ名です。 |
戻り値
- Body
- CurrentUserDevice
マジック リンクでログイン
ユーザーにログイン メールまたは SMS を送信します。 ユーザーは、ログインを完了するためのリンクが記載された電子メールまたはテキストメッセージを受け取ります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ID
|
identifier | True | string |
有効なメールアドレスまたは E164 の電話番号です。 |
Language
|
language | string |
送信する電子メールまたは SMS の言語 (オプション) です。 |
|
マジック リンク パス
|
magic_link_path | string |
アプリの auth_origin に対する相対パス (オプション)。 |
戻り値
マジック リンクで登録
ユーザーを作成し、登録メールまたは SMS をユーザーに送信します。 ユーザーは、登録を完了するためのリンクが記載された電子メールまたはテキストメッセージを受け取ります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ID
|
identifier | True | string |
有効なメールアドレスまたは E164 の電話番号です。 |
Language
|
language | string |
送信する電子メールまたは SMS の言語 (オプション) です。 |
|
マジック リンク パス
|
magic_link_path | string |
アプリの auth_origin に対する相対パス (オプション)。 |
戻り値
マジック リンクの状態
マジック リンクが有効化されているかどうかを確認します。 マジック リンクが有効化されると、このエンド ポイントはユーザー用の認証トークンを返します。 この エンドポイント を使用すると、あるデバイスでログインを開始し、別のデバイスでポーリングしてログインが完了するのを待機することができます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ID
|
id | True | string |
識別子。 |
戻り値
- Body
- AuthResponse
マジック リンクを認証する
ユーザーのマジック リンクを認証します。 この エンドポイント は、マジック リンクが有効であることを確認し、ユーザーの認証トークンを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
マジック リンク
|
magic_link | True | string |
マジック リンク パス。 |
戻り値
- Body
- AuthResponse
ユーザーを作成
ユーザーを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
ID
|
identifier | True | string |
識別子。 |
戻り値
- Body
- UserResponse
ユーザーを取得する
ユーザーが存在する場合は、ユーザー情報を取得します。 この エンドポイント を使用すると、ユーザーが既存のアカウントを持っているかどうか、ログインする必要があるか登録する必要があるかを判断できます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
メールまたは電話
|
identifier | True | string |
電子メールまたは電話番号です。 |
戻り値
- Body
- UserResponse
ユーザー写真のメタデータを取得する
現在のユーザーのユーザー メタデータを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
戻り値
- Body
- UserMetadataResponse
ユーザー写真のメタデータを更新する
現在のユーザーのメタデータを更新します。 有効なメタデータ フィールドのみが受け入れられます。 無効なメタデータ フィールドが存在すると、更新が中止されます。 ユーザーはベアラー トークンを介して認証される必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
戻り値
- Body
- CurrentUserResponse
新しい認証を作成してトークンを更新する
新しい認証トークンと新しい更新トークンを作成して返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
更新トークン
|
refresh_token | True | string |
更新トークンです。 |
戻り値
- Body
- AuthResponse
更新トークンの取り消し
更新トークン取り消します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
更新トークン
|
refresh_token | True | string |
更新トークン。 |
現在のユーザーを取得
現在ベアラー トークンを介して認証されているユーザーに関する情報を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
戻り値
- Body
- CurrentUserResponse
認証 OTP
ユーザーのワンタイム パスコードを認証します。 この エンドポイント は、ワンタイム パスコードが有効であることを確認し、ユーザーの認証トークンを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
OTP
|
otp | True | string |
ワン タイム パスワード コードです。 |
OTP ID
|
otp_id | True | string |
ワン タイム パスワード コードの ID です。 |
戻り値
- Body
- AuthResponse
電子メールの変更
認証されたユーザーの電子メールの変更を開始します。 電子メールの変更には検証が必要であるため、電子メールの変更が有効になる前に確認する必要がある電子メールがユーザーに送信されます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
Language
|
language | string |
送信する電子メールの言語 (オプション)。 |
|
マジック リンク パス
|
magic_link_path | string |
マジック リンク パスです。 |
|
新しい電子メール
|
new_email | True | string |
新しいメールです。 |
リダイレクト URL
|
redirect_url | string |
URL アドレスにリダイレクトします。 |
戻り値
- Body
- MagicLinkResponse
電話の変更
認証ユーザーの電話番号変更を開始します。 電話番号の変更には認証が必要なため、リンク付きの SMS がユーザーに送信され、ユーザーは電話番号の変更が有効になる前に認証を行う必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
App ID
|
app_id | True | string |
アプリ ID。 |
Language
|
language | string |
送信する電子メールの言語 (オプション) です。 |
|
マジック リンク パス
|
magic_link_path | string |
マジック リンク パスです。 |
|
新しい電話
|
new_phone | string |
新しい電話番号です。 |
|
リダイレクト URL
|
redirect_url | string |
URL アドレスにリダイレクトします。 |
戻り値
- Body
- MagicLinkResponse
定義
GetAppResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
app
|
app | App |
LayoutConfig
名前 | パス | 型 | 説明 |
---|---|---|---|
H
|
h | integer |
H 値。 |
ID
|
id | string |
識別子。 |
水
|
w | integer |
W 値。 |
X
|
x | integer |
X 値。 |
年
|
y | integer |
Y 値。 |
レイアウト
名前 | パス | 型 | 説明 |
---|---|---|---|
プロフィール
|
profile | array of LayoutConfig | |
登録
|
registration | array of LayoutConfig |
UserMetadataField
名前 | パス | 型 | 説明 |
---|---|---|---|
フィールド名
|
field_name | string |
name フィールドです。 |
フレンドリ名
|
friendly_name | string |
フレンドリ名です。 |
ID
|
id | string |
識別子。 |
プロフィール
|
profile | boolean |
プロフィールかどうか。 |
登録
|
registration | boolean |
登録かどうか。 |
タイプ
|
type | string |
種類。 |
アプリケーション
名前 | パス | 型 | 説明 |
---|---|---|---|
許可された ID
|
allowed_identifier | string |
許可された識別子です。 |
認証フォールバック方法
|
auth_fallback_method | string |
廃止されたプロパティです。 個々の認証方法の設定を表示するには、 |
認証フォールバック方法 TTL
|
auth_fallback_method_ttl | integer |
廃止されたプロパティです。 個々の認証方法の設定を表示するには、 |
認証方法
|
auth_methods | AuthMethods |
このアプリが構成で認証に使用できる方法を示します。 |
認証元
|
auth_origin | string |
認証元です。 |
既定の言語
|
default_language | string |
既定の言語の使用。 |
element_customization
|
element_customization | ElementCustomization | |
element_customization_dark
|
element_customization_dark | ElementCustomization | |
一時的
|
ephemeral | boolean |
一時的かどうか。 |
ID
|
id | string |
識別子。 |
レイアウト
|
layouts | Layouts | |
ログイン URL
|
login_url | string |
ログインの URL アドレス。 |
件名
|
name | string |
名前。 |
パッセージ ブランディング
|
passage_branding | boolean |
パッセージ のブランディングに使用するかどうか。 |
パブリック サインアップ
|
public_signup | boolean |
公開サインアップかどうか。 |
プロファイル管理
|
profile_management | boolean |
プロファイル管理かどうか。 |
リダイレクト URL
|
redirect_url | string |
URL アドレスにリダイレクトします。 |
メールによる確認
|
require_email_verification | boolean |
メール認証を要求するかどうか。 |
ID 確認
|
require_identifier_verification | boolean |
識別子の検証を必要とするかどうか。 |
必須 ID
|
required_identifier | string |
必要な識別子です。 |
RSA 公開キー
|
rsa_public_key | string |
RSA 公開キーです。 |
セッション タイムアウト
|
session_timeout_length | integer |
セッション タイムアウトの長さ。 |
social_connections
|
social_connections | SocialConnections | |
ユーザー メタデータ スキーマ
|
user_metadata_schema | array of UserMetadataField |
SocialConnections
名前 | パス | 型 | 説明 |
---|---|---|---|
google
|
SocialConnection | ||
github
|
github | SocialConnection |
SocialConnection
名前 | パス | 型 | 説明 |
---|---|---|---|
Client ID
|
client_id | string |
OAuth2 ソーシャル接続のクライアント ID です。 |
ElementCustomization
名前 | パス | 型 | 説明 |
---|---|---|---|
パッセージ コンテナの背景色
|
passage_container_background_color | string |
コンテナの背景色を 16 進数で指定します。 既定はライト モードで |
パッセージ コンテナの最大幅
|
passage_container_max_width | integer |
コンテナの最大幅 (px) です。 |
パッセージ入力ボックスの背景色
|
passage_input_box_background_color | string |
入力ボックスの背景色を 16 進数で指定します。 既定はライト モードで |
パッセージ入力ボックスの境界半径
|
passage_input_box_border_radius | integer |
入力ボックスの境界線の半径 (px) です。 |
Font
|
passage_header_font_family | FontFamily |
本文のフォント ファミリーです。 |
Font
|
passage_body_font_family | FontFamily |
本文のフォント ファミリーです。 |
パッセージ ヘッダー テキストの色
|
passage_header_text_color | string |
ヘッダーテキストの色 (16 進数) です。 既定はライト モードで |
パッセージ本文テキストの色
|
passage_body_text_color | string |
本文テキストの色 (16 進数) です。 既定はライト モードで |
パッセージ主ボタンの背景色
|
passage_primary_button_background_color | string |
主ボタンの背景色 (16 進数)。 |
パッセージ主ボタンのテキスト色
|
passage_primary_button_text_color | string |
主ボタンのフォント色 (16 進数)。 |
パッセージ主ボタンのホバー色
|
passage_primary_button_hover_color | string |
主ボタンの背景のホバー (16 進数)。 |
パッセージ主ボタンの境界線の半径
|
passage_primary_button_border_radius | integer |
主ボタンの境界線の半径 (px)。 |
パッセージ主ボタンの境界色
|
passage_primary_button_border_color | string |
主ボタンの境界色 |
パッセージ主ボタンの境界幅
|
passage_primary_button_border_width | integer |
主ボタンの境界線の幅 (px)。 |
パッセージ セカンダリ ボタンの背景色
|
passage_secondary_button_background_color | string |
セカンダリ ボタンの背景色 (16 進数)。 |
パッセージ セカンダリー セカンダリー ボタンの文字色
|
passage_secondary_button_text_color | string |
セカンダリ ボタンのフォント色 (16 進数)。 |
パッセージ セカンダリー ボタンのホバー時の背景
|
passage_secondary_button_hover_color | string |
セカンダリ ボタンの背景のホバー (16 進数)。 |
パッセージ セカンダリ ボタンの境界線の半径
|
passage_secondary_button_border_radius | integer |
セカンダリボタンの境界線の半径 (px)。 |
パッセージ セカンダリ ボタンの境界線色
|
passage_secondary_button_border_color | string |
セカンダ リボタンの境界線色。 |
パッセージ セカンダリ ボタンの境界線幅
|
passage_secondary_button_border_width | integer |
セカンダリボタンの境界線の幅 (px)。 |
FontFamily
AuthMethods
このアプリが構成で認証に使用できる方法を示します。
名前 | パス | 型 | 説明 |
---|---|---|---|
パスキー認証方法
|
passkeys | PasskeysAuthMethod |
パスキー認証メソッドのオブジェクトです。 |
otp
|
otp | OtpAuthMethod | |
magic_link
|
magic_link | MagicLinkAuthMethod |
PasskeysAuthMethod
パスキー認証メソッドのオブジェクトです。
名前 | パス | 型 | 説明 |
---|---|---|---|
パスキー認証方法
|
object |
パスキー認証メソッドのオブジェクトです。 |
OtpAuthMethod
名前 | パス | 型 | 説明 |
---|---|---|---|
TTL
|
ttl | integer |
認証が期限切れになるまでの最大時間 (秒単位)。 |
TTL ディスプレイ ユニット
|
ttl_display_unit | TtlDisplayUnit |
廃止されたプロパティです。 TTL を表示するための優先単位です。 この値は表示専用です。 * |
MagicLinkAuthMethod
名前 | パス | 型 | 説明 |
---|---|---|---|
TTL
|
ttl | integer |
認証が期限切れになるまでの最大時間 (秒単位)。 |
TTL ディスプレイ ユニット
|
ttl_display_unit | TtlDisplayUnit |
廃止されたプロパティです。 TTL を表示するための優先単位です。 この値は表示専用です。 * |
TtlDisplayUnit
廃止されたプロパティです。 TTL を表示するための優先単位です。 この値は表示専用です。 * s
- 秒 * m
- 分 * h
- 時間 * d
- 日。
廃止されたプロパティです。 TTL を表示するための優先単位です。 この値は表示専用です。 * s
- 秒 * m
- 分 * h
- 時間 * d
- 日。
- TTL ディスプレイ ユニット
- string
JWKResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
JWK 応答キー
|
keys | array of JWKResponse_keys |
OpenIdConfiguration
名前 | パス | 型 | 説明 |
---|---|---|---|
承認エンドポイント
|
authorization_endpoint | string |
承認エンドポイントです。 |
発行者
|
issuer | string |
発行者。 |
JWKs URI
|
jwks_uri | string |
JWKs の URI。 |
CurrentUserResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
user
|
user | CurrentUser |
資格情報
名前 | パス | 型 | 説明 |
---|---|---|---|
Created at
|
created_at | string |
この webAuthn デバイスがユーザーを認証するために初めて使用されたとき。 |
資格 ID
|
cred_id | string |
この webAuthn デバイスの Cred ID (psg_cred_obj に格納されているものと一致するようにエンコードされています)。 |
フレンドリ名
|
friendly_name | string |
認証に使用される webAuthn デバイスのフレンドリ名。 |
ID
|
id | string |
認証に使用する webAuthn デバイスの IDです。 |
最終ログイン時
|
last_login_at | string |
この webAuthn デバイスがユーザーを認証するために最後に使用されたとき。 |
Web 認証タイプ
|
type | WebAuthnType |
この資格情報の種類です。 |
更新日
|
updated_at | string |
この webAuthn デバイスが最後に更新された時刻。 |
使用回数
|
usage_count | integer |
この webAuthn デバイスがユーザー認証に使用された回数。 |
User ID
|
user_id | string |
この WebAuthn デバイスのユーザー ID です。 |
アイコン
|
icons | WebAuthnIcons |
これらのデバイスのブランドを表す明るいおよび暗い SVG アイコンが含まれます。値は null または Base64 でエンコードされたSVGにすることができます。 Example of SVG output: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDE5MiAxOTIiIGhlaWdodD0iMjRweCIgdmlld0JveD0iMCAwIDE5MiAxOTIiIHdpZHRoPSIyNHB4Ij48cmVjdCBmaWxsPSJub25lIiBoZWlnaHQ9IjE5MiIgd2lkdGg9IjE5MiIgeT0iMCIvPjxnPjxwYXRoIGQ9Ik02OS4yOSwxMDZjLTMuNDYsNS45Ny05LjkxLDEwLTE3LjI5LDEwYy0xMS4wMywwLTIwLTguOTctMjAtMjBzOC45Ny0yMCwyMC0yMCBjNy4zOCwwLDEzLjgzLDQuMDMsMTcuMjksMTBoMjUuNTVDOTAuMyw2Ni41NCw3Mi44Miw1Miw1Miw1MkMyNy43NCw1Miw4LDcxLjc0LDgsOTZzMTkuNzQsNDQsNDQsNDRjMjAuODIsMCwzOC4zLTE0LjU0LDQyLjg0LTM0IEg2OS4yOXoiIGZpbGw9IiM0Mjg1RjQiLz48cmVjdCBmaWxsPSIjRkJCQzA0IiBoZWlnaHQ9IjI0IiB3aWR0aD0iNDQiIHg9Ijk0IiB5PSI4NCIvPjxwYXRoIGQ9Ik05NC4zMiw4NEg2OHYwLjA1YzIuNSwzLjM0LDQsNy40Nyw0LDExLjk1cy0xLjUsOC42MS00LDExLjk1VjEwOGgyNi4zMiBjMS4wOC0zLjgyLDEuNjgtNy44NCwxLjY4LTEyUzk1LjQxLDg3LjgyLDk0LjMyLDg0eiIgZmlsbD0iI0VBNDMzNSIvPjxwYXRoIGQ9Ik0xODQsMTA2djI2aC0xNnYtOGMwLTQuNDItMy41OC04LTgtOHMtOCwzLjU4LTgsOHY4aC0xNnYtMjZIMTg0eiIgZmlsbD0iIzM0QTg1MyIvPjxyZWN0IGZpbGw9IiMxODgwMzgiIGhlaWdodD0iMjQiIHdpZHRoPSI0OCIgeD0iMTM2IiB5PSI4NCIvPjwvZz48L3N2Zz4= |
CurrentUser
名前 | パス | 型 | 説明 |
---|---|---|---|
作成日
|
created_at | string |
ユーザーが作成された日です。 |
メール
|
string |
ユーザーの電子メール。 |
|
メールアドレス検証済み
|
email_verified | boolean |
ユーザーの E メールが認証されたかどうか。 |
ID
|
id | string |
ユーザー ID。 |
最終ログイン時
|
last_login_at | string |
このユーザーが最後にログインした時間です。 |
ログイン数
|
login_count | integer |
ユーザーがログインに成功した回数です。 |
電話番号
|
phone | string |
ユーザーの電話番号です。 |
電話確認済み
|
phone_verified | boolean |
ユーザーの電話が認証されたかどうか。 |
social_connections
|
social_connections | UserSocialConnections | |
ユーザーの状態
|
status | UserStatus |
ユーザーの状態: アクティブ、非アクティブ、保留中。 |
更新日
|
updated_at | string |
このユーザーが最後に更新された日時。 |
WebAuthn
|
webauthn | boolean |
ユーザーが以前に webAuthn 経由で認証したかどうか (len(WebAuthnDevices) > 0 の場合)。 |
WebAuthn デバイス
|
webauthn_devices | array of Credential |
このユーザーが webAuthn 経由で認証したデバイスのリスト。 |
WebAuthn タイプ
|
webauthn_types | array of WebAuthnType |
ユーザーが作成した資格情報タイプのリストを取得します。 |
CurrentUserDevices
名前 | パス | 型 | 説明 |
---|---|---|---|
デバイス
|
devices | array of Credential |
CurrentUserDevice
名前 | パス | 型 | 説明 |
---|---|---|---|
device
|
device | Credential |
AddDeviceStartResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
handshake
|
handshake | CredentialCreationChallenge | |
user
|
user | User |
MagicLinkResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
magic_link
|
magic_link | MagicLink |
MagicLink
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
マジック リンクの識別子です。 |
UserMetadataResponse
LoginMagicLinkResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
magic_link
|
magic_link | MagicLink |
RegisterMagicLinkResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
magic_link
|
magic_link | MagicLink |
UserResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
user
|
user | User |
LoginWebAuthnStartResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
handshake
|
handshake | CredentialAssertionChallenge | |
user
|
user | User |
CredentialAssertionChallenge
名前 | パス | 型 | 説明 |
---|---|---|---|
challenge
|
challenge | protocol.CredentialAssertion | |
ID
|
id | string |
識別子。 |
protocol.CredentialAssertion
名前 | パス | 型 | 説明 |
---|---|---|---|
publicKey
|
publicKey | protocol.CredentialAssertion_publicKey |
WebAuthnIcons
これらのデバイスのブランドを表す明るいおよび暗い SVG アイコンが含まれます。値は null または Base64 でエンコードされたSVGにすることができます。 Example of SVG output: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDE5MiAxOTIiIGhlaWdodD0iMjRweCIgdmlld0JveD0iMCAwIDE5MiAxOTIiIHdpZHRoPSIyNHB4Ij48cmVjdCBmaWxsPSJub25lIiBoZWlnaHQ9IjE5MiIgd2lkdGg9IjE5MiIgeT0iMCIvPjxnPjxwYXRoIGQ9Ik02OS4yOSwxMDZjLTMuNDYsNS45Ny05LjkxLDEwLTE3LjI5LDEwYy0xMS4wMywwLTIwLTguOTctMjAtMjBzOC45Ny0yMCwyMC0yMCBjNy4zOCwwLDEzLjgzLDQuMDMsMTcuMjksMTBoMjUuNTVDOTAuMyw2Ni41NCw3Mi44Miw1Miw1Miw1MkMyNy43NCw1Miw4LDcxLjc0LDgsOTZzMTkuNzQsNDQsNDQsNDRjMjAuODIsMCwzOC4zLTE0LjU0LDQyLjg0LTM0IEg2OS4yOXoiIGZpbGw9IiM0Mjg1RjQiLz48cmVjdCBmaWxsPSIjRkJCQzA0IiBoZWlnaHQ9IjI0IiB3aWR0aD0iNDQiIHg9Ijk0IiB5PSI4NCIvPjxwYXRoIGQ9Ik05NC4zMiw4NEg2OHYwLjA1YzIuNSwzLjM0LDQsNy40Nyw0LDExLjk1cy0xLjUsOC42MS00LDExLjk1VjEwOGgyNi4zMiBjMS4wOC0zLjgyLDEuNjgtNy44NCwxLjY4LTEyUzk1LjQxLDg3LjgyLDk0LjMyLDg0eiIgZmlsbD0iI0VBNDMzNSIvPjxwYXRoIGQ9Ik0xODQsMTA2djI2aC0xNnYtOGMwLTQuNDItMy41OC04LTgtOHMtOCwzLjU4LTgsOHY4aC0xNnYtMjZIMTg0eiIgZmlsbD0iIzM0QTg1MyIvPjxyZWN0IGZpbGw9IiMxODgwMzgiIGhlaWdodD0iMjQiIHdpZHRoPSI0OCIgeD0iMTM2IiB5PSI4NCIvPjwvZz48L3N2Zz4=
名前 | パス | 型 | 説明 |
---|---|---|---|
光のアイコン
|
light | string |
光のアイコン。 |
暗いアイコン
|
dark | string |
ダーク アイコンです。 |
OneTimePasscodeResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
OTP ID
|
otp_id | string |
ワン タイム パスワード コードの ID です。 アクティベート時に指定してください。 |
RegisterWebAuthnStartResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
handshake
|
handshake | CredentialCreationChallenge | |
user
|
user | User |
SocialConnectionsResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
social_connections
|
social_connections | UserSocialConnections |
GoogleSocialConnection
名前 | パス | 型 | 説明 |
---|---|---|---|
プロバイダー ID
|
provider_id | string |
ソーシャル接続の外部 ID です。 |
作成日
|
created_at | date-time |
作成日時。 |
最終ログイン時
|
last_login_at | date-time |
最終ログイン時です。 |
プロバイダー ID
|
provider_identifier | string |
ソーシャルユーザーの E メールです。 |
GithubSocialConnection
名前 | パス | 型 | 説明 |
---|---|---|---|
プロバイダー ID
|
provider_id | string |
ソーシャル接続の外部 ID です。 |
作成日
|
created_at | date-time |
作成日時。 |
最終ログイン時
|
last_login_at | date-time |
最終ログイン時です。 |
プロバイダー ID
|
provider_identifier | string |
ソーシャルユーザーの E メールです。 |
UserSocialConnections
名前 | パス | 型 | 説明 |
---|---|---|---|
google
|
GoogleSocialConnection | ||
github
|
github | GithubSocialConnection |
UserStatus
WebAuthnType
CredentialCreation
名前 | パス | 型 | 説明 |
---|---|---|---|
publicKey
|
publicKey | CredentialCreation_publicKey |
CredentialCreationChallenge
名前 | パス | 型 | 説明 |
---|---|---|---|
challenge
|
challenge | CredentialCreation | |
ID
|
id | string |
識別子。 |
User
名前 | パス | 型 | 説明 |
---|---|---|---|
メール
|
string |
メール アドレス。 |
|
メールアドレス検証済み
|
email_verified | boolean |
ユーザーの E メールが認証されたかどうか。 |
ID
|
id | string |
識別子。 |
電話番号
|
phone | string |
電話番号。 |
電話確認済み
|
phone_verified | boolean |
ユーザーの電話が認証されたかどうか。 |
ユーザーの状態
|
status | UserStatus |
ユーザーの状態: アクティブ、非アクティブ、保留中。 |
確認済み WebAuthn
|
webauthn | boolean |
WebAuthn が検証済みかどうか。 |
WebAuthn タイプ
|
webauthn_types | array of WebAuthnType |
AuthResult
名前 | パス | 型 | 説明 |
---|---|---|---|
認証トークン
|
auth_token | string |
認証トークンです。 |
リダイレクト URL
|
redirect_url | string |
URL アドレスにリダイレクトします。 |
更新トークン
|
refresh_token | string |
更新トークンです。 |
更新トークンの有効期限
|
refresh_token_expiration | integer |
更新トークンの有効期限です。 |
AuthResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
auth_result
|
auth_result | AuthResult |
JWKResponse_keys
名前 | パス | 型 | 説明 |
---|---|---|---|
Algorithm
|
alg | string |
キーのアルゴリズムです。 |
指数
|
e | string |
標準 pem の指数です。 |
キー ID
|
kid | string |
キーを表す一意識別子です。 |
キー、タイプ
|
kty | string | |
剰余
|
n | string |
標準の pem の剰余です。 |
使用
|
use | string |
キーの使用方法 (「sig」は署名を表すなど) |
protocol.CredentialAssertion_publicKey
名前 | パス | 型 | 説明 |
---|---|---|---|
課題
|
challenge | string |
チャレンジです。 |
RP ID
|
rpId | string |
RP 識別子です。 |
Timeout
|
timeout | integer |
タイムアウト |
ユーザーの確認
|
userVerification | string |
このメンバーは、create() 操作のユーザー検証に関する証明書利用者の要件を記述します。 適格な認証者は、この要件を満たすことができる認証者のみにフィルタリングされます。 |
CredentialCreation_publicKey_authenticatorSelection
名前 | パス | 型 | 説明 |
---|---|---|---|
認証子の添付ファイル
|
authenticatorAttachment | string |
このメンバーが存在する場合、適格な認証子は、指定された AuthenticatorAttachment 列挙型で接続された認証子のみにフィルタリングされます。 |
常駐キーが必要
|
requireResidentKey | boolean |
このメンバーは、常駐資格情報に関する依存当事者の要件を記述します。 このパラメータが true に設定されている場合、認証機能は、公開鍵の資格情報を作成するときに、クライアント側に常駐する公開鍵の資格情報ソースを作成しなければなりません。 |
常駐キー
|
residentKey | string |
このメンバは、Webauthn レベル 2 ごとの常駐資格情報に関する依拠当事者の要件について説明します。 |
ユーザーの確認
|
userVerification | string |
このメンバーは、create() 操作のユーザー検証に関する証明書利用者の要件を記述します。 適格な認証者は、この要件を満たすことができる認証者のみにフィルタリングされます。 |
CredentialCreation_publicKey_excludeCredentials
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
許可/不許可する資格情報の ID です。 |
転送
|
transports | array of string |
使用できる認証の転送です。 |
タイプ
|
type | string |
有効な資格情報タイプです。 |
CredentialCreation_publicKey_pubKeyCredParams
名前 | パス | 型 | 説明 |
---|---|---|---|
Algorithm
|
alg | integer |
アルゴリズムです。 |
タイプ
|
type | string |
種類。 |
CredentialCreation_publicKey_rp
名前 | パス | 型 | 説明 |
---|---|---|---|
Icon
|
icon | string |
エンティティに関連付けられた画像に解決されるシリアル化された URL です。 たとえば、これはユーザーのアバターや信頼者のロゴである可能性があります。 この URL は事前に認証された URL でなければなりません。 認証者は、アイコン メンバーの値として 128 バイトの最小長を受け入れて保存しなければなりません。 認証者は、長さが 128バ イトを超える場合、アイコン メンバーの値を無視しても構いません。 URL のスキームは、より多くのストレージを必要とする代わりに、URL のフェッチを回避するために「データ」にすることができます。 非推奨: これは仕様の推奨事項から削除されました。 |
ID
|
id | string |
RP ID を設定する、証明書利用者エンティティの一意の識別子です。 |
件名
|
name | string |
人間にとってわかりやすいエンティティの名前です。 その機能は、PublicKeyCredentialEntity が何を表すかによって異なります。PublicKeyCredentialRpEntity によって継承される場合、これは表示のみを目的とした、依存当事者にとって人間が好む識別子になります。 例: 「ACME Corporation」、「Wonderful Widgets, Inc.」 または「ОАО Примертех」。 PublicKeyCredentialUserEntity によって継承されると、これはユーザー アカウントの人間が好む識別子になります。 これは表示のみを目的としており、類似した表示名を持つユーザー アカウント間の違いをユーザーが判断するのに役立ちます。 例: 「alexm」、「alex.p.mueller@example.com」 または 「+14255551234」。 |
CredentialCreation_publicKey_user
名前 | パス | 型 | 説明 |
---|---|---|---|
Display Name
|
displayName | string |
表示のみを目的とした、人間が親しみやすいユーザー アカウントの名前です。 依存者はユーザーにこれを選択させるべきであり、選択を必要以上に制限すべきではありません。 |
Icon
|
icon | string |
エンティティに関連付けられた画像に解決されるシリアル化された URL です。 たとえば、これはユーザーのアバターや信頼者のロゴである可能性があります。 この URL は事前に認証された URL でなければなりません。 認証者は、アイコン メンバーの値として 128 バイトの最小長を受け入れて保存しなければなりません。 認証者は、長さが 128バ イトを超える場合、アイコン メンバーの値を無視しても構いません。 URL のスキームは、より多くのストレージを必要とする代わりに、URL のフェッチを回避するために「データ」にすることができます。 非推奨: これは仕様の推奨事項から削除されました。 |
ID
|
id | object |
ユーザー アカウント エンティティのユーザー ハンドルです。 安全な操作を確保するには、displayName メンバーや name メンバーではなく、この id メンバーに基づいて認証と認可の決定を行う必要があります。 RFC8266 のセクション 6.1 を参照してください。 |
件名
|
name | string |
人間にとってわかりやすいエンティティの名前です。 その機能は、PublicKeyCredentialEntity が何を表すかによって異なります。PublicKeyCredentialRpEntity によって継承される場合、これは表示のみを目的とした、依存当事者にとって人間が好む識別子になります。 例: 「ACME Corporation」、「Wonderful Widgets, Inc.」 または「ОАО Примертех」。 PublicKeyCredentialUserEntity によって継承されると、これはユーザー アカウントの人間が好む識別子になります。 これは表示のみを目的としており、類似した表示名を持つユーザー アカウント間の違いをユーザーが判断するのに役立ちます。 例: 「alexm」、「alex.p.mueller@example.com」 または 「+14255551234」。 |
CredentialCreation_publicKey
名前 | パス | 型 | 説明 |
---|---|---|---|
証明
|
attestation | string |
構成証明です。 |
authenticatorSelection
|
authenticatorSelection | CredentialCreation_publicKey_authenticatorSelection | |
課題
|
challenge | string |
チェレンジです。 |
除外される資格情報
|
excludeCredentials | array of CredentialCreation_publicKey_excludeCredentials | |
公開鍵認証パラメータ
|
pubKeyCredParams | array of CredentialCreation_publicKey_pubKeyCredParams | |
rp
|
rp | CredentialCreation_publicKey_rp | |
Timeout
|
timeout | integer |
タイムアウト |
user
|
user | CredentialCreation_publicKey_user |