azure-docs-sdk-java/docs-ref-autogen/com.azure.identity.OnBehalf...

187 строки
21 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.identity.OnBehalfOfCredentialBuilder"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder"
name: "OnBehalfOfCredentialBuilder"
nameWithType: "OnBehalfOfCredentialBuilder"
summary: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.OnBehalfOfCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OnBehalfOfCredential\"></xref>."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.identity.AadCredentialBuilderBase?alt=com.azure.identity.AadCredentialBuilderBase&text=AadCredentialBuilderBase\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.additionallyAllowedTenants(java.lang.String...)?alt=com.azure.identity.AadCredentialBuilderBase.additionallyAllowedTenants&text=additionallyAllowedTenants\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.additionallyAllowedTenants(java.util.List<java.lang.String>)?alt=com.azure.identity.AadCredentialBuilderBase.additionallyAllowedTenants&text=additionallyAllowedTenants\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.authorityHost(java.lang.String)?alt=com.azure.identity.AadCredentialBuilderBase.authorityHost&text=authorityHost\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.clientId(java.lang.String)?alt=com.azure.identity.AadCredentialBuilderBase.clientId&text=clientId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.disableInstanceDiscovery()?alt=com.azure.identity.AadCredentialBuilderBase.disableInstanceDiscovery&text=disableInstanceDiscovery\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.enableUnsafeSupportLogging()?alt=com.azure.identity.AadCredentialBuilderBase.enableUnsafeSupportLogging&text=enableUnsafeSupportLogging\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.executorService(java.util.concurrent.ExecutorService)?alt=com.azure.identity.AadCredentialBuilderBase.executorService&text=executorService\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.tenantId(java.lang.String)?alt=com.azure.identity.AadCredentialBuilderBase.tenantId&text=tenantId\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"com.azure.identity.CredentialBuilderBase?alt=com.azure.identity.CredentialBuilderBase&text=CredentialBuilderBase\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.identity.CredentialBuilderBase.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)?alt=com.azure.identity.CredentialBuilderBase.addPolicy&text=addPolicy\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.clientOptions(com.azure.core.util.ClientOptions)?alt=com.azure.identity.CredentialBuilderBase.clientOptions&text=clientOptions\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.configuration(com.azure.core.util.Configuration)?alt=com.azure.identity.CredentialBuilderBase.configuration&text=configuration\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.enableAccountIdentifierLogging()?alt=com.azure.identity.CredentialBuilderBase.enableAccountIdentifierLogging&text=enableAccountIdentifierLogging\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.httpClient(com.azure.core.http.HttpClient)?alt=com.azure.identity.CredentialBuilderBase.httpClient&text=httpClient\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)?alt=com.azure.identity.CredentialBuilderBase.httpLogOptions&text=httpLogOptions\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.httpPipeline(com.azure.core.http.HttpPipeline)?alt=com.azure.identity.CredentialBuilderBase.httpPipeline&text=httpPipeline\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.maxRetry(int)?alt=com.azure.identity.CredentialBuilderBase.maxRetry&text=maxRetry\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.pipeline(com.azure.core.http.HttpPipeline)?alt=com.azure.identity.CredentialBuilderBase.pipeline&text=pipeline\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.proxyOptions(com.azure.core.http.ProxyOptions)?alt=com.azure.identity.CredentialBuilderBase.proxyOptions&text=proxyOptions\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.retryOptions(com.azure.core.http.policy.RetryOptions)?alt=com.azure.identity.CredentialBuilderBase.retryOptions&text=retryOptions\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.retryPolicy(com.azure.core.http.policy.RetryPolicy)?alt=com.azure.identity.CredentialBuilderBase.retryPolicy&text=retryPolicy\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.identity.CredentialBuilderBase.retryTimeout(java.util.function.Function<java.time.Duration,java.time.Duration>)?alt=com.azure.identity.CredentialBuilderBase.retryTimeout&text=retryTimeout\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **OnBehalfOfCredentialBuilder**</br> extends <xref href=\"com.azure.identity.AadCredentialBuilderBase?alt=com.azure.identity.AadCredentialBuilderBase&text=AadCredentialBuilderBase\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.identity.OnBehalfOfCredentialBuilder?alt=com.azure.identity.OnBehalfOfCredentialBuilder&text=OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.identity.OnBehalfOfCredentialBuilder.OnBehalfOfCredentialBuilder()"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder.OnBehalfOfCredentialBuilder()"
name: "OnBehalfOfCredentialBuilder()"
nameWithType: "OnBehalfOfCredentialBuilder.OnBehalfOfCredentialBuilder()"
summary: "Constructs an instance of On<wbr>Behalf<wbr>OfCredential<wbr>Builder."
syntax: "public OnBehalfOfCredentialBuilder()"
desc: "Constructs an instance of OnBehalfOfCredentialBuilder."
methods:
- uid: "com.azure.identity.OnBehalfOfCredentialBuilder.build()"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder.build()"
name: "build()"
nameWithType: "OnBehalfOfCredentialBuilder.build()"
summary: "Creates a new <xref uid=\"com.azure.identity.OnBehalfOfCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OnBehalfOfCredential\"></xref> with the current configurations."
syntax: "public OnBehalfOfCredential build()"
desc: "Creates a new <xref uid=\"com.azure.identity.OnBehalfOfCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OnBehalfOfCredential\"></xref> with the current configurations."
returns:
description: "a <xref uid=\"com.azure.identity.OnBehalfOfCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OnBehalfOfCredential\"></xref> with the current configurations."
type: "<xref href=\"com.azure.identity.OnBehalfOfCredential?alt=com.azure.identity.OnBehalfOfCredential&text=OnBehalfOfCredential\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.OnBehalfOfCredentialBuilder.clientAssertion(java.util.function.Supplier<java.lang.String>)"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder.clientAssertion(Supplier<String> clientAssertionSupplier)"
name: "clientAssertion(Supplier<String> clientAssertionSupplier)"
nameWithType: "OnBehalfOfCredentialBuilder.clientAssertion(Supplier<String> clientAssertionSupplier)"
summary: "Sets the supplier containing the logic to supply the client assertion when invoked."
parameters:
- description: "the supplier supplying client assertion."
name: "clientAssertionSupplier"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html\">Supplier</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public OnBehalfOfCredentialBuilder clientAssertion(Supplier<String> clientAssertionSupplier)"
desc: "Sets the supplier containing the logic to supply the client assertion when invoked."
returns:
description: "An updated instance of this builder."
type: "<xref href=\"com.azure.identity.OnBehalfOfCredentialBuilder?alt=com.azure.identity.OnBehalfOfCredentialBuilder&text=OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.OnBehalfOfCredentialBuilder.clientCertificatePassword(java.lang.String)"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder.clientCertificatePassword(String clientCertificatePassword)"
name: "clientCertificatePassword(String clientCertificatePassword)"
nameWithType: "OnBehalfOfCredentialBuilder.clientCertificatePassword(String clientCertificatePassword)"
summary: "Sets the password of the client certificate for authenticating to Microsoft Entra ID."
parameters:
- description: "the password protecting the certificate"
name: "clientCertificatePassword"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public OnBehalfOfCredentialBuilder clientCertificatePassword(String clientCertificatePassword)"
desc: "Sets the password of the client certificate for authenticating to Microsoft Entra ID."
returns:
description: "An updated instance of this builder."
type: "<xref href=\"com.azure.identity.OnBehalfOfCredentialBuilder?alt=com.azure.identity.OnBehalfOfCredentialBuilder&text=OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.OnBehalfOfCredentialBuilder.clientSecret(java.lang.String)"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder.clientSecret(String clientSecret)"
name: "clientSecret(String clientSecret)"
nameWithType: "OnBehalfOfCredentialBuilder.clientSecret(String clientSecret)"
summary: "Sets the client secret for the authentication."
parameters:
- description: "the secret value of the Microsoft Entra application."
name: "clientSecret"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public OnBehalfOfCredentialBuilder clientSecret(String clientSecret)"
desc: "Sets the client secret for the authentication."
returns:
description: "An updated instance of this builder."
type: "<xref href=\"com.azure.identity.OnBehalfOfCredentialBuilder?alt=com.azure.identity.OnBehalfOfCredentialBuilder&text=OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.OnBehalfOfCredentialBuilder.pemCertificate(java.lang.String)"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder.pemCertificate(String pemCertificatePath)"
name: "pemCertificate(String pemCertificatePath)"
nameWithType: "OnBehalfOfCredentialBuilder.pemCertificate(String pemCertificatePath)"
summary: "Sets the path of the PEM certificate for authenticating to Microsoft Entra ID."
parameters:
- description: "the PEM file containing the certificate"
name: "pemCertificatePath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public OnBehalfOfCredentialBuilder pemCertificate(String pemCertificatePath)"
desc: "Sets the path of the PEM certificate for authenticating to Microsoft Entra ID."
returns:
description: "An updated instance of this builder."
type: "<xref href=\"com.azure.identity.OnBehalfOfCredentialBuilder?alt=com.azure.identity.OnBehalfOfCredentialBuilder&text=OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.OnBehalfOfCredentialBuilder.pfxCertificate(java.lang.String)"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder.pfxCertificate(String pfxCertificatePath)"
name: "pfxCertificate(String pfxCertificatePath)"
nameWithType: "OnBehalfOfCredentialBuilder.pfxCertificate(String pfxCertificatePath)"
summary: "Sets the path and password of the PFX certificate for authenticating to Microsoft Entra ID."
parameters:
- description: "the password protected PFX file containing the certificate"
name: "pfxCertificatePath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public OnBehalfOfCredentialBuilder pfxCertificate(String pfxCertificatePath)"
desc: "Sets the path and password of the PFX certificate for authenticating to Microsoft Entra ID."
returns:
description: "An updated instance of this builder."
type: "<xref href=\"com.azure.identity.OnBehalfOfCredentialBuilder?alt=com.azure.identity.OnBehalfOfCredentialBuilder&text=OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.OnBehalfOfCredentialBuilder.sendCertificateChain(boolean)"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder.sendCertificateChain(boolean sendCertificateChain)"
name: "sendCertificateChain(boolean sendCertificateChain)"
nameWithType: "OnBehalfOfCredentialBuilder.sendCertificateChain(boolean sendCertificateChain)"
summary: "Specifies if the x5c claim (public key of the certificate) should be sent as part of the authentication request and enable subject name / issuer based authentication."
parameters:
- description: "the flag to indicate if certificate chain should be sent as part of authentication\n request."
name: "sendCertificateChain"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public OnBehalfOfCredentialBuilder sendCertificateChain(boolean sendCertificateChain)"
desc: "Specifies if the x5c claim (public key of the certificate) should be sent as part of the authentication request and enable subject name / issuer based authentication. The default value is false."
returns:
description: "An updated instance of this builder."
type: "<xref href=\"com.azure.identity.OnBehalfOfCredentialBuilder?alt=com.azure.identity.OnBehalfOfCredentialBuilder&text=OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.OnBehalfOfCredentialBuilder.tokenCachePersistenceOptions(com.azure.identity.TokenCachePersistenceOptions)"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder.tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)"
name: "tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)"
nameWithType: "OnBehalfOfCredentialBuilder.tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)"
summary: "Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default."
parameters:
- description: "the token cache configuration options"
name: "tokenCachePersistenceOptions"
type: "<xref href=\"com.azure.identity.TokenCachePersistenceOptions?alt=com.azure.identity.TokenCachePersistenceOptions&text=TokenCachePersistenceOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public OnBehalfOfCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)"
desc: "Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default. If configured, the credential will store tokens in a cache persisted to the machine, protected to the current user, which can be shared by other credentials and processes."
returns:
description: "An updated instance of this builder with the token cache options configured."
type: "<xref href=\"com.azure.identity.OnBehalfOfCredentialBuilder?alt=com.azure.identity.OnBehalfOfCredentialBuilder&text=OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.OnBehalfOfCredentialBuilder.userAssertion(java.lang.String)"
fullName: "com.azure.identity.OnBehalfOfCredentialBuilder.userAssertion(String userAssertion)"
name: "userAssertion(String userAssertion)"
nameWithType: "OnBehalfOfCredentialBuilder.userAssertion(String userAssertion)"
summary: "Configure the User Assertion Scope to be used for On<wbr>Behalf<wbr>Of Authentication request."
parameters:
- description: "the user assertion access token to be used for On behalf Of authentication flow"
name: "userAssertion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public OnBehalfOfCredentialBuilder userAssertion(String userAssertion)"
desc: "Configure the User Assertion Scope to be used for OnBehalfOf Authentication request."
returns:
description: "An updated instance of this builder with the user assertion scope configured."
type: "<xref href=\"com.azure.identity.OnBehalfOfCredentialBuilder?alt=com.azure.identity.OnBehalfOfCredentialBuilder&text=OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.OnBehalfOfCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OnBehalfOfCredential\"></xref>.\n\nOn Behalf of authentication in Azure is a way for a user or application to authenticate to a service or resource using credentials from another identity provider. This type of authentication is typically used when a user or application wants to access a resource in Azure, but their credentials are managed by a different identity provider, such as an on-premises Active Directory or a third-party identity provider. To use \"On Behalf of\" authentication in Azure, the user must first authenticate to the identity provider using their credentials. The identity provider then issues a security token that contains information about the user and their permissions. This security token is then passed to Azure, which uses it to authenticate the user or application and grant them access to the requested resource. The OnBehalfOfCredential acquires a token with a client secret/certificate and user assertion for a Microsoft Entra application on behalf of a user principal.\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.identity.OnBehalfOfCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.OnBehalfOfCredential\"></xref>, using the <xref uid=\"com.azure.identity.OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.OnBehalfOfCredentialBuilder\"></xref> to configure it. The `tenantId`, `clientId` and `clientSecret` parameters are required to create <xref uid=\"com.azure.identity.OnBehalfOfCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.OnBehalfOfCredential\"></xref>. The `userAssertion` can be optionally specified on the <xref uid=\"com.azure.identity.OnBehalfOfCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OnBehalfOfCredentialBuilder\"></xref>. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.\n\n```java\nTokenCredential onBehalfOfCredential = new OnBehalfOfCredentialBuilder().clientId(\"<app-client-ID>\")\n .clientSecret(\"<app-Client-Secret>\")\n .tenantId(\"<app-tenant-ID>\")\n .userAssertion(\"<user-assertion>\")\n .build();\n```"
metadata: {}
package: "com.azure.identity"
artifact: com.azure:azure-identity:1.14.1