通过 1Password - 身份验证 (独立发布者) (预览版)
通道由 1Password 17 年以上的行业领先的安全专业知识提供支持。 使用可靠的无密码身份验证和客户标识管理解决方案完全替换现有身份验证流或从头开始生成。 通过实现由密钥、magic 链接和登录代码提供支持的登录流,实现消除密码的完整安全性、业务和用户体验优势。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| Name | 特洛伊·泰勒 |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| 连接器元数据 | |
|---|---|
| 发布者 | 特洛伊·泰勒 |
| 网站 | https://passage.1password.com/ |
| 隐私策略 | https://storage.googleapis.com/passage-docs/passage-privacy-policy.pdf |
| 类别 | 安全性 |
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| API 密钥(格式为“Bearer YOUR_API_KEY” ) | securestring | 此 API 的 API 密钥(格式为“Bearer YOUR_API_KEY”) | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| Magic 链接状态 |
检查是否已激活 magic 链接。 激活 magic 链接后,此终结点将为用户返回身份验证令牌。 此终结点可用于在一台设备上启动登录,然后轮询并等待登录在另一台设备上完成。 |
| 使用 magic 链接注册 |
创建用户并向用户发送注册电子邮件或短信。 用户将收到一封电子邮件或文本,其中包含完成其注册的链接。 |
| 使用 magic 链接登录 |
向用户发送登录电子邮件或短信。 用户将收到一封电子邮件或文本,其中包含完成其登录名的链接。 |
| 使用 OTP 登录 |
向用户发送登录电子邮件或短信。 用户将收到一封包含一次性密码的电子邮件或文本,以完成其登录。 |
| 列出设备 |
检索经过身份验证的用户的所有 WebAuthn 设备的列表。 用户必须通过持有者令牌进行身份验证。 |
| 创建新的身份验证和刷新令牌 |
创建并返回新的身份验证令牌和新刷新令牌。 |
| 创建用户 |
创建一个用户。 |
| 删除社交连接 |
删除当前用户的社交连接。 用户必须通过持有者令牌进行身份验证。 |
| 向 OTP 注册 |
创建用户并向用户发送注册电子邮件或短信。 用户将收到一封包含一次性密码的电子邮件或文本,以完成注册。 |
| 启动 OAuth2 流 |
启动 OAuth2 流,其中包含上述连接提供程序请求参数 https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest |
|
启动 Web |
启动 WebAuthn 注册并创建用户。 此终结点创建 WebAuthn 凭据创建质询,用于从浏览器执行注册仪式。 |
|
启动 Web |
为当前用户启动 WebAuthn 添加设备作。 此终结点创建 WebAuthn 凭据创建质询,用于从浏览器执行注册仪式。 用户必须通过持有者令牌进行身份验证。 |
|
启动 Web |
为用户启动 WebAuthn 登录名。 此终结点创建 WebAuthn 凭据断言质询,用于从浏览器执行登录仪式。 |
| 处理 OAuth2 回调 |
处理 OAuth2 流回调。 |
|
完成 Web |
完成 WebAuthn 注册并验证用户身份。 |
|
完成 Web |
完成当前用户的 WebAuthn 添加设备作。 用户必须通过持有者令牌进行身份验证。 |
|
完成 Web |
完成 WebAuthn 登录并验证用户身份。 |
| 对 OTP 进行身份验证 |
对用户的一次性密码进行身份验证。 此终结点检查一次性密码是否有效,然后返回用户的身份验证令牌。 |
| 将帐户链接到连接 |
将现有帐户链接到 OAuth2 连接。 |
| 撤销刷新令牌 |
撤销刷新令牌。 |
| 撤销设备 |
按当前用户的 ID 撤销设备。 用户必须通过持有者令牌进行身份验证。 |
| 更改电子邮件 |
为经过身份验证的用户启动电子邮件更改。 电子邮件更改需要验证,因此电子邮件将发送给用户,在电子邮件更改生效之前,必须验证该电子邮件。 |
| 更改电话 |
为经过身份验证的用户启动电话号码更改。 电话号码更改需要验证,因此,带有链接的短信将发送给用户,必须在电话号码更改生效之前验证该短信。 |
| 更新用户的元数据 |
更新当前用户的元数据。 仅接受有效的元数据字段。 存在的无效元数据字段将中止更新。 用户必须通过持有者令牌进行身份验证。 |
| 更新设备 |
按当前用户的 ID 更新设备。 目前,唯一可更新的字段是友好名称。 用户必须通过持有者令牌进行身份验证。 |
| 用于身份验证令牌的 Exchange OAuth2 |
交换 OAuth2 连接数据以获取身份验证令牌。 |
| 获取 JWKS |
检索应用的 JWKS。 JWT 中的 KID 可用于匹配相应的 JWK,并使用 JWK 的公钥来验证 JWT。 |
| 获取 OpenID 配置 |
检索应用的 OpenID 配置。 |
| 获取应用 |
检索有关应用程序的信息。 |
| 获取当前用户 |
检索有关当前通过持有者令牌进行身份验证的用户的信息。 |
| 获取用户 |
检索用户信息(如果用户存在)。 此终结点可用于确定用户是否具有现有帐户,以及用户是否应登录或注册。 |
| 获取用户的元数据 |
检索当前用户的用户元数据。 |
| 获取社交连接 |
获取当前用户的社交连接。 用户必须通过持有者令牌进行身份验证。 |
| 验证 magic 链接 |
对用户的 magic 链接进行身份验证。 此终结点检查 magic 链接是否有效,然后返回用户的身份验证令牌。 |
Magic 链接状态
检查是否已激活 magic 链接。 激活 magic 链接后,此终结点将为用户返回身份验证令牌。 此终结点可用于在一台设备上启动登录,然后轮询并等待登录在另一台设备上完成。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
ID
|
id | True | string |
标识符。 |
返回
- Body
- AuthResponse
使用 magic 链接注册
创建用户并向用户发送注册电子邮件或短信。 用户将收到一封电子邮件或文本,其中包含完成其注册的链接。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
ID
|
identifier | True | string |
有效的电子邮件或 E164 电话号码。 |
|
语言
|
language | string |
要发送的电子邮件或短信的语言(可选)。 |
|
|
Magic 链接路径
|
magic_link_path | string |
相对于应用的auth_origin的路径(可选)。 |
返回
使用 magic 链接登录
向用户发送登录电子邮件或短信。 用户将收到一封电子邮件或文本,其中包含完成其登录名的链接。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
ID
|
identifier | True | string |
有效的电子邮件或 E164 电话号码。 |
|
语言
|
language | string |
要发送的电子邮件或短信的语言(可选)。 |
|
|
Magic 链接路径
|
magic_link_path | string |
相对于应用的auth_origin的路径(可选)。 |
返回
使用 OTP 登录
向用户发送登录电子邮件或短信。 用户将收到一封包含一次性密码的电子邮件或文本,以完成其登录。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
ID
|
identifier | True | string |
有效的电子邮件或 E164 电话号码。 |
|
语言
|
language | string |
要发送电子邮件的语言(可选)。 |
返回
列出设备
检索经过身份验证的用户的所有 WebAuthn 设备的列表。 用户必须通过持有者令牌进行身份验证。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
返回
- Body
- CurrentUserDevices
创建新的身份验证和刷新令牌
创建并返回新的身份验证令牌和新刷新令牌。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
刷新令牌
|
refresh_token | True | string |
刷新令牌。 |
返回
- Body
- AuthResponse
创建用户
创建一个用户。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
ID
|
identifier | True | string |
标识符。 |
返回
- Body
- UserResponse
删除社交连接
删除当前用户的社交连接。 用户必须通过持有者令牌进行身份验证。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
社交连接类型
|
social_connection_type | True | string |
社交连接的类型。 |
向 OTP 注册
创建用户并向用户发送注册电子邮件或短信。 用户将收到一封包含一次性密码的电子邮件或文本,以完成注册。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
ID
|
identifier | True | string |
有效的电子邮件或 E164 电话号码。 |
|
语言
|
language | string |
要发送电子邮件的语言(可选)。 |
返回
启动 OAuth2 流
启动 OAuth2 流,其中包含上述连接提供程序请求参数 https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
重定向 URI
|
redirect_uri | True | string |
OAuth2 流完成后要重定向到的 URL。 |
|
State
|
state | string |
要传递到重定向 URI 的状态。 |
|
|
代码质询
|
code_challenge | True | string |
代码质询。 |
|
代码质询方法
|
code_challenge_method | True | string |
代码质询方法。 |
|
连接类型
|
connection_type | True | string |
连接类型;google、github、apple 或用于登录的段落。 |
启动 WebAuthn 注册
启动 WebAuthn 注册并创建用户。 此终结点创建 WebAuthn 凭据创建质询,用于从浏览器执行注册仪式。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
ID
|
identifier | True | string |
有效的电子邮件或 E164 电话号码。 |
|
验证器附件
|
authenticator_attachment | string |
选择将在此 WebAuthN 流请求中使用的身份验证类型。 |
返回
启动 WebAuthn 添加设备
为当前用户启动 WebAuthn 添加设备作。 此终结点创建 WebAuthn 凭据创建质询,用于从浏览器执行注册仪式。 用户必须通过持有者令牌进行身份验证。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
验证器附件
|
authenticator_attachment | string |
选择将在此 WebAuthN 流请求中使用的身份验证类型。 |
返回
启动 WebAuthn 登录
为用户启动 WebAuthn 登录名。 此终结点创建 WebAuthn 凭据断言质询,用于从浏览器执行登录仪式。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
ID
|
identifier | string |
有效的电子邮件或 E164 电话号码。 |
返回
处理 OAuth2 回调
处理 OAuth2 流回调。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
OAuth2 代码
|
code | True | string |
OAuth2 提供程序返回的授权代码。 |
|
State
|
state | string |
OAuth2 提供程序返回的状态。 |
|
|
错误
|
error | string |
OAuth2 提供程序返回的错误。 |
|
|
错误
|
error_description | string |
OAuth2 提供程序返回的错误说明。 |
完成 WebAuthn 注册
完成 WebAuthn 注册并验证用户身份。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
握手 ID
|
handshake_id | True | string |
握手标识符。 |
|
验证器附件
|
authenticatorAttachment | string |
验证器附件。 |
|
|
ID
|
id | string |
凭据的标识符。 标识符的要求对于每种凭据类型都是不同的。 例如,它可能表示用户名/密码元组的用户名。 |
|
|
原始 ID
|
rawId | string |
原始标识符。 |
|
|
证明对象
|
attestationObject | string |
证明对象是证明Object 的字节切片版本。 此属性包含一个证明对象,该对象不透明,并且以加密方式保护客户端免受篡改。 证明对象包含验证器数据和证明语句。 前者包含 AAGUID、唯一凭据 ID 和凭据公钥。 证明语句的内容由验证器使用的证明语句格式确定。 它还包含信赖方服务器验证证明语句以及解码和验证验证器数据以及 JSON 序列化客户端数据所需的任何其他信息。 |
|
|
客户端数据 JSON
|
clientDataJSON | string |
此属性包含客户端在调用 create() 或 get()时传递给验证器的客户端数据的 JSON 序列化。 |
|
|
运输工具
|
transports | array of string |
传输。 |
|
|
运输工具
|
transports | array of string |
传输。 |
|
|
类型
|
type | string |
对象的接口对象的 [[type]] 槽的值,指定此对象所表示的凭据类型。 这应为 Webauthn 凭据的“公钥”。 |
|
|
用户 ID
|
user_id | True | string |
用户标识符。 |
返回
- Body
- AuthResponse
完成 WebAuthn 添加设备
完成当前用户的 WebAuthn 添加设备作。 用户必须通过持有者令牌进行身份验证。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
握手 ID
|
handshake_id | True | string |
握手标识符。 |
|
验证器附件
|
authenticatorAttachment | string |
验证器附件。 |
|
|
ID
|
id | string |
凭据的标识符。 标识符的要求对于每种凭据类型都是不同的。 例如,它可能表示用户名/密码元组的用户名。 |
|
|
原始 ID
|
rawId | string |
原始标识符。 |
|
|
证明对象
|
attestationObject | string |
证明对象是证明Object 的字节切片版本。 此属性包含一个证明对象,该对象不透明,并且以加密方式保护客户端免受篡改。 证明对象包含验证器数据和证明语句。 前者包含 AAGUID、唯一凭据 ID 和凭据公钥。 证明语句的内容由验证器使用的证明语句格式确定。 它还包含信赖方服务器验证证明语句以及解码和验证验证器数据以及 JSON 序列化客户端数据所需的任何其他信息。 |
|
|
客户端数据 JSON
|
clientDataJSON | string |
此属性包含客户端在调用 create() 或 get()时传递给验证器的客户端数据的 JSON 序列化。 |
|
|
运输工具
|
transports | array of string |
传输。 |
|
|
运输工具
|
transports | array of string |
传输。 |
|
|
类型
|
type | string |
对象的接口对象的 [[type]] 槽的值,指定此对象所表示的凭据类型。 这应为 Webauthn 凭据的“公钥”。 |
|
|
用户 ID
|
user_id | True | string |
用户标识符。 |
返回
- Body
- CurrentUserDevice
完成 WebAuthn 登录
完成 WebAuthn 登录并验证用户身份。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
握手 ID
|
handshake_id | True | string |
握手标识符。 |
|
验证器附件
|
authenticatorAttachment | string |
验证器附件。 |
|
|
ID
|
id | string |
凭据的标识符。 标识符的要求对于每种凭据类型都是不同的。 例如,它可能表示用户名/密码元组的用户名。 |
|
|
原始 ID
|
rawId | string |
原始标识符。 |
|
|
验证器数据
|
authenticatorData | string |
验证器数据。 |
|
|
客户端数据 JSON
|
clientDataJSON | string |
此属性包含客户端在调用 create() 或 get()时传递给验证器的客户端数据的 JSON 序列化。 |
|
|
Signature
|
signature | string |
签名。 |
|
|
用户
|
userHandle | string |
用户句柄。 |
|
|
类型
|
type | string |
对象的接口对象的 [[type]] 槽的值,指定此对象所表示的凭据类型。 这应为 Webauthn 凭据的“公钥”。 |
|
|
用户 ID
|
user_id | string |
用户标识符。 |
返回
- Body
- AuthResponse
对 OTP 进行身份验证
对用户的一次性密码进行身份验证。 此终结点检查一次性密码是否有效,然后返回用户的身份验证令牌。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
OTP
|
otp | True | string |
一次性密码。 |
|
OTP ID
|
otp_id | True | string |
一次性密码的 ID。 |
返回
- Body
- AuthResponse
将帐户链接到连接
将现有帐户链接到 OAuth2 连接。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
OAuth2 代码
|
code | True | string |
从 OAuth2 重定向给出的代码。 |
|
验证
|
verifier | True | string |
客户端最初发送到 OAuth2 提供程序的验证程序。 |
撤销刷新令牌
撤销刷新令牌。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
刷新令牌
|
refresh_token | True | string |
刷新令牌。 |
撤销设备
按当前用户的 ID 撤销设备。 用户必须通过持有者令牌进行身份验证。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
设备识别码
|
device_id | True | string |
设备 ID。 |
更改电子邮件
为经过身份验证的用户启动电子邮件更改。 电子邮件更改需要验证,因此电子邮件将发送给用户,在电子邮件更改生效之前,必须验证该电子邮件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
语言
|
language | string |
要发送的电子邮件的语言(可选)。 |
|
|
Magic 链接路径
|
magic_link_path | string |
magic 链接路径。 |
|
|
新建电子邮件
|
new_email | True | string |
新电子邮件。 |
|
重定向 URL
|
redirect_url | string |
重定向 URL 地址。 |
返回
- Body
- MagicLinkResponse
更改电话
为经过身份验证的用户启动电话号码更改。 电话号码更改需要验证,因此,带有链接的短信将发送给用户,必须在电话号码更改生效之前验证该短信。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
语言
|
language | string |
要发送电子邮件的语言(可选)。 |
|
|
Magic 链接路径
|
magic_link_path | string |
magic 链接路径。 |
|
|
新建电话
|
new_phone | string |
新的电话号码。 |
|
|
重定向 URL
|
redirect_url | string |
重定向 URL 地址。 |
返回
- Body
- MagicLinkResponse
更新用户的元数据
更新当前用户的元数据。 仅接受有效的元数据字段。 存在的无效元数据字段将中止更新。 用户必须通过持有者令牌进行身份验证。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
返回
- Body
- CurrentUserResponse
更新设备
按当前用户的 ID 更新设备。 目前,唯一可更新的字段是友好名称。 用户必须通过持有者令牌进行身份验证。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
设备识别码
|
device_id | True | string |
设备 ID。 |
|
友好名称
|
friendly_name | True | string |
友好名称。 |
返回
- Body
- CurrentUserDevice
用于身份验证令牌的 Exchange OAuth2
交换 OAuth2 连接数据以获取身份验证令牌。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
OAuth2 代码
|
code | True | string |
从 OAuth2 重定向给出的代码。 |
|
验证
|
verifier | True | string |
客户端最初发送到 OAuth2 提供程序的验证程序。 |
返回
- Body
- AuthResponse
获取 JWKS
检索应用的 JWKS。 JWT 中的 KID 可用于匹配相应的 JWK,并使用 JWK 的公钥来验证 JWT。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
返回
- Body
- JWKResponse
获取 OpenID 配置
获取应用
获取当前用户
检索有关当前通过持有者令牌进行身份验证的用户的信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
返回
- Body
- CurrentUserResponse
获取用户
检索用户信息(如果用户存在)。 此终结点可用于确定用户是否具有现有帐户,以及用户是否应登录或注册。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
电子邮件或电话
|
identifier | True | string |
电子邮件或电话号码。 |
返回
- Body
- UserResponse
获取用户的元数据
获取社交连接
获取当前用户的社交连接。 用户必须通过持有者令牌进行身份验证。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
返回
验证 magic 链接
对用户的 magic 链接进行身份验证。 此终结点检查 magic 链接是否有效,然后返回用户的身份验证令牌。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用 ID
|
app_id | True | string |
应用 ID。 |
|
Magic 链接
|
magic_link | True | string |
magic 链接。 |
返回
- Body
- AuthResponse
定义
GetAppResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
应用
|
app | App |
LayoutConfig
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
H
|
h | integer |
H 值。 |
|
ID
|
id | string |
标识符。 |
|
W
|
w | integer |
W 值。 |
|
X
|
x | integer |
X 值。 |
|
Y
|
y | integer |
Y 值。 |
Layouts
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
个人资料
|
profile | array of LayoutConfig | |
|
Registration
|
registration | array of LayoutConfig |
UserMetadataField
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
字段名称
|
field_name | string |
字段名称。 |
|
友好名称
|
friendly_name | string |
友好名称。 |
|
ID
|
id | string |
标识符。 |
|
个人资料
|
profile | boolean |
配置文件。 |
|
Registration
|
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
|
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
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
谷歌
|
SocialConnection | ||
|
GitHub
|
github | SocialConnection |
SocialConnection
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
客户 ID
|
client_id | string |
OAuth2 社交连接的客户端 ID。 |
ElementCustomization
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
通道容器背景色
|
passage_container_background_color | string |
十六进制中的容器背景色。 默认值为 |
|
通道容器最大宽度
|
passage_container_max_width | integer |
容器的最大宽度(px)。 |
|
通道输入框背景色
|
passage_input_box_background_color | string |
十六进制中的输入框背景色。 默认值为 |
|
通道输入框边框半径
|
passage_input_box_border_radius | integer |
输入框边框半径(px)。 |
|
字体
|
passage_header_font_family | FontFamily |
正文字体系列。 |
|
字体
|
passage_body_font_family | FontFamily |
正文字体系列。 |
|
段落标题文本颜色
|
passage_header_text_color | string |
十六进制中的标题文本颜色。 默认值为 |
|
段落正文文本颜色
|
passage_body_text_color | string |
十六进制中的正文文本颜色。 默认值为 |
|
通道主按钮背景色
|
passage_primary_button_background_color | string |
主要按钮背景色(十六进制)。 |
|
段落主按钮文本颜色
|
passage_primary_button_text_color | string |
主要按钮字体颜色(十六进制)。 |
|
通道主按钮悬停颜色
|
passage_primary_button_hover_color | string |
悬停时的主要按钮背景(十六进制)。 |
|
通道主按钮边框半径
|
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 |
辅助按钮背景色(十六进制)。 |
|
段落辅助屁股文本颜色
|
passage_secondary_button_text_color | string |
辅助按钮字体颜色(十六进制)。 |
|
悬停时段落辅助按钮 Backgroun
|
passage_secondary_button_hover_color | string |
悬停时辅助按钮背景(十六进制)。 |
|
通道辅助按钮边框半径
|
passage_secondary_button_border_radius | integer |
辅助按钮边框半径(px)。 |
|
通道辅助按钮边框颜色
|
passage_secondary_button_border_color | string |
辅助按钮边框颜色。 |
|
通道辅助按钮边框宽度
|
passage_secondary_button_border_width | integer |
辅助按钮边框宽度(px)。 |
FontFamily
AuthMethods
表示允许此应用用于配置身份验证的方法。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Passkeys 身份验证方法
|
passkeys | PasskeysAuthMethod |
passkeys 身份验证方法对象。 |
|
otp
|
otp | OtpAuthMethod | |
|
magic_link
|
magic_link | MagicLinkAuthMethod |
PasskeysAuthMethod
passkeys 身份验证方法对象。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Passkeys 身份验证方法
|
object |
passkeys 身份验证方法对象。 |
OtpAuthMethod
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
TTL
|
ttl | integer |
身份验证过期的最长时间(以秒为单位)。 |
|
TTL 显示单位
|
ttl_display_unit | TtlDisplayUnit |
已弃用的属性。 用于显示 TTL 的首选单位。 此值仅用于显示。
*
|
MagicLinkAuthMethod
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
TTL
|
ttl | integer |
身份验证过期的最长时间(以秒为单位)。 |
|
TTL 显示单位
|
ttl_display_unit | TtlDisplayUnit |
已弃用的属性。 用于显示 TTL 的首选单位。 此值仅用于显示。
*
|
TtlDisplayUnit
已弃用的属性。 用于显示 TTL 的首选单位。 此值仅用于显示。
*
s - 秒 * - 分钟 * mh - 小时 * d - 天 。
已弃用的属性。 用于显示 TTL 的首选单位。 此值仅用于显示。
*
s - 秒 * - 分钟 * mh - 小时 * d - 天 。
- TTL 显示单位
- string
JWKResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
JWK 响应密钥
|
keys | array of JWKResponse_keys |
OpenIdConfiguration
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
授权终结点
|
authorization_endpoint | string |
授权终结点。 |
|
发行人
|
issuer | string |
颁发者。 |
|
JWK URI
|
jwks_uri | string |
JWK URI。 |
CurrentUserResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
用户
|
user | CurrentUser |
凭证
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
创建时间
|
created_at | string |
首次使用此 WebAuthn 设备对用户进行身份验证。 |
|
Cred ID
|
cred_id | string |
此 WebAuthn 设备的 Cred ID(编码以匹配存储在psg_cred_obj中的内容)。 |
|
友好名称
|
friendly_name | string |
用于进行身份验证的 WebAuthn 设备的友好名称。 |
|
ID
|
id | string |
用于身份验证的 WebAuthn 设备的 ID。 |
|
上次登录时间
|
last_login_at | string |
上次使用此 WebAuthn 设备对用户进行身份验证的时间。 |
|
WebAuthn 类型
|
type | WebAuthnType |
此凭据的类型。 |
|
已更新时间
|
updated_at | string |
上次更新此 WebAuthn 设备的时间。 |
|
使用情况计数
|
usage_count | integer |
此 WebAuthn 设备用于对用户进行身份验证的次数。 |
|
用户 ID
|
user_id | string |
此 WebAuthn 设备的 userID。 |
|
图标
|
icons | WebAuthnIcons |
包含表示这些设备品牌的浅色和深色 SVG 图标值可以为 null 或 base64 编码 SVG。 SVG 输出示例:data:image/svg+xml;base64、PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDE5MiAxOTIiIGhlaWdodD0iMjRweCIgdmlld0JveD0iMCAwIDE5MiAxOTIiIHdpZHRoPSIyNHB4Ij48cmVjdCBmaWxsPSJub25lIiBoZWlnaHQ9IjE5MiIgd2lkdGg9IjE5MiIgeT0iMCIvPjxnPjxwYXRoIGQ9Ik02OS4yOSwxMDZjLTMuNDYsNS45Ny05LjkxLDEwLTE3LjI5LDEwYy0xMS4wMywwLTIwLTguOTctMjAtMjBzOC45Ny0yMCwyMC0yMCBjNy4zOCwwLDEzLjgzLDQuMDMsMTcuMjksMTBoMjUuNTVDOTAuMyw2Ni41NCw3Mi44Miw1Miw1Miw1MkMyNy43NCw1Miw4LDcxLjc0LDgsOTZzMTkuNzQsNDQsNDQsNDRjMjAuODIsMCwzOC4zLTE0LjU0LDQyLjg0LTM0IEg2OS4yOXoiIGZpbGw9IiM0Mjg1RjQiLz48cmVjdCBmaWxsPSIjRkJCQzA0IiBoZWlnaHQ9IjI0IiB3aWR0aD0iNDQiIHg9Ijk0IiB5PSI4NCIvPjxwYXRoIGQ9Ik05NC4zMiw4NEg2OHYwLjA1YzIuNSwzLjM0LDQsNy40Nyw0LDExLjk1cy0xLjUsOC42MS00LDExLjk1VjEwOGgyNi4zMiBjMS4wOC0zLjgyLDEuNjgtNy44NCwxLjY4LTEyUzk1LjQxLDg3LjgyLDk0LjMyLDg0eiIgZmlsbD0iI0VBNDMzNSIvPjxwYXRoIGQ9Ik0xODQsMTA2djI2aC0xNnYtOGMwLTQuNDItMy41OC04LTgtOHMtOCwzLjU4LTgsOHY4aC0xNnYtMjZIMTg0eiIgZmlsbD0iIzM0QTg1MyIvPjxyZWN0IGZpbGw9IiMxODgwMzgiIGhlaWdodD0iMjQiIHdpZHRoPSI0OCIgeD0iMTM2IiB5PSI4NCIvPjwvZz48L3N2Zz4= |
当前用户
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
创建时间
|
created_at | string |
创建此用户时。 |
|
Email
|
string |
用户的电子邮件。 |
|
|
已验证的电子邮件
|
email_verified | boolean |
是否已验证用户的电子邮件。 |
|
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 | Credential |
AddDeviceStartResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
握手
|
handshake | CredentialCreationChallenge | |
|
用户
|
user | User |
MagicLinkResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
magic_link
|
magic_link | MagicLink |
MagicLink
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | string |
magic 链接标识符。 |
UserMetadataResponse
LoginMagicLinkResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
magic_link
|
magic_link | MagicLink |
RegisterMagicLinkResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
magic_link
|
magic_link | MagicLink |
UserResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
用户
|
user | User |
LoginWebAuthnStartResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
握手
|
handshake | CredentialAssertionChallenge | |
|
用户
|
user | User |
CredentialAssertionChallenge
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
挑战
|
challenge | protocol.CredentialAssertion | |
|
ID
|
id | string |
标识符。 |
协议。CredentialAssertion
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
publicKey
|
publicKey | protocol.CredentialAssertion_publicKey |
WebAuthnIcons
包含表示这些设备品牌的浅色和深色 SVG 图标值可以为 null 或 base64 编码 SVG。 SVG 输出示例:data:image/svg+xml;base64、PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDE5MiAxOTIiIGhlaWdodD0iMjRweCIgdmlld0JveD0iMCAwIDE5MiAxOTIiIHdpZHRoPSIyNHB4Ij48cmVjdCBmaWxsPSJub25lIiBoZWlnaHQ9IjE5MiIgd2lkdGg9IjE5MiIgeT0iMCIvPjxnPjxwYXRoIGQ9Ik02OS4yOSwxMDZjLTMuNDYsNS45Ny05LjkxLDEwLTE3LjI5LDEwYy0xMS4wMywwLTIwLTguOTctMjAtMjBzOC45Ny0yMCwyMC0yMCBjNy4zOCwwLDEzLjgzLDQuMDMsMTcuMjksMTBoMjUuNTVDOTAuMyw2Ni41NCw3Mi44Miw1Miw1Miw1MkMyNy43NCw1Miw4LDcxLjc0LDgsOTZzMTkuNzQsNDQsNDQsNDRjMjAuODIsMCwzOC4zLTE0LjU0LDQyLjg0LTM0IEg2OS4yOXoiIGZpbGw9IiM0Mjg1RjQiLz48cmVjdCBmaWxsPSIjRkJCQzA0IiBoZWlnaHQ9IjI0IiB3aWR0aD0iNDQiIHg9Ijk0IiB5PSI4NCIvPjxwYXRoIGQ9Ik05NC4zMiw4NEg2OHYwLjA1YzIuNSwzLjM0LDQsNy40Nyw0LDExLjk1cy0xLjUsOC42MS00LDExLjk1VjEwOGgyNi4zMiBjMS4wOC0zLjgyLDEuNjgtNy44NCwxLjY4LTEyUzk1LjQxLDg3LjgyLDk0LjMyLDg0eiIgZmlsbD0iI0VBNDMzNSIvPjxwYXRoIGQ9Ik0xODQsMTA2djI2aC0xNnYtOGMwLTQuNDItMy41OC04LTgtOHMtOCwzLjU4LTgsOHY4aC0xNnYtMjZIMTg0eiIgZmlsbD0iIzM0QTg1MyIvPjxyZWN0IGZpbGw9IiMxODgwMzgiIGhlaWdodD0iMjQiIHdpZHRoPSI0OCIgeD0iMTM2IiB5PSI4NCIvPjwvZz48L3N2Zz4=
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
浅色图标
|
light | string |
浅色图标。 |
|
深色图标
|
dark | string |
深色图标。 |
OneTimePasscodeResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
OTP ID
|
otp_id | string |
一次性密码的 ID。 激活时请提供它。 |
RegisterWebAuthnStartResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
握手
|
handshake | CredentialCreationChallenge | |
|
用户
|
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 |
已连接社交用户的电子邮件。 |
GithubSocialConnection
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
提供程序 ID
|
provider_id | string |
社交连接的外部 ID。 |
|
创建时间
|
created_at | date-time |
创建时。 |
|
上次登录时间
|
last_login_at | date-time |
上次登录名。 |
|
提供程序 ID
|
provider_identifier | string |
已连接社交用户的电子邮件。 |
UserSocialConnections
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
谷歌
|
GoogleSocialConnection | ||
|
GitHub
|
github | GithubSocialConnection |
UserStatus
WebAuthnType
CredentialCreation
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
publicKey
|
publicKey | CredentialCreation_publicKey |
CredentialCreationChallenge
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
挑战
|
challenge | CredentialCreation | |
|
ID
|
id | string |
标识符。 |
用户
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Email
|
string |
电子邮件地址。 |
|
|
已验证的电子邮件
|
email_verified | boolean |
是否已验证用户的电子邮件。 |
|
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
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
算法
|
alg | string |
密钥的算法。 |
|
Exponent
|
e | string |
标准 pem 的指数。 |
|
密钥 ID
|
kid | string |
密钥的唯一标识符。 |
|
键类型
|
kty | string | |
|
Modulus
|
n | string |
标准 pem 的模数。 |
|
Use
|
use | string |
密钥的使用方式(即“sig”表示签名) |
协议。CredentialAssertion_publicKey
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
挑战
|
challenge | string |
挑战。 |
|
RP ID
|
rpId | string |
RP 标识符。 |
|
超时
|
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
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
算法
|
alg | integer |
算法。 |
|
类型
|
type | string |
类型。 |
CredentialCreation_publicKey_rp
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
图标
|
icon | string |
解析为与实体关联的图像的序列化 URL。 例如,这可能是用户的头像或信赖方的徽标。 此 URL 必须是事先经过身份验证的 URL。 验证器必须接受并存储图标成员值的 128 字节最小长度。 如果验证器长度大于 128 字节,则验证器可能会忽略图标成员的值。 URL 的方案可能是“数据”,以避免提取 URL,但代价是需要更多存储。 已弃用:这已从规范建议中删除。 |
|
ID
|
id | string |
信赖方实体的唯一标识符,用于设置 RP ID。 |
|
Name
|
name | string |
实体的可口名称。 其函数取决于 PublicKeyCredentialEntity 所表示的内容:当由 PublicKeyCredentialRpEntity 继承时,它是信赖方的可理解标识符,仅用于显示。 例如,“ACME Corporation”、“Wonderful Widgets, Inc.”或“ОАО Примертех”。 当由 PublicKeyCredentialUserEntity 继承时,它是用户帐户的可理解标识符。 它仅用于显示,即帮助用户确定具有类似 displayName 的用户帐户之间的差异。 例如,“alexm”、“”alex.p.mueller@example.com或“+14255551234”。 |
CredentialCreation_publicKey_user
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
显示名称
|
displayName | string |
用户帐户的用户可口名称,仅用于显示。 信赖方 SHOULD 允许用户选择此项,不应限制所选内容超过必要。 |
|
图标
|
icon | string |
解析为与实体关联的图像的序列化 URL。 例如,这可能是用户的头像或信赖方的徽标。 此 URL 必须是事先经过身份验证的 URL。 验证器必须接受并存储图标成员值的 128 字节最小长度。 如果验证器长度大于 128 字节,则验证器可能会忽略图标成员的值。 URL 的方案可能是“数据”,以避免提取 URL,但代价是需要更多存储。 已弃用:这已从规范建议中删除。 |
|
ID
|
id | object |
用户帐户实体的用户句柄。 为了确保安全作,必须基于此 ID 成员(而不是 displayName 或名称成员)做出身份验证和授权决策。 请参阅 RFC8266第 6.1 节。 |
|
Name
|
name | string |
实体的可口名称。 其函数取决于 PublicKeyCredentialEntity 所表示的内容:当由 PublicKeyCredentialRpEntity 继承时,它是信赖方的可理解标识符,仅用于显示。 例如,“ACME Corporation”、“Wonderful Widgets, Inc.”或“ОАО Примертех”。 当由 PublicKeyCredentialUserEntity 继承时,它是用户帐户的可理解标识符。 它仅用于显示,即帮助用户确定具有类似 displayName 的用户帐户之间的差异。 例如,“alexm”、“”alex.p.mueller@example.com或“+14255551234”。 |
CredentialCreation_publicKey
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Attestation
|
attestation | string |
证明。 |
|
authenticatorSelection
|
authenticatorSelection | CredentialCreation_publicKey_authenticatorSelection | |
|
挑战
|
challenge | string |
混沌。 |
|
排除的凭据
|
excludeCredentials | array of CredentialCreation_publicKey_excludeCredentials | |
|
公钥 Cred Params
|
pubKeyCredParams | array of CredentialCreation_publicKey_pubKeyCredParams | |
|
rp
|
rp | CredentialCreation_publicKey_rp | |
|
超时
|
timeout | integer |
超时。 |
|
用户
|
user | CredentialCreation_publicKey_user |