Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AadCredentialBuilderBase<T extends AadCredentialBuilderBase<T>> - Class in com.azure.identity
-
The base class for credential builders that allow specifying a client ID, tenant ID, authority host, and additionally allowed tenants for Microsoft Entra ID.
- AadCredentialBuilderBase() - Constructor for class com.azure.identity.AadCredentialBuilderBase
-
Constructs an instance of AadCredentialBuilderBase.
- addAll(Collection<? extends TokenCredential>) - Method in class com.azure.identity.ChainedTokenCredentialBuilder
-
Adds all of the credentials in the specified collection at the end of this chain, as if by calling
ChainedTokenCredentialBuilder.addLast(TokenCredential)
on each one, in the order that they are returned by the collection's iterator. - addFirst(TokenCredential) - Method in class com.azure.identity.ChainedTokenCredentialBuilder
-
Adds a credential to try to authenticate at the front of the chain.
- additionallyAllowedTenants(String...) - Method in class com.azure.identity.AadCredentialBuilderBase
-
For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
- additionallyAllowedTenants(String...) - Method in class com.azure.identity.AzureCliCredentialBuilder
-
Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
- additionallyAllowedTenants(String...) - Method in class com.azure.identity.AzureDeveloperCliCredentialBuilder
-
Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
- additionallyAllowedTenants(String...) - Method in class com.azure.identity.AzurePowerShellCredentialBuilder
-
Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
- additionallyAllowedTenants(String...) - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
- additionallyAllowedTenants(String...) - Method in class com.azure.identity.DeviceCodeCredentialBuilder
-
For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
- additionallyAllowedTenants(String...) - Method in class com.azure.identity.IntelliJCredentialBuilder
-
Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
- additionallyAllowedTenants(String...) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder
-
For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
- additionallyAllowedTenants(String...) - Method in class com.azure.identity.UsernamePasswordCredentialBuilder
-
For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
- additionallyAllowedTenants(String...) - Method in class com.azure.identity.VisualStudioCodeCredentialBuilder
-
Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
- additionallyAllowedTenants(List<String>) - Method in class com.azure.identity.AadCredentialBuilderBase
-
For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
- additionallyAllowedTenants(List<String>) - Method in class com.azure.identity.AzureCliCredentialBuilder
-
Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
- additionallyAllowedTenants(List<String>) - Method in class com.azure.identity.AzureDeveloperCliCredentialBuilder
-
Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
- additionallyAllowedTenants(List<String>) - Method in class com.azure.identity.AzurePowerShellCredentialBuilder
-
Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
- additionallyAllowedTenants(List<String>) - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
- additionallyAllowedTenants(List<String>) - Method in class com.azure.identity.DeviceCodeCredentialBuilder
-
For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
- additionallyAllowedTenants(List<String>) - Method in class com.azure.identity.IntelliJCredentialBuilder
-
Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
- additionallyAllowedTenants(List<String>) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder
-
For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
- additionallyAllowedTenants(List<String>) - Method in class com.azure.identity.UsernamePasswordCredentialBuilder
-
For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
- additionallyAllowedTenants(List<String>) - Method in class com.azure.identity.VisualStudioCodeCredentialBuilder
-
Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
- addLast(TokenCredential) - Method in class com.azure.identity.ChainedTokenCredentialBuilder
-
Adds a credential to try to authenticate at the last of the chain.
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.identity.CredentialBuilderBase
-
Adds a
pipeline policy
to apply on each request sent. - authenticate() - Method in class com.azure.identity.DeviceCodeCredential
-
Authenticates a user via the device code flow.
- authenticate() - Method in class com.azure.identity.InteractiveBrowserCredential
-
Interactively authenticates a user via the default browser.
- authenticate() - Method in class com.azure.identity.UsernamePasswordCredential
-
Authenticates the user using the specified username and password.
- authenticate(TokenRequestContext) - Method in class com.azure.identity.DeviceCodeCredential
-
Authenticates a user via the device code flow.
- authenticate(TokenRequestContext) - Method in class com.azure.identity.InteractiveBrowserCredential
-
Interactively authenticates a user via the default browser.
- authenticate(TokenRequestContext) - Method in class com.azure.identity.UsernamePasswordCredential
-
Authenticates the user using the specified username and password.
- authenticationRecord(AuthenticationRecord) - Method in class com.azure.identity.DeviceCodeCredentialBuilder
-
Sets the
AuthenticationRecord
captured from a previous authentication. - authenticationRecord(AuthenticationRecord) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder
-
Sets the
AuthenticationRecord
captured from a previous authentication. - authenticationRecord(AuthenticationRecord) - Method in class com.azure.identity.SharedTokenCacheCredentialBuilder
-
Sets the
AuthenticationRecord
captured from a previous authentication. - AuthenticationRecord - Class in com.azure.identity
-
Authentication Record represents the account information of the authenticated account.
- AuthenticationRequiredException - Exception in com.azure.identity
-
The Authentication Required Exception is thrown by
InteractiveBrowserCredential
andDeviceCodeCredential
to indicate to the user that automatic authentication is disabled and authentication needs to be initiated viaInteractiveBrowserCredential.authenticate()
orDeviceCodeCredential.authenticate()
APIs respectively before fetching an access token. - AuthenticationRequiredException(String, TokenRequestContext) - Constructor for exception com.azure.identity.AuthenticationRequiredException
-
Initializes a new instance of the
AuthenticationRequiredException
class. - AuthenticationRequiredException(String, TokenRequestContext, Throwable) - Constructor for exception com.azure.identity.AuthenticationRequiredException
-
Initializes a new instance of the
AuthenticationRequiredException
class. - authorityHost(String) - Method in class com.azure.identity.AadCredentialBuilderBase
-
Specifies the Microsoft Entra endpoint to acquire tokens.
- authorityHost(String) - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
Specifies the Microsoft Entra endpoint to acquire tokens.
- authorityHost(String) - Method in class com.azure.identity.EnvironmentCredentialBuilder
-
Specifies the Microsoft Entra endpoint to acquire tokens.
- authorizationCode(String) - Method in class com.azure.identity.AuthorizationCodeCredentialBuilder
-
Sets the authorization code on the builder.
- AuthorizationCodeCredential - Class in com.azure.identity
-
Authorization Code authentication in Azure is a type of authentication mechanism that allows users to authenticate with Microsoft Entra ID and obtain an authorization code that can be used to request an access token to access Azure resources.
- AuthorizationCodeCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
AuthorizationCodeCredential
. - AuthorizationCodeCredentialBuilder() - Constructor for class com.azure.identity.AuthorizationCodeCredentialBuilder
-
Constructs an instance of AuthorizationCodeCredentialBuilder.
- AZURE_CHINA - Static variable in class com.azure.identity.AzureAuthorityHosts
-
The host of the Microsoft Entra authority for tenants in the Azure China Cloud.
- AZURE_GERMANY - Static variable in class com.azure.identity.AzureAuthorityHosts
-
The host of the Microsoft Entra authority for tenants in the Azure German Cloud.
- AZURE_GOVERNMENT - Static variable in class com.azure.identity.AzureAuthorityHosts
-
The host of the Microsoft Entra authority for tenants in the Azure US Government Cloud.
- AZURE_PUBLIC_CLOUD - Static variable in class com.azure.identity.AzureAuthorityHosts
-
The host of the Microsoft Entra authority for tenants in the Azure Public Cloud.
- AzureAuthorityHosts - Class in com.azure.identity
-
Defines fields exposing the well known authority hosts for the Azure Public Cloud and sovereign clouds.
- AzureCliCredential - Class in com.azure.identity
-
The Azure CLI is a command-line tool that allows users to manage Azure resources from their local machine or terminal.
- AzureCliCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
AzureCliCredential
. - AzureCliCredentialBuilder() - Constructor for class com.azure.identity.AzureCliCredentialBuilder
-
Constructs an instance of AzureCliCredentialBuilder.
- AzureDeveloperCliCredential - Class in com.azure.identity
-
Azure Developer CLI is a command-line interface tool that allows developers to create, manage, and deploy resources in Azure.
- AzureDeveloperCliCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
AzureDeveloperCliCredential
. - AzureDeveloperCliCredentialBuilder() - Constructor for class com.azure.identity.AzureDeveloperCliCredentialBuilder
-
Constructs an instance of AzureDeveloperCliCredentialBuilder.
- AzurePowerShellCredential - Class in com.azure.identity
-
The Azure Powershell is a command-line tool that allows users to manage Azure resources from their local machine or terminal.
- AzurePowerShellCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
AzurePowerShellCredential
. - AzurePowerShellCredentialBuilder() - Constructor for class com.azure.identity.AzurePowerShellCredentialBuilder
-
Constructs an instance of AzurePowerShellCredentialBuilder.
B
- browserCustomizationOptions(BrowserCustomizationOptions) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder
-
Configures the options for customizing the browser for interactive authentication.
- BrowserCustomizationOptions - Class in com.azure.identity
-
Represent Options to customize browser view.
- BrowserCustomizationOptions() - Constructor for class com.azure.identity.BrowserCustomizationOptions
-
Creates an instance of BrowserCustomizationOptions.
- build() - Method in class com.azure.identity.AuthorizationCodeCredentialBuilder
-
Creates a new
AuthorizationCodeCredential
with the current configurations. - build() - Method in class com.azure.identity.AzureCliCredentialBuilder
-
Creates a new
AzureCliCredential
with the current configurations. - build() - Method in class com.azure.identity.AzureDeveloperCliCredentialBuilder
-
Creates a new
AzureDeveloperCliCredential
with the current configurations. - build() - Method in class com.azure.identity.AzurePowerShellCredentialBuilder
-
Creates a new
AzurePowerShellCredential
with the current configurations. - build() - Method in class com.azure.identity.ChainedTokenCredentialBuilder
-
Creates a new
ChainedTokenCredential
with the current configurations. - build() - Method in class com.azure.identity.ClientAssertionCredentialBuilder
-
Creates a new
ClientAssertionCredential
with the current configurations. - build() - Method in class com.azure.identity.ClientCertificateCredentialBuilder
-
Creates a new
ClientCertificateCredential
with the current configurations. - build() - Method in class com.azure.identity.ClientSecretCredentialBuilder
-
Creates a new
ClientCertificateCredential
with the current configurations. - build() - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
Creates new
DefaultAzureCredential
with the configured options set. - build() - Method in class com.azure.identity.DeviceCodeCredentialBuilder
-
Creates a new
DeviceCodeCredential
with the current configurations. - build() - Method in class com.azure.identity.EnvironmentCredentialBuilder
-
Creates a new
EnvironmentCredential
with the current configurations. - build() - Method in class com.azure.identity.IntelliJCredentialBuilder
-
Creates a new
IntelliJCredential
with the current configurations. - build() - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder
-
Creates a new
InteractiveBrowserCredential
with the current configurations. - build() - Method in class com.azure.identity.ManagedIdentityCredentialBuilder
-
Creates a new
ManagedIdentityCredential
with the current configurations. - build() - Method in class com.azure.identity.OnBehalfOfCredentialBuilder
-
Creates a new
OnBehalfOfCredential
with the current configurations. - build() - Method in class com.azure.identity.SharedTokenCacheCredentialBuilder
-
Creates a new
SharedTokenCacheCredentialBuilder
with the current configurations. - build() - Method in class com.azure.identity.UsernamePasswordCredentialBuilder
-
Creates a new
UsernamePasswordCredential
with the current configurations. - build() - Method in class com.azure.identity.VisualStudioCodeCredentialBuilder
-
Creates a new
VisualStudioCodeCredential
with the current configurations. - build() - Method in class com.azure.identity.WorkloadIdentityCredentialBuilder
-
Creates new
WorkloadIdentityCredential
with the configured options set.
C
- ChainedTokenCredential - Class in com.azure.identity
-
The ChainedTokenCredential is a convenience credential that allows users to chain together a set of TokenCredential together.
- ChainedTokenCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
ChainedTokenCredential
. - ChainedTokenCredentialBuilder() - Constructor for class com.azure.identity.ChainedTokenCredentialBuilder
-
Creates an instance of the builder to config the credential.
- challengeConsumer(Consumer<DeviceCodeInfo>) - Method in class com.azure.identity.DeviceCodeCredentialBuilder
-
Sets the consumer to meet the device code challenge.
- clientAssertion(Supplier<String>) - Method in class com.azure.identity.ClientAssertionCredentialBuilder
-
Sets the supplier containing the logic to supply the client assertion when invoked.
- ClientAssertionCredential - Class in com.azure.identity
-
The ClientAssertionCredential acquires a token via client assertion and service principal authentication.
- ClientAssertionCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
ClientAssertionCredential
. - ClientAssertionCredentialBuilder() - Constructor for class com.azure.identity.ClientAssertionCredentialBuilder
-
Constructs an instance of ClientAssertionCredentialBuilder.
- ClientCertificateCredential - Class in com.azure.identity
-
The ClientCertificateCredential acquires a token via service principal authentication.
- ClientCertificateCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
ClientCertificateCredential
. - ClientCertificateCredentialBuilder() - Constructor for class com.azure.identity.ClientCertificateCredentialBuilder
-
Constructs an instance of ClientCertificateCredentialBuilder.
- clientCertificatePassword(String) - Method in class com.azure.identity.ClientCertificateCredentialBuilder
-
Sets the password of the client certificate for authenticating to Microsoft Entra ID.
- clientCertificatePassword(String) - Method in class com.azure.identity.OnBehalfOfCredentialBuilder
-
Sets the password of the client certificate for authenticating to Microsoft Entra ID.
- clientId(String) - Method in class com.azure.identity.AadCredentialBuilderBase
-
Sets the client ID of the application.
- clientId(String) - Method in class com.azure.identity.ManagedIdentityCredentialBuilder
-
Specifies the client ID of user assigned or system assigned identity.
- clientOptions(ClientOptions) - Method in class com.azure.identity.CredentialBuilderBase
-
Allows for setting common properties such as application ID, headers, proxy configuration, etc.
- clientSecret(String) - Method in class com.azure.identity.AuthorizationCodeCredentialBuilder
-
Sets the client secret for the authentication.
- clientSecret(String) - Method in class com.azure.identity.ClientSecretCredentialBuilder
-
Sets the client secret for the authentication.
- clientSecret(String) - Method in class com.azure.identity.OnBehalfOfCredentialBuilder
-
Sets the client secret for the authentication.
- ClientSecretCredential - Class in com.azure.identity
-
The ClientSecretCredential acquires a token via service principal authentication.
- ClientSecretCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
ClientSecretCredential
. - ClientSecretCredentialBuilder() - Constructor for class com.azure.identity.ClientSecretCredentialBuilder
-
Constructs an instance of ClientSecretCredentialBuilder.
- com.azure.identity - package com.azure.identity
-
The Azure Identity library provides Microsoft Entra ID token authentication support across the Azure SDK.
- configuration(Configuration) - Method in class com.azure.identity.CredentialBuilderBase
-
Sets the configuration store that is used during construction of the credential.
- CredentialBuilderBase<T extends CredentialBuilderBase<T>> - Class in com.azure.identity
-
The base class for all the credential builders.
- credentialProcessTimeout(Duration) - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
Specifies a
Duration
timeout for developer credentials (such as Azure CLI) that rely on separate process invocations. - CredentialUnavailableException - Exception in com.azure.identity
-
The exception thrown when a
TokenCredential
did not attempt to authenticate and retrieveAccessToken
, as its prerequisite information or state was not available. - CredentialUnavailableException(String) - Constructor for exception com.azure.identity.CredentialUnavailableException
-
Initializes a new instance of the
CredentialUnavailableException
class. - CredentialUnavailableException(String, Throwable) - Constructor for exception com.azure.identity.CredentialUnavailableException
-
Initializes a new instance of the
CredentialUnavailableException
class.
D
- DefaultAzureCredential - Class in com.azure.identity
-
The DefaultAzureCredential is appropriate for most scenarios where the application is intended to ultimately be run in Azure.
- DefaultAzureCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
DefaultAzureCredential
. - DefaultAzureCredentialBuilder() - Constructor for class com.azure.identity.DefaultAzureCredentialBuilder
-
Creates an instance of a DefaultAzureCredentialBuilder.
- deserialize(InputStream) - Static method in class com.azure.identity.AuthenticationRecord
-
Deserializes the
AuthenticationRecord
from the specifiedInputStream
- deserializeAsync(InputStream) - Static method in class com.azure.identity.AuthenticationRecord
-
Deserializes the
AuthenticationRecord
from the specifiedInputStream
- DeviceCodeCredential - Class in com.azure.identity
-
Device code authentication is a type of authentication flow offered by Microsoft Entra ID that allows users to sign in to applications on devices that don't have a web browser or a keyboard.
- DeviceCodeCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
DeviceCodeCredential
. - DeviceCodeCredentialBuilder() - Constructor for class com.azure.identity.DeviceCodeCredentialBuilder
-
Constructs an instance of DeviceCodeCredentialBuilder.
- DeviceCodeInfo - Class in com.azure.identity
-
Device Code Info represents the response returned from the device code endpoint containing information necessary for device code flow.
- DeviceCodeInfo(String, String, String, OffsetDateTime, String) - Constructor for class com.azure.identity.DeviceCodeInfo
-
Creates an instance of a device code info.
- disableAutomaticAuthentication() - Method in class com.azure.identity.DeviceCodeCredentialBuilder
-
Disables the automatic authentication and prevents the
DeviceCodeCredential
from automatically prompting the user. - disableAutomaticAuthentication() - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder
-
Disables the automatic authentication and prevents the
InteractiveBrowserCredential
from automatically prompting the user. - disableInstanceDiscovery() - Method in class com.azure.identity.AadCredentialBuilderBase
-
Disables the setting which determines whether or not instance discovery is performed when attempting to authenticate.
- disableInstanceDiscovery() - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
Disables the setting which determines whether or not instance discovery is performed when attempting to authenticate.
E
- enableAccountIdentifierLogging() - Method in class com.azure.identity.CredentialBuilderBase
-
Enables account identifiers to be logged on client side for debugging/monitoring purposes.
- enableUnsafeSupportLogging() - Method in class com.azure.identity.AadCredentialBuilderBase
-
Enables additional support logging for public and confidential client applications.
- EnvironmentCredential - Class in com.azure.identity
-
The EnvironmentCredential is appropriate for scenarios where the application is looking to read credential information from environment variables.
- EnvironmentCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
EnvironmentCredential
. - EnvironmentCredentialBuilder() - Constructor for class com.azure.identity.EnvironmentCredentialBuilder
-
Constructs an instance of EnvironmentCredentialBuilder.
- executorService(ExecutorService) - Method in class com.azure.identity.AadCredentialBuilderBase
-
Specifies the ExecutorService to be used to execute the authentication requests.
- executorService(ExecutorService) - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
Specifies the ExecutorService to be used to execute the authentication requests.
- executorService(ExecutorService) - Method in class com.azure.identity.EnvironmentCredentialBuilder
-
Specifies the ExecutorService to be used to execute the authentication requests.
G
- getAuthority() - Method in class com.azure.identity.AuthenticationRecord
-
Get the authority host used to authenticate the account.
- getClientId() - Method in class com.azure.identity.AuthenticationRecord
-
Get the client id of the application used for authentication.
- getClientId() - Method in class com.azure.identity.ManagedIdentityCredential
-
Gets the client ID of user assigned or system assigned identity.
- getDeviceCode() - Method in class com.azure.identity.DeviceCodeInfo
-
Gets the code which should be included in the request for the access token.
- getErrorMessage() - Method in class com.azure.identity.BrowserCustomizationOptions
-
Get the configured message which the browser will show to the user when the user finishes authenticating, but an error occurred.
- getExpiresOn() - Method in class com.azure.identity.DeviceCodeInfo
-
Gets the expiration time of device code.
- getHomeAccountId() - Method in class com.azure.identity.AuthenticationRecord
-
Get the unique identifier of the account.
- getMessage() - Method in class com.azure.identity.DeviceCodeInfo
-
Gets the message which should be displayed to the user.
- getName() - Method in class com.azure.identity.TokenCachePersistenceOptions
-
Get the name uniquely identifying the cache.
- getSuccessMessage() - Method in class com.azure.identity.BrowserCustomizationOptions
-
Get the configured message which the browser will show to the user when the user finishes authenticating successfully.
- getTenantId() - Method in class com.azure.identity.AuthenticationRecord
-
Get the tenant, which the account authenticated in.
- getToken(TokenRequestContext) - Method in class com.azure.identity.AuthorizationCodeCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.AzureCliCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.AzureDeveloperCliCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.AzurePowerShellCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.ChainedTokenCredential
-
Sequentially calls
TokenCredential.getToken(TokenRequestContext)
on all the specified credentials, returning the first successfully obtainedAccessToken
. - getToken(TokenRequestContext) - Method in class com.azure.identity.ClientAssertionCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.ClientCertificateCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.ClientSecretCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.DeviceCodeCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.EnvironmentCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.IntelliJCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.InteractiveBrowserCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.ManagedIdentityCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.OnBehalfOfCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.SharedTokenCacheCredential
-
Gets token from shared token cache
- getToken(TokenRequestContext) - Method in class com.azure.identity.UsernamePasswordCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.VisualStudioCodeCredential
- getToken(TokenRequestContext) - Method in class com.azure.identity.WorkloadIdentityCredential
- getTokenRequestContext() - Method in exception com.azure.identity.AuthenticationRequiredException
-
Get the details of the authentication request which resulted in the authentication failure.
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.AzureCliCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.AzureDeveloperCliCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.ChainedTokenCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.ClientAssertionCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.ClientCertificateCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.ClientSecretCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.DeviceCodeCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.EnvironmentCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.InteractiveBrowserCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.OnBehalfOfCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.UsernamePasswordCredential
- getTokenSync(TokenRequestContext) - Method in class com.azure.identity.WorkloadIdentityCredential
- getUserCode() - Method in class com.azure.identity.DeviceCodeInfo
-
Gets the code which user needs to provide when authenticating at the verification URL.
- getUsername() - Method in class com.azure.identity.AuthenticationRecord
-
Get the user principal name of the account.
- getVerificationUrl() - Method in class com.azure.identity.DeviceCodeInfo
-
Gets the URL where user can authenticate.
H
- httpClient(HttpClient) - Method in class com.azure.identity.CredentialBuilderBase
-
Sets the HTTP client to use for sending and receiving requests to and from the service.
- httpLogOptions(HttpLogOptions) - Method in class com.azure.identity.CredentialBuilderBase
-
Sets the
logging configuration
to use when sending and receiving requests to and from the service. - httpPipeline(HttpPipeline) - Method in class com.azure.identity.CredentialBuilderBase
-
Deprecated.
I
- IntelliJCredential - Class in com.azure.identity
-
IntelliJ IDEA is an integrated development environment (IDE) developed by JetBrains, which provides a variety of features to support software development, such as code completion, debugging, and testing.
- IntelliJCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
IntelliJCredential
. - IntelliJCredentialBuilder() - Constructor for class com.azure.identity.IntelliJCredentialBuilder
-
Constructs an instance of IntelliJCredentialBuilder.
- intelliJKeePassDatabasePath(String) - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
Specifies the KeePass database path to read the cached credentials of Azure toolkit for IntelliJ plugin.
- InteractiveBrowserCredential - Class in com.azure.identity
-
Interactive browser authentication is a type of authentication flow offered by Microsoft Entra ID that enables users to sign in to applications and services using a web browser.
- InteractiveBrowserCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
InteractiveBrowserCredential
. - InteractiveBrowserCredentialBuilder() - Constructor for class com.azure.identity.InteractiveBrowserCredentialBuilder
-
Constructs an instance of InteractiveBrowserCredentialBuilder.
- isUnencryptedStorageAllowed() - Method in class com.azure.identity.TokenCachePersistenceOptions
-
Gets the status whether unencrypted storage is allowed for the persistent token cache.
K
- keePassDatabasePath(String) - Method in class com.azure.identity.IntelliJCredentialBuilder
-
Specifies the KeePass database path to read the cached credentials of Azure toolkit for IntelliJ plugin.
L
- loginHint(String) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder
-
Sets the username suggestion to pre-fill the login page's username/email address field.
M
- managedIdentityClientId(String) - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
Specifies the client ID of user assigned or system assigned identity, when this credential is running in an environment with managed identities.
- ManagedIdentityCredential - Class in com.azure.identity
-
Azure Managed Identity is a feature in Microsoft Entra ID that provides a way for applications running on Azure to authenticate themselves with Azure resources without needing to manage or store any secrets like passwords or keys.
- ManagedIdentityCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
ManagedIdentityCredential
. - ManagedIdentityCredentialBuilder() - Constructor for class com.azure.identity.ManagedIdentityCredentialBuilder
-
Constructs an instance of ManagedIdentityCredentialBuilder.
- managedIdentityResourceId(String) - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
Specifies the resource ID of user assigned or system assigned identity, when this credential is running in an environment with managed identities.
- maxRetry(int) - Method in class com.azure.identity.CredentialBuilderBase
-
Specifies the max number of retries when an authentication request fails.
O
- OnBehalfOfCredential - Class in com.azure.identity
-
On 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.
- OnBehalfOfCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
OnBehalfOfCredential
. - OnBehalfOfCredentialBuilder() - Constructor for class com.azure.identity.OnBehalfOfCredentialBuilder
-
Constructs an instance of OnBehalfOfCredentialBuilder.
P
- password(String) - Method in class com.azure.identity.UsernamePasswordCredentialBuilder
-
Sets the password of the user.
- pemCertificate(InputStream) - Method in class com.azure.identity.ClientCertificateCredentialBuilder
-
Sets the input stream holding the PEM certificate for authenticating to Microsoft Entra ID.
- pemCertificate(String) - Method in class com.azure.identity.ClientCertificateCredentialBuilder
-
Sets the path of the PEM certificate for authenticating to Microsoft Entra ID.
- pemCertificate(String) - Method in class com.azure.identity.OnBehalfOfCredentialBuilder
-
Sets the path of the PEM certificate for authenticating to Microsoft Entra ID.
- pfxCertificate(InputStream) - Method in class com.azure.identity.ClientCertificateCredentialBuilder
-
Sets the input stream holding the PFX certificate for authenticating to Microsoft Entra ID.
- pfxCertificate(String) - Method in class com.azure.identity.ClientCertificateCredentialBuilder
-
Sets the path of the PFX certificate for authenticating to Microsoft Entra ID.
- pfxCertificate(String) - Method in class com.azure.identity.OnBehalfOfCredentialBuilder
-
Sets the path and password of the PFX certificate for authenticating to Microsoft Entra ID.
- pfxCertificate(String, String) - Method in class com.azure.identity.ClientCertificateCredentialBuilder
-
Deprecated.This API is deprecated and will be removed. Specify the PFX certificate via
ClientCertificateCredentialBuilder.pfxCertificate(String)
API and client certificate password via theClientCertificateCredentialBuilder.clientCertificatePassword(String)
API as applicable. - pipeline(HttpPipeline) - Method in class com.azure.identity.CredentialBuilderBase
-
Sets the
HttpPipeline
to use for the service client. - port(int) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder
-
Deprecated.Configure the redirect URL as
http://localhost:{port}
viaInteractiveBrowserCredentialBuilder.redirectUrl(String)
instead. - processTimeout(Duration) - Method in class com.azure.identity.AzureCliCredentialBuilder
-
Specifies a
Duration
timeout for calling the Azure CLI. - processTimeout(Duration) - Method in class com.azure.identity.AzureDeveloperCliCredentialBuilder
-
Specifies a
Duration
timeout for calling the Azure Developer CLI. - proxyOptions(ProxyOptions) - Method in class com.azure.identity.CredentialBuilderBase
-
Deprecated.Configure the proxy options on the
HttpClient
instead and then set that client on the credential usingCredentialBuilderBase.httpClient(HttpClient)
.
R
- redirectUrl(String) - Method in class com.azure.identity.AuthorizationCodeCredentialBuilder
-
Sets redirect URL for the OAuth 2.0 login request, which must be registered as a valid redirect URL on the application.
- redirectUrl(String) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder
-
Sets the Redirect URL where STS will callback the application with the security code.
- resourceId(String) - Method in class com.azure.identity.ManagedIdentityCredentialBuilder
-
Specifies the resource ID of a user assigned or system assigned identity.
- retryOptions(RetryOptions) - Method in class com.azure.identity.CredentialBuilderBase
-
Sets the
RetryOptions
for all the requests made through the client. - retryPolicy(RetryPolicy) - Method in class com.azure.identity.CredentialBuilderBase
-
Sets the
RetryPolicy
that is used when each request is sent. - retryTimeout(Function<Duration, Duration>) - Method in class com.azure.identity.CredentialBuilderBase
-
Specifies a Function to calculate seconds of timeout on every retried request.
S
- sendCertificateChain(boolean) - Method in class com.azure.identity.ClientCertificateCredentialBuilder
-
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.
- sendCertificateChain(boolean) - Method in class com.azure.identity.OnBehalfOfCredentialBuilder
-
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.
- serialize(OutputStream) - Method in class com.azure.identity.AuthenticationRecord
-
Serializes the
AuthenticationRecord
to the specifiedOutputStream
- serializeAsync(OutputStream) - Method in class com.azure.identity.AuthenticationRecord
-
Serializes the
AuthenticationRecord
to the specifiedOutputStream
- setErrorMessage(String) - Method in class com.azure.identity.BrowserCustomizationOptions
-
Configure the property to set error message which the browser will show to the user upon failed to acquire an access token.
- setName(String) - Method in class com.azure.identity.TokenCachePersistenceOptions
-
Set the name uniquely identifying the cache.
- setSuccessMessage(String) - Method in class com.azure.identity.BrowserCustomizationOptions
-
Configures the property to set the success message which the browser will show to the user upon successful authentication.
- setUnencryptedStorageAllowed(boolean) - Method in class com.azure.identity.TokenCachePersistenceOptions
-
Allows to use an unprotected file specified by
cacheFileLocation()
instead of Gnome keyring on Linux. - SharedTokenCacheCredential - Class in com.azure.identity
-
A credential provider that provides token credentials from the MSAL shared token cache.
- SharedTokenCacheCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
SharedTokenCacheCredential
. - SharedTokenCacheCredentialBuilder() - Constructor for class com.azure.identity.SharedTokenCacheCredentialBuilder
-
Constructs an instance of SharedTokenCacheCredentialBuilder.
T
- tenantId(String) - Method in class com.azure.identity.AadCredentialBuilderBase
-
Sets the tenant ID of the application.
- tenantId(String) - Method in class com.azure.identity.AzureCliCredentialBuilder
-
Sets the tenant ID of the application.
- tenantId(String) - Method in class com.azure.identity.AzureDeveloperCliCredentialBuilder
-
Sets the tenant ID of the application.
- tenantId(String) - Method in class com.azure.identity.AzurePowerShellCredentialBuilder
-
Sets the tenant ID of the application.
- tenantId(String) - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
Sets the tenant id of the user to authenticate through the
DefaultAzureCredential
. - tenantId(String) - Method in class com.azure.identity.IntelliJCredentialBuilder
-
Sets the tenant id of the user to authenticate through the
IntelliJCredential
. - tenantId(String) - Method in class com.azure.identity.VisualStudioCodeCredentialBuilder
-
Sets the tenant id of the user to authenticate through the
VisualStudioCodeCredential
. - tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.ClientAssertionCredentialBuilder
-
Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
- tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.ClientCertificateCredentialBuilder
-
Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
- tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.ClientSecretCredentialBuilder
-
Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
- tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.DeviceCodeCredentialBuilder
-
Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
- tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder
-
Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
- tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.OnBehalfOfCredentialBuilder
-
Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
- tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.SharedTokenCacheCredentialBuilder
-
Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
- tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.UsernamePasswordCredentialBuilder
-
Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
- TokenCachePersistenceOptions - Class in com.azure.identity
-
Represents the Persistence Token Cache options used to setup the persistent access token cache.
- TokenCachePersistenceOptions() - Constructor for class com.azure.identity.TokenCachePersistenceOptions
-
Constructs an instance of TokenCachePersistenceOptions.
- tokenFilePath(String) - Method in class com.azure.identity.WorkloadIdentityCredentialBuilder
-
Configure the path to a file containing a Kubernetes service account token that authenticates the identity.
U
- userAssertion(String) - Method in class com.azure.identity.OnBehalfOfCredentialBuilder
-
Configure the User Assertion Scope to be used for OnBehalfOf Authentication request.
- username(String) - Method in class com.azure.identity.SharedTokenCacheCredentialBuilder
-
Sets the username for the account.
- username(String) - Method in class com.azure.identity.UsernamePasswordCredentialBuilder
-
Sets the username of the user.
- UsernamePasswordCredential - Class in com.azure.identity
-
Username password authentication is a common type of authentication flow used by many applications and services, including Microsoft Entra ID.
- UsernamePasswordCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
UsernamePasswordCredential
. - UsernamePasswordCredentialBuilder() - Constructor for class com.azure.identity.UsernamePasswordCredentialBuilder
-
Constructs an instance of UsernamePasswordCredentialBuilder.
V
- VisualStudioCodeCredential - Class in com.azure.identity
-
Enables authentication to Microsoft Entra ID as the user signed in to Visual Studio Code via the 'Azure Account' extension.
- VisualStudioCodeCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
VisualStudioCodeCredential
. - VisualStudioCodeCredentialBuilder() - Constructor for class com.azure.identity.VisualStudioCodeCredentialBuilder
-
Constructs an instance of VisualStudioCodeCredentialBuilder.
W
- workloadIdentityClientId(String) - Method in class com.azure.identity.DefaultAzureCredentialBuilder
-
Specifies the client ID of Microsoft Entra app to be used for AKS workload identity authentication.
- WorkloadIdentityCredential - Class in com.azure.identity
-
Workload Identity authentication is a feature in Azure that allows applications running on virtual machines (VMs) to access other Azure resources without the need for a service principal or managed identity.
- WorkloadIdentityCredentialBuilder - Class in com.azure.identity
-
Fluent credential builder for instantiating a
WorkloadIdentityCredential
. - WorkloadIdentityCredentialBuilder() - Constructor for class com.azure.identity.WorkloadIdentityCredentialBuilder
-
Creates an instance of a WorkloadIdentityCredentialBuilder.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Use
CredentialBuilderBase.pipeline(HttpPipeline)
instead