AuthorizationUrlRequest type
用户传递的请求对象从服务器检索代码(授权代码授予流的第一回合)
- scopes - 应用程序请求访问的范围数组。
- claims - 字符串化的声明请求,请求将添加到所有 /authorize 和 /token 调用
- authority - 应用程序从中获取令牌的颁发机构的 URL。
- correlationId - 每个请求的唯一 GUID 集,用于跟踪用于遥测目的的请求端到端。
- redirectUri - 应用程序可以接收身份验证响应的重定向 URI。 它必须与在 Azure 门户中注册的其中一个重定向 URI 完全匹配。
- extraScopesToConsent - 当用户需要事先同意时,其他资源的作用域。
- responseMode - 指定用于将身份验证结果发送到应用的方法。 可以是查询、form_post或片段。 如果未传入任何值,则默认为查询。
- codeChallenge - 用于通过代码Exchange(PKCE)的密钥证明来保护授权代码授予。 有关详细信息,请参阅 PKCE RCF:https://tools.ietf.org/html/rfc7636
- codeChallengeMethod - 用于编码代码质询参数的代码验证程序的方法。 可以是“plain”或“S256”。 如果排除,则假定代码质询为纯文本。 有关详细信息,请参阅 PKCE RCF: https://tools.ietf.org/html/rfc7636
- state - 在令牌响应中也返回的请求中包含的值。 随机生成的唯一值通常用于防止跨站点请求伪造攻击。 该状态还用于在身份验证请求发生之前对应用中用户状态的信息进行编码。
- prompt - 指示所需的用户交互类型。 login:将强制用户在该请求上输入其凭据,取消单一登录:将确保用户未显示任何交互式提示。 如果无法通过单一登录完成请求,终结点将返回interaction_required错误同意:用户登录后将触发 OAuth 同意对话框,要求用户向应用授予权限select_account:将中断单一登录=提供帐户选择体验,其中列出了会话中的所有帐户或任何记住的帐户,或者选择使用其他帐户创建的选项: 将用户定向到帐户创建体验而不是登录体验
- account - 从 getAccount API 获取的 AccountInfo。 在某些情况下,如果未提供 loginHint 和 sid 参数,则用于生成login_hint。
- loginHint - 如果提前知道用户名/电子邮件地址,可用于预填充用户的登录页的用户名/电子邮件地址字段。 应用通常在重新身份验证期间使用此参数,使用 preferred_username 声明从以前的登录中提取用户名。
- sid - 会话 ID,会话的唯一标识符。 作为 ID 令牌的可选声明提供。
- domainHint - 提供有关用户应用于登录的租户或域的提示。 域提示的值是租户的已注册域。
- extraQueryParameters - 添加到 /authorize 调用的自定义查询参数的字符串到字符串映射
- tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射
- nonce - ID 令牌中返回的请求中包含的值。 随机生成的唯一值通常用于缓解重播攻击。
type AuthorizationUrlRequest = Partial<
Omit<
CommonAuthorizationUrlRequest,
| "scopes"
| "redirectUri"
| "resourceRequestMethod"
| "resourceRequestUri"
| "authenticationScheme"
| "requestedClaimsHash"
| "storeInCache"
>
> & { redirectUri: string; scopes: string[] }