你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

AuthorizationCodeCredential class

使用通过授权代码流获取的授权代码启用身份验证以Microsoft Entra ID,如Microsoft Entra ID文档中更详细地介绍:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow

构造函数

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

创建 AuthorizationCodeCredential 实例,其中包含使用从 Microsoft Entra ID 获取的身份验证请求访问令牌所需的详细信息。

当前,此凭据的用户必须启动授权代码流,以获取要用于此凭据的授权代码。 此处提供了此流的完整示例:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

创建 AuthorizationCodeCredential 实例,其中包含使用从 Microsoft Entra ID 获取的身份验证请求访问令牌所需的详细信息。

当前,此凭据的用户必须启动授权代码流,以获取要用于此凭据的授权代码。 此处提供了此流的完整示例:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

方法

getToken(string | string[], GetTokenOptions)

使用Microsoft Entra ID进行身份验证,如果成功,则返回访问令牌。 如果身份验证失败,则会引发 CredentialUnavailableError 以及失败的详细信息。

构造函数详细信息

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

创建 AuthorizationCodeCredential 实例,其中包含使用从 Microsoft Entra ID 获取的身份验证请求访问令牌所需的详细信息。

当前,此凭据的用户必须启动授权代码流,以获取要用于此凭据的授权代码。 此处提供了此流的完整示例:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

参数

tenantId

string

Microsoft Entra租户 (目录) ID 或名称。 处理多租户方案时,可以使用“common”。

clientId

string

客户端 (应用程序) 租户中应用注册的 ID。

authorizationCode

string

从授权代码流接收的授权代码。 此授权代码必须尚未用于获取访问令牌。

redirectUri

string

用于请求授权代码的重定向 URI。 必须是为应用注册配置的同一 URI。

options
AuthorizationCodeCredentialOptions

用于配置发出访问令牌请求的客户端的选项。

AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

创建 AuthorizationCodeCredential 实例,其中包含使用从 Microsoft Entra ID 获取的身份验证请求访问令牌所需的详细信息。

当前,此凭据的用户必须启动授权代码流,以获取要用于此凭据的授权代码。 此处提供了此流的完整示例:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

参数

tenantId

string

Microsoft Entra租户 (目录) ID 或名称。 处理多租户方案时,可以使用“common”。

clientId

string

客户端 (应用程序) 租户中应用注册的 ID。

clientSecret

string

为应用注册生成的客户端密码

authorizationCode

string

从授权代码流接收的授权代码。 此授权代码必须尚未用于获取访问令牌。

redirectUri

string

用于请求授权代码的重定向 URI。 必须是为应用注册配置的同一 URI。

options
AuthorizationCodeCredentialOptions

用于配置发出访问令牌请求的客户端的选项。

方法详细信息

getToken(string | string[], GetTokenOptions)

使用Microsoft Entra ID进行身份验证,如果成功,则返回访问令牌。 如果身份验证失败,则会引发 CredentialUnavailableError 以及失败的详细信息。

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

参数

scopes

string | string[]

令牌将有权访问的范围列表。

options
GetTokenOptions

用于配置此 TokenCredential 实现可能发出的任何请求的选项。

返回

Promise<AccessToken>