通过

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

OnBehalfOfCredentialBuilder 类

  • 参考
包:
com.azure.identity
Maven 项目:
com.azure:azure-identity:1.10.4

public class OnBehalfOfCredentialBuilder
extends AadCredentialBuilderBase<OnBehalfOfCredentialBuilder>

用于实例化 的 OnBehalfOfCredentialFluent 凭据生成器。

在 Azure 中代表身份验证是用户或应用程序使用另一个标识提供者提供的凭据向服务或资源进行身份验证的一种方式。 当用户或应用程序想要访问 Azure 中的资源，但其凭据由其他标识提供者（例如本地 Active Directory或第三方标识提供者）管理时，通常会使用这种类型的身份验证。 若要在 Azure 中使用“代表”身份验证，用户必须先使用其凭据向标识提供者进行身份验证。 然后，标识提供者颁发一个安全令牌，其中包含有关用户及其权限的信息。 然后，此安全令牌将传递给 Azure，Azure 使用该令牌对用户或应用程序进行身份验证，并授予他们访问所请求资源的权限。 OnBehalfOfCredential 代表用户主体为 AAD 应用程序获取具有客户端机密/证书和用户断言的令牌。

下面的代码示例演示如何创建 ， OnBehalfOfCredential使用 OnBehalfOfCredentialBuilder 进行配置。 创建 tenantId需要 OnBehalfOfCredential和 clientSecretclientId 参数。 userAssertion可以选择在 上OnBehalfOfCredentialBuilder指定 。 创建此凭据后，它可能会作为“credential”参数传递到许多 Azure SDK for Java 客户端生成器的生成器中。

TokenCredential onBehalfOfCredential = new OnBehalfOfCredentialBuilder()
     .clientId("<app-client-ID>")
     .clientSecret("<app-Client-Secret>")
     .tenantId("<app-tenant-ID>")
     .userAssertion("<user-assertion>")
     .build();

构造函数摘要

构造函数 说明
OnBehalfOfCredentialBuilder()

方法摘要

修饰符和类型 方法和描述
OnBehalfOfCredential build()

OnBehalfOfCredential使用当前配置创建新的 。
OnBehalfOfCredentialBuilder clientCertificatePassword(String clientCertificatePassword)

设置客户端证书的密码，以便向 AAD 进行身份验证。
OnBehalfOfCredentialBuilder clientSecret(String clientSecret)

设置用于身份验证的客户端密码。
OnBehalfOfCredentialBuilder pemCertificate(String pemCertificatePath)

设置用于向 AAD 进行身份验证的 PEM 证书的路径。
OnBehalfOfCredentialBuilder pfxCertificate(String pfxCertificatePath)

设置 PFX 证书的路径和密码，以便对 AAD 进行身份验证。
OnBehalfOfCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

指定是否应将证书) 的 x5c 声明 (公钥作为身份验证请求的一部分发送，并启用基于使用者名称/颁发者的身份验证。
OnBehalfOfCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

配置永久性共享令牌缓存选项，并启用默认禁用的永久性令牌缓存。
OnBehalfOfCredentialBuilder userAssertion(String userAssertion)

配置要用于代表身份验证请求的用户断言范围。

方法继承自 AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

方法继承自 CredentialBuilderBase

addPolicy clientOptions configuration enableAccountIdentifierLogging httpClient httpLogOptions httpPipeline maxRetry pipeline proxyOptions retryOptions retryPolicy retryTimeout

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

构造函数详细信息

OnBehalfOfCredentialBuilder

public OnBehalfOfCredentialBuilder()

方法详细信息

build

public OnBehalfOfCredential build()

OnBehalfOfCredential使用当前配置创建新的 。

Returns:

具有当前配置的 。OnBehalfOfCredential

clientCertificatePassword

public OnBehalfOfCredentialBuilder clientCertificatePassword(String clientCertificatePassword)

设置客户端证书的密码，以便向 AAD 进行身份验证。

Parameters:

clientCertificatePassword - 保护证书的密码

Returns:

此生成器的更新实例。

clientSecret

public OnBehalfOfCredentialBuilder clientSecret(String clientSecret)

设置用于身份验证的客户端密码。

Parameters:

clientSecret - AAD 应用程序的机密值。

Returns:

此生成器的更新实例。

pemCertificate

public OnBehalfOfCredentialBuilder pemCertificate(String pemCertificatePath)

设置用于向 AAD 进行身份验证的 PEM 证书的路径。

Parameters:

pemCertificatePath - 包含证书的 PEM 文件

Returns:

此生成器的更新实例。

pfxCertificate

public OnBehalfOfCredentialBuilder pfxCertificate(String pfxCertificatePath)

设置 PFX 证书的路径和密码，以便对 AAD 进行身份验证。

Parameters:

pfxCertificatePath - 包含证书的密码保护 PFX 文件

Returns:

此生成器的更新实例。

sendCertificateChain

public OnBehalfOfCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

指定是否应将证书) 的 x5c 声明 (公钥作为身份验证请求的一部分发送，并启用基于使用者名称/颁发者的身份验证。 默认值为 false。

Parameters:

sendCertificateChain - 指示证书链是否应作为身份验证请求的一部分发送的标志。

Returns:

此生成器的更新实例。

tokenCachePersistenceOptions

public OnBehalfOfCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

配置永久性共享令牌缓存选项，并启用默认禁用的永久性令牌缓存。 如果已配置，凭据会将令牌存储在保存到计算机的缓存中，该缓存受当前用户保护，可由其他凭据和进程共享。

Parameters:

tokenCachePersistenceOptions - 令牌缓存配置选项

Returns:

此生成器的更新实例，其中配置了令牌缓存选项。

userAssertion

public OnBehalfOfCredentialBuilder userAssertion(String userAssertion)

将用户断言范围配置为用于 OnBehalfOf 身份验证请求。

Parameters:

userAssertion - 要用于代表身份验证流的用户断言访问令牌

Returns:

此生成器的更新实例，其中配置了用户断言范围。

适用于