Skip navigation links
A B C D E F G H I L M N O P R S T U V W 

A

aadAadInstanceDiscoveryResponse() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
aadInstanceDiscoveryResponse(String) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Sets instance discovery response data which will be used for determining tenant discovery endpoint and authority aliases.
AbstractClientApplicationBase - Class in com.microsoft.aad.msal4j
Abstract class containing common methods and properties to both PublicClientApplication and ConfidentialClientApplication.
AbstractClientApplicationBase.Builder<T extends AbstractClientApplicationBase.Builder<T>> - Class in com.microsoft.aad.msal4j
 
accessToken() - Method in interface com.microsoft.aad.msal4j.IAuthenticationResult
 
account() - Method in interface com.microsoft.aad.msal4j.IAuthenticationResult
 
account() - Method in interface com.microsoft.aad.msal4j.ITokenCacheAccessContext
 
account() - Method in class com.microsoft.aad.msal4j.SilentParameters
Account for which you are requesting a token for.
account(IAccount) - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
account() - Method in class com.microsoft.aad.msal4j.TokenCacheAccessContext
 
account(IAccount) - Method in class com.microsoft.aad.msal4j.TokenCacheAccessContext.TokenCacheAccessContextBuilder
 
acquireToken(AuthorizationCodeParameters) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
acquireToken(RefreshTokenParameters) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
acquireToken(ClientCredentialParameters) - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication
 
acquireToken(OnBehalfOfParameters) - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication
 
acquireToken(PublicClientApplication, SilentParameters) - Method in interface com.microsoft.aad.msal4j.IBroker
Acquire a token silently, i.e.
acquireToken(PublicClientApplication, InteractiveRequestParameters) - Method in interface com.microsoft.aad.msal4j.IBroker
Acquire a token interactively, by prompting users to enter their credentials in some way
acquireToken(PublicClientApplication, UserNamePasswordParameters) - Method in interface com.microsoft.aad.msal4j.IBroker
Acquire a token silently, i.e.
acquireToken(ClientCredentialParameters) - Method in interface com.microsoft.aad.msal4j.IConfidentialClientApplication
Acquires tokens from the authority configured in the application, for the confidential client itself.
acquireToken(OnBehalfOfParameters) - Method in interface com.microsoft.aad.msal4j.IConfidentialClientApplication
Acquires an access token for this application (usually a Web API) from the authority configured in the application, in order to access another downstream protected Web API on behalf of a user using the On-Behalf-Of flow.
acquireToken(UserNamePasswordParameters) - Method in interface com.microsoft.aad.msal4j.IPublicClientApplication
Acquires tokens from the authority configured in the application via Username/Password authentication.
acquireToken(IntegratedWindowsAuthenticationParameters) - Method in interface com.microsoft.aad.msal4j.IPublicClientApplication
Acquires tokens from the authority configured in the application via Integrated Windows Authentication.
acquireToken(DeviceCodeFlowParameters) - Method in interface com.microsoft.aad.msal4j.IPublicClientApplication
Acquires security token from the authority using an device code flow.
acquireToken(InteractiveRequestParameters) - Method in interface com.microsoft.aad.msal4j.IPublicClientApplication
Acquires tokens from the authority using authorization code grant.
acquireToken(UserNamePasswordParameters) - Method in class com.microsoft.aad.msal4j.PublicClientApplication
 
acquireToken(IntegratedWindowsAuthenticationParameters) - Method in class com.microsoft.aad.msal4j.PublicClientApplication
 
acquireToken(DeviceCodeFlowParameters) - Method in class com.microsoft.aad.msal4j.PublicClientApplication
 
acquireToken(InteractiveRequestParameters) - Method in class com.microsoft.aad.msal4j.PublicClientApplication
 
acquireTokenSilently(SilentParameters) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
addHeaders(Map<String, List<String>>) - Method in class com.microsoft.aad.msal4j.HttpResponse
 
afterCacheAccess(ITokenCacheAccessContext) - Method in interface com.microsoft.aad.msal4j.ITokenCacheAccessAspect
 
any() - Method in class com.microsoft.aad.msal4j.RequestedClaim
 
applicationName() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
applicationName(String) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Sets application name for telemetry purposes
applicationVersion() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
applicationVersion(String) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Sets application version for telemetry purposes
applyTo(HTTPRequest) - Method in class com.microsoft.aad.msal4j.CustomJWTAuthentication
 
appTokenProvider - Variable in class com.microsoft.aad.msal4j.ConfidentialClientApplication
AppTokenProvider creates a Credential from a function that provides access tokens.
appTokenProvider(Function<AppTokenProviderParameters, CompletableFuture<TokenProviderResult>>) - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication.Builder
 
AppTokenProviderParameters - Class in com.microsoft.aad.msal4j
 
AppTokenProviderParameters(Set<String>, String, String, String) - Constructor for class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
assertion() - Method in interface com.microsoft.aad.msal4j.IClientAssertion
 
authenticationAuthority - Variable in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
AuthenticationErrorCode - Class in com.microsoft.aad.msal4j
Class containing error codes returned by the service or generated by the client
AuthenticationErrorCode() - Constructor for class com.microsoft.aad.msal4j.AuthenticationErrorCode
 
AuthenticationErrorMessage - Class in com.microsoft.aad.msal4j
 
AuthenticationErrorMessage() - Constructor for class com.microsoft.aad.msal4j.AuthenticationErrorMessage
 
authority() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
authority(String) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Set URL of the authenticating authority or security token service (STS) from which MSAL will acquire security tokens.
authorityUrl() - Method in class com.microsoft.aad.msal4j.SilentParameters
Authority for which the application is requesting tokens from.
authorityUrl(String) - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
AUTHORIZATION_PENDING - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
In the context of device code user has not yet authenticated via browser.
authorizationCode() - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters
Authorization code acquired in the first step of OAuth2.0 authorization code flow.
authorizationCode(String) - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
 
AuthorizationCodeParameters - Class in com.microsoft.aad.msal4j
Object containing parameters for authorization code flow.
AuthorizationCodeParameters.AuthorizationCodeParametersBuilder - Class in com.microsoft.aad.msal4j
 
AuthorizationRequestUrlParameters - Class in com.microsoft.aad.msal4j
AuthorizationRequestUrlParameters.Builder - Class in com.microsoft.aad.msal4j
 
autoDetectRegion() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
autoDetectRegion(boolean) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Indicates that the library should attempt to discover the Azure region the application is running in when fetching the instance discovery metadata.
AzureCloudEndpoint - Enum in com.microsoft.aad.msal4j
All the national clouds authenticate users separately in each environment and have separate authentication endpoints.
azureRegion - Variable in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
azureRegion() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
azureRegion(String) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Set the region that the library will use to format authorities in token requests.

B

b2cAuthority(String) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Set URL of the authenticating B2C authority from which MSAL will acquire tokens Valid B2C authorities should look like: https://<something.b2clogin.com/<tenant>/<policy> MSAL Java also supports a legacy B2C authority format, which looks like: https://<host>/tfp/<tenant>/<policy> However, MSAL Java will eventually stop supporting the legacy format.
beforeCacheAccess(ITokenCacheAccessContext) - Method in interface com.microsoft.aad.msal4j.ITokenCacheAccessAspect
 
body() - Method in class com.microsoft.aad.msal4j.HttpRequest
HTTP request body
body() - Method in class com.microsoft.aad.msal4j.HttpResponse
HTTP response body
body(String) - Method in class com.microsoft.aad.msal4j.HttpResponse
HTTP response body
body() - Method in interface com.microsoft.aad.msal4j.IHttpResponse
 
browserRedirectError() - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions
When the the user finishes authenticating, but an error occurred, MSAL will redirect the browser to the given URI.
browserRedirectError(URI) - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions.SystemBrowserOptionsBuilder
 
browserRedirectSuccess() - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions
When the user finishes authenticating, MSAL will redirect the browser to the given URI.
browserRedirectSuccess(URI) - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions.SystemBrowserOptionsBuilder
 
build() - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
 
build() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
 
build() - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder
 
build() - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication.Builder
 
build() - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder
 
build() - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters.IntegratedWindowsAuthenticationParametersBuilder
 
build() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
build() - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters.OnBehalfOfParametersBuilder
 
build() - Method in class com.microsoft.aad.msal4j.PublicClientApplication.Builder
 
build() - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters.RefreshTokenParametersBuilder
 
build() - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
build() - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions.SystemBrowserOptionsBuilder
 
build() - Method in class com.microsoft.aad.msal4j.TokenCacheAccessContext.TokenCacheAccessContextBuilder
 
build() - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters.UserNamePasswordParametersBuilder
 
Builder(String) - Constructor for class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Constructor to create instance of Builder of client application
builder(String, URI) - Static method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters
builder(String, Set<String>) - Static method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
Builder() - Constructor for class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
 
builder(Set<String>) - Static method in class com.microsoft.aad.msal4j.ClientCredentialParameters
builder(String, IClientCredential) - Static method in class com.microsoft.aad.msal4j.ConfidentialClientApplication
Creates instance of Builder of ConfidentialClientApplication
builder(Set<String>, Consumer<DeviceCode>) - Static method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters
builder(Set<String>, String) - Static method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters
builder(URI) - Static method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
 
builder(Set<String>, UserAssertion) - Static method in class com.microsoft.aad.msal4j.OnBehalfOfParameters
builder(String) - Static method in class com.microsoft.aad.msal4j.PublicClientApplication
 
builder(Set<String>, String) - Static method in class com.microsoft.aad.msal4j.RefreshTokenParameters
builder(Set<String>, IAccount) - Static method in class com.microsoft.aad.msal4j.SilentParameters
Builder for SilentParameters
builder(Set<String>) - Static method in class com.microsoft.aad.msal4j.SilentParameters
Deprecated.
This method was used for using cached tokens in client credentials or On-behalf-of flow. Those flows will now by default attempt to use cached the cached tokens, so there is no need to call acquireTokenSilently. This overload will be removed in the next major version.
builder() - Static method in class com.microsoft.aad.msal4j.SystemBrowserOptions
builder() - Static method in class com.microsoft.aad.msal4j.TokenCacheAccessContext
 
builder(Set<String>, String, char[]) - Static method in class com.microsoft.aad.msal4j.UserNamePasswordParameters
Builder for UserNameParameters

C

CACHE_MISS - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
Not found in the cache
CIAM_HOST_SEGMENT - Static variable in class com.microsoft.aad.msal4j.CIAMAuthority
 
CIAMAuthority - Class in com.microsoft.aad.msal4j
 
claims - Variable in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
claims(ClaimsRequest) - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
 
claims() - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters
Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
claims(ClaimsRequest) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
claims() - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters
Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
claims(ClaimsRequest) - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder
 
claims() - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters
Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
claims(ClaimsRequest) - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder
 
claims() - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters
Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
claims(ClaimsRequest) - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters.IntegratedWindowsAuthenticationParametersBuilder
 
claims() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
claims(ClaimsRequest) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
claims() - Method in exception com.microsoft.aad.msal4j.MsalServiceException
Claims included in the claims challenge
claims() - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters
Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
claims(ClaimsRequest) - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters.OnBehalfOfParametersBuilder
 
claims() - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters
Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
claims(ClaimsRequest) - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters.RefreshTokenParametersBuilder
 
claims() - Method in class com.microsoft.aad.msal4j.SilentParameters
Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims.
claims(ClaimsRequest) - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
claims() - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters
Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
claims(ClaimsRequest) - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters.UserNamePasswordParametersBuilder
 
claimsChallenge(String) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
In cases where Azure AD tenant admin has enabled conditional access policies, and the policy has not been met,MsalServiceException will contain claims that need be consented to.
claimsChallenge() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
 
claimsChallenge(String) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
ClaimsRequest - Class in com.microsoft.aad.msal4j
Represents the claims request parameter as an object
ClaimsRequest() - Constructor for class com.microsoft.aad.msal4j.ClaimsRequest
 
clientAuthentication() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
clientAuthentication() - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication
 
clientAuthentication() - Method in class com.microsoft.aad.msal4j.PublicClientApplication
 
clientCapabilities(Set<String>) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
 
clientCapabilities() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
clientCredential() - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters
Overrides the client credentials for this request
clientCredential(IClientCredential) - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder
 
ClientCredentialFactory - Class in com.microsoft.aad.msal4j
Factory for creating client credentials used in confidential client flows.
ClientCredentialFactory() - Constructor for class com.microsoft.aad.msal4j.ClientCredentialFactory
 
ClientCredentialParameters - Class in com.microsoft.aad.msal4j
Object containing parameters for client credential flow.
ClientCredentialParameters.ClientCredentialParametersBuilder - Class in com.microsoft.aad.msal4j
 
clientId() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
clientId() - Method in class com.microsoft.aad.msal4j.DeviceCode
 
clientId(String) - Method in class com.microsoft.aad.msal4j.DeviceCode
 
clientId() - Method in interface com.microsoft.aad.msal4j.ITokenCacheAccessContext
 
clientId() - Method in class com.microsoft.aad.msal4j.TokenCacheAccessContext
 
clientId(String) - Method in class com.microsoft.aad.msal4j.TokenCacheAccessContext.TokenCacheAccessContextBuilder
 
clientSecret() - Method in interface com.microsoft.aad.msal4j.IClientSecret
 
CODE_EXPIRED - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
In the context of device code, this error happens when the device code has expired before the user signed-in on another device (this is usually after 15 min).
codeChallenge(String) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE).
codeChallenge() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
codeChallengeMethod(String) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
The method used to encode the code verifier for the code challenge parameter.
codeChallengeMethod() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
codeVerifier(String) - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
 
codeVerifier() - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters
Code verifier used for PKCE.
com.microsoft.aad.msal4j - package com.microsoft.aad.msal4j
 
ConfidentialClientApplication - Class in com.microsoft.aad.msal4j
Class to be used to acquire tokens for confidential client applications (Web Apps, Web APIs, and daemon applications).
ConfidentialClientApplication.Builder - Class in com.microsoft.aad.msal4j
 
connectTimeoutForDefaultHttpClient(Integer) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Sets the connect timeout value used in HttpsURLConnection connections made by DefaultHttpClient, and is not needed if using a custom HTTP client
connectTimeoutForDefaultHttpClient() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
correlationId(String) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Set optional correlation id to be used by the API.
correlationId() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
correlationId - Variable in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
correlationId(String) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
Identifier used to correlate requests for telemetry purposes.
correlationId() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
correlationId() - Method in class com.microsoft.aad.msal4j.DeviceCode
 
correlationId(String) - Method in class com.microsoft.aad.msal4j.DeviceCode
 
correlationId() - Method in exception com.microsoft.aad.msal4j.MsalServiceException
An ID that can be used to piece up a single authentication flow.
createClientAuthFromClientAssertion(ClientAssertion) - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication
 
createFromCallback(Callable<String>) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientAssertion instance from a provided Callable.
createFromCertificate(InputStream, String) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientCertificate instance from a password-protected certificate.
createFromCertificate(PrivateKey, X509Certificate) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientCertificate instance from a private key/public certificate pair.
createFromCertificateChain(PrivateKey, List<X509Certificate>) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientCertificate instance from a certificate chain.
createFromClientAssertion(String) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientAssertion instance from a JWT token encoded as a base64 URL encoded string.
createFromSecret(String) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientSecret instance from a client secret
CustomJWTAuthentication - Class in com.microsoft.aad.msal4j
 
CustomJWTAuthentication(ClientAuthenticationMethod, ClientAssertion, ClientID) - Constructor for class com.microsoft.aad.msal4j.CustomJWTAuthentication
 

D

deserialize(String) - Method in interface com.microsoft.aad.msal4j.ITokenCache
Deserialize token cache from json
deserialize(String) - Method in class com.microsoft.aad.msal4j.TokenCache
 
DESKTOP_BROWSER_NOT_SUPPORTED - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
MSAL was unable to open the user-default browser.
DeviceCode - Class in com.microsoft.aad.msal4j
Response returned from the STS device code endpoint containing information necessary for device code flow
DeviceCode() - Constructor for class com.microsoft.aad.msal4j.DeviceCode
 
deviceCode() - Method in class com.microsoft.aad.msal4j.DeviceCode
code which should be included in the request for the access token
deviceCodeConsumer() - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters
Receives the device code returned from the first step of Oauth2.0 device code flow.
deviceCodeConsumer(Consumer<DeviceCode>) - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder
 
DeviceCodeFlowParameters - Class in com.microsoft.aad.msal4j
Object containing parameters for device code flow.
DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder - Class in com.microsoft.aad.msal4j
 
domainHint(String) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
Provides a hint about the tenant or domain that the user should use to sign in.
domainHint() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
domainHint() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
Provides a hint about the tenant or domain that the user should use to sign in.
domainHint(String) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 

E

endpoint - Variable in enum com.microsoft.aad.msal4j.AzureCloudEndpoint
 
environment() - Method in interface com.microsoft.aad.msal4j.IAccount
 
environment() - Method in interface com.microsoft.aad.msal4j.IAuthenticationResult
 
environment() - Method in interface com.microsoft.aad.msal4j.ITenantProfile
 
errorCode() - Method in exception com.microsoft.aad.msal4j.MsalException
Authentication error code
executorService(ExecutorService) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Sets ExecutorService to be used to execute the requests.
expiresIn() - Method in class com.microsoft.aad.msal4j.DeviceCode
expiration time of device code in seconds.
expiresOnDate() - Method in interface com.microsoft.aad.msal4j.IAuthenticationResult
 
extraHttpHeaders(Map<String, String>) - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
 
extraHttpHeaders() - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters
Adds additional headers to the token request
extraHttpHeaders(Map<String, String>) - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder
 
extraHttpHeaders() - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters
Adds additional headers to the token request
extraHttpHeaders(Map<String, String>) - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder
 
extraHttpHeaders() - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters
Adds additional headers to the token request
extraHttpHeaders() - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters
Adds additional headers to the token request
extraHttpHeaders(Map<String, String>) - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters.IntegratedWindowsAuthenticationParametersBuilder
 
extraHttpHeaders() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
Adds additional headers to the token request
extraHttpHeaders(Map<String, String>) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
extraHttpHeaders() - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters
Adds additional headers to the token request
extraHttpHeaders(Map<String, String>) - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters.OnBehalfOfParametersBuilder
 
extraHttpHeaders() - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters
Adds additional headers to the token request
extraHttpHeaders(Map<String, String>) - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters.RefreshTokenParametersBuilder
 
extraHttpHeaders() - Method in class com.microsoft.aad.msal4j.SilentParameters
Adds additional headers to the token request
extraHttpHeaders(Map<String, String>) - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
extraHttpHeaders() - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters
Adds additional headers to the token request
extraHttpHeaders(Map<String, String>) - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters.UserNamePasswordParametersBuilder
 
extraQueryParameters(Map<String, String>) - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
 
extraQueryParameters() - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters
Adds additional query parameters to the token request
extraQueryParameters(Map<String, String>) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
Query parameters that you can add to the request, in addition to the list of parameters already provided.
extraQueryParameters() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
extraQueryParameters(Map<String, String>) - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder
 
extraQueryParameters() - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters
Adds additional query parameters to the token request
extraQueryParameters(Map<String, String>) - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder
 
extraQueryParameters() - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters
Adds additional query parameters to the token request
extraQueryParameters() - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters
Adds additional parameters to the token request
extraQueryParameters(Map<String, String>) - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters.IntegratedWindowsAuthenticationParametersBuilder
 
extraQueryParameters() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
Adds additional query parameters to the token request
extraQueryParameters(Map<String, String>) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
extraQueryParameters() - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters
Adds additional parameters to the token request
extraQueryParameters(Map<String, String>) - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters.OnBehalfOfParametersBuilder
 
extraQueryParameters() - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters
Adds additional parameters to the token request
extraQueryParameters(Map<String, String>) - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters.RefreshTokenParametersBuilder
 
extraQueryParameters() - Method in class com.microsoft.aad.msal4j.SilentParameters
Adds additional query parameters to the token request
extraQueryParameters(Map<String, String>) - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
extraQueryParameters() - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters
Adds additional query parameters to the token request
extraQueryParameters(Map<String, String>) - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters.UserNamePasswordParametersBuilder
 
extraScopesToConsent(Set<String>) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
Scopes that you can request the end user to consent upfront, in addition to scopes which the application is requesting access to.

F

forceRefresh() - Method in class com.microsoft.aad.msal4j.SilentParameters
Force MSAL to refresh the tokens in the cache, even if there is a valid access token.
forceRefresh(boolean) - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
formatAsClaimsRequest(String) - Static method in class com.microsoft.aad.msal4j.ClaimsRequest
Creates an instance of ClaimsRequest from a JSON-formatted String which follows the specification for the OIDC claims request parameter
formatAsJSONString() - Method in class com.microsoft.aad.msal4j.ClaimsRequest
Converts the ClaimsRequest object to a JSON-formatted String which follows the specification for the OIDC claims request parameter
fromHomeAccountId(String) - Static method in class com.microsoft.aad.msal4j.UserIdentifier
 
fromUpn(String) - Static method in class com.microsoft.aad.msal4j.UserIdentifier
 

G

getAccessToken() - Method in class com.microsoft.aad.msal4j.TokenProviderResult
 
getAccounts() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
getAssertion() - Method in interface com.microsoft.aad.msal4j.IUserAssertion
Gets the assertion.
getAssertion() - Method in class com.microsoft.aad.msal4j.UserAssertion
Gets the assertion.
getAssertionHash() - Method in interface com.microsoft.aad.msal4j.IUserAssertion
 
getAssertionHash() - Method in class com.microsoft.aad.msal4j.UserAssertion
 
getAuthorizationRequestUrl(AuthorizationRequestUrlParameters) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
getClaims() - Method in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
getClaims() - Method in interface com.microsoft.aad.msal4j.ITenantProfile
A map of claims taken from an ID token.
getCorrelationId() - Method in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
getEncodedPublicKeyCertificateChain() - Method in interface com.microsoft.aad.msal4j.IClientCertificate
Base64 encoded public certificate.
getExpiresInSeconds() - Method in class com.microsoft.aad.msal4j.TokenProviderResult
 
getFormParameterNames() - Method in class com.microsoft.aad.msal4j.CustomJWTAuthentication
 
getIdTokenRequestedClaims() - Method in class com.microsoft.aad.msal4j.ClaimsRequest
 
getRefreshInSeconds() - Method in class com.microsoft.aad.msal4j.TokenProviderResult
 
getScopes() - Method in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
getTenantId() - Method in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
getTenantId() - Method in class com.microsoft.aad.msal4j.TokenProviderResult
 
getTenantProfiles() - Method in interface com.microsoft.aad.msal4j.IAccount
Map of ITenantProfile objects related to this account, the keys of the map are the tenant ID values and match the 'realm' key of an ID token
getValue() - Method in class com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo
 
getValues() - Method in class com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo
 

H

hasCacheChanged() - Method in interface com.microsoft.aad.msal4j.ITokenCacheAccessContext
 
hasCacheChanged() - Method in class com.microsoft.aad.msal4j.TokenCacheAccessContext
 
hasCacheChanged(boolean) - Method in class com.microsoft.aad.msal4j.TokenCacheAccessContext.TokenCacheAccessContextBuilder
 
headers() - Method in class com.microsoft.aad.msal4j.HttpRequest
HTTP request headers
headers() - Method in class com.microsoft.aad.msal4j.HttpResponse
HTTP response headers
headers() - Method in interface com.microsoft.aad.msal4j.IHttpResponse
 
headers() - Method in exception com.microsoft.aad.msal4j.MsalServiceException
Contains the http headers from the server response that indicated an error.
headerValue(String) - Method in class com.microsoft.aad.msal4j.HttpRequest
 
homeAccountId() - Method in interface com.microsoft.aad.msal4j.IAccount
 
htmlMessageError() - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions
WHen the user finishes authenticating, but an error occurred, MSAL will respond with a Http 200 Ok message, which the browser will show to the user.
htmlMessageError(String) - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions.SystemBrowserOptionsBuilder
 
htmlMessageSuccess() - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions
When the user finishes authenticating, MSAL will respond with a Http 200 OK message, which the browser will show to the user
htmlMessageSuccess(String) - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions.SystemBrowserOptionsBuilder
 
httpClient(IHttpClient) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Sets HTTP client to be used by the client application for all HTTP requests.
HttpMethod - Enum in com.microsoft.aad.msal4j
Http request method.
httpMethod() - Method in class com.microsoft.aad.msal4j.HttpRequest
httpPollingTimeoutInSeconds() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
The amount of time in seconds that the library will wait for an authentication result.
httpPollingTimeoutInSeconds(int) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
HttpRequest - Class in com.microsoft.aad.msal4j
Contains information about outgoing HTTP request.
HttpResponse - Class in com.microsoft.aad.msal4j
HTTP response
HttpResponse() - Constructor for class com.microsoft.aad.msal4j.HttpResponse
 

I

IAccount - Interface in com.microsoft.aad.msal4j
Interface representing a single user account.
IAuthenticationResult - Interface in com.microsoft.aad.msal4j
Interface representing the results of token acquisition operation.
IBroker - Interface in com.microsoft.aad.msal4j
Used to define the basic set of methods that all Brokers must implement All methods are so they can be referenced by MSAL Java without an implementation, and by default simply throw an exception saying that a broker implementation is missing
IClientAssertion - Interface in com.microsoft.aad.msal4j
Credential type containing an assertion of type "urn:ietf:params:oauth:token-type:jwt".
IClientCertificate - Interface in com.microsoft.aad.msal4j
Credential type containing X509 public certificate and RSA private key.
IClientCredential - Interface in com.microsoft.aad.msal4j
Interface representing an application credential
IClientSecret - Interface in com.microsoft.aad.msal4j
Representation of client credential containing a secret in string format
IConfidentialClientApplication - Interface in com.microsoft.aad.msal4j
Interface representing a confidential client application (Web App, Web API, Daemon App).
idToken() - Method in interface com.microsoft.aad.msal4j.IAuthenticationResult
 
IHttpClient - Interface in com.microsoft.aad.msal4j
Interface to be implemented when configuring http client for IPublicClientApplication or IConfidentialClientApplication.
IHttpResponse - Interface in com.microsoft.aad.msal4j
HTTP response from execution of HttpRequest in IHttpClient
instanceAware(boolean) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
If set to true, the authorization result will contain the authority for the user's home cloud, and this authority will be used for the token request instead of the authority set in the application.
instanceAware() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
instanceAware() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
If set to true, the authorization result will contain the authority for the user's home cloud, and this authority will be used for the token request instead of the authority set in the application.
instanceAware(boolean) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
instanceDiscovery(boolean) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Historically, MSAL would connect to a central endpoint located at ``https://login.microsoftonline.com`` to acquire some metadata, especially when using an unfamiliar authority.
instanceDiscovery() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
IntegratedWindowsAuthenticationParameters - Class in com.microsoft.aad.msal4j
Object containing parameters for Integrated Windows Authentication.
IntegratedWindowsAuthenticationParameters.IntegratedWindowsAuthenticationParametersBuilder - Class in com.microsoft.aad.msal4j
 
InteractionRequiredExceptionReason - Enum in com.microsoft.aad.msal4j
Details about the cause of an MsalInteractionRequiredException, giving a hint about the user can expect when they go through interactive authentication
InteractiveRequestParameters - Class in com.microsoft.aad.msal4j
Object containing parameters for interactive requests.
InteractiveRequestParameters.InteractiveRequestParametersBuilder - Class in com.microsoft.aad.msal4j
 
interval() - Method in class com.microsoft.aad.msal4j.DeviceCode
interval at which the STS should be polled at
INVALID_AUTHORIZATION_RESULT - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
Authorization result response is invalid.
INVALID_GRANT - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
Standard Oauth2 protocol error code.
INVALID_INSTANCE_DISCOVERY_METADATA - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
Not able to parse instance discovery metadata.
INVALID_JSON - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
A JSON processing failure, indicating the JSON provided to MSAL is of invalid format.
INVALID_JWT - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
A JWT parsing failure, indicating the JWT provided to MSAL is of invalid format.
INVALID_REDIRECT_URI - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
Redirect URI provided to MSAL is of invalid format.
IPublicClientApplication - Interface in com.microsoft.aad.msal4j
Interface representing a public client application (Desktop, Mobile).
isAvailable() - Method in interface com.microsoft.aad.msal4j.IBroker
checks if a IBroker implementation exists
isEssential() - Method in class com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo
 
ITenantProfile - Interface in com.microsoft.aad.msal4j
Interface representing a single tenant profile.
ITokenCache - Interface in com.microsoft.aad.msal4j
Interface representing security token cache persistence
ITokenCacheAccessAspect - Interface in com.microsoft.aad.msal4j
Interface representing operation of executing code before and after cache access.
ITokenCacheAccessContext - Interface in com.microsoft.aad.msal4j
Interface representing context in which the token cache is accessed
IUserAssertion - Interface in com.microsoft.aad.msal4j
Interface representing a delegated user identity used by downstream applications in On-Behalf-Of flow

L

log - Variable in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
log() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
loginHint(String) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time.
loginHint() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
loginHint(String) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
loginHint() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time.
logPii(boolean) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Set logPii - boolean value, which determines whether Pii (personally identifiable information) will be logged in.
logPii() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
LOOPBACK_REDIRECT_URI - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
The current redirect URI is not a loopback URL.

M

message() - Method in class com.microsoft.aad.msal4j.DeviceCode
message which should be displayed to the user.
MIN_ACCESS_TOKEN_EXPIRE_IN_SEC - Static variable in class com.microsoft.aad.msal4j.TokenCache
 
MISSING_BROKER - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
Indicates that a Broker implementation is missing from the device, such as when an app developer does not include one of our broker packages as a dependency in their project, or otherwise cannot be accessed by MSAL Java
MsalAzureSDKException - Exception in com.microsoft.aad.msal4j
Exception type thrown when Azure SDK returns an error response.
MsalAzureSDKException(Throwable) - Constructor for exception com.microsoft.aad.msal4j.MsalAzureSDKException
 
MsalAzureSDKException(String, String) - Constructor for exception com.microsoft.aad.msal4j.MsalAzureSDKException
 
MsalClientException - Exception in com.microsoft.aad.msal4j
Exception type thrown when and error occurs that is local to the library or the device.
MsalClientException(Throwable) - Constructor for exception com.microsoft.aad.msal4j.MsalClientException
Initializes a new instance of the exception class with a instance of Throwable
MsalClientException(String, String) - Constructor for exception com.microsoft.aad.msal4j.MsalClientException
Initializes a new instance of the exception class with a specified error message
MsalException - Exception in com.microsoft.aad.msal4j
Base exception type thrown when an error occurs during token acquisition.
MsalException(Throwable) - Constructor for exception com.microsoft.aad.msal4j.MsalException
Initializes a new instance of the exception class
MsalException(String, String) - Constructor for exception com.microsoft.aad.msal4j.MsalException
Initializes a new instance of the exception class
MsalInteractionRequiredException - Exception in com.microsoft.aad.msal4j
This exception class is to inform developers that UI interaction is required for authentication to succeed.
MsalInteractionRequiredException(ErrorResponse, Map<String, List<String>>) - Constructor for exception com.microsoft.aad.msal4j.MsalInteractionRequiredException
Initializes a new instance of the exception class
MsalServiceException - Exception in com.microsoft.aad.msal4j
Exception type thrown when service returns an error response or other networking errors occur.
MsalServiceException(String, String) - Constructor for exception com.microsoft.aad.msal4j.MsalServiceException
Initializes a new instance of the exception class with a specified error message
MsalServiceException(ErrorResponse, Map<String, List<String>>) - Constructor for exception com.microsoft.aad.msal4j.MsalServiceException
Initializes a new instance of the exception class
MsalServiceException(AadInstanceDiscoveryResponse) - Constructor for exception com.microsoft.aad.msal4j.MsalServiceException
Initializes a new instance of the exception class
MsalThrottlingException - Exception in com.microsoft.aad.msal4j
Exception type thrown when service returns throttling instruction: Retry-After header, 429 or 5xx statuses.
MsalThrottlingException(long) - Constructor for exception com.microsoft.aad.msal4j.MsalThrottlingException
Constructor for MsalThrottlingException class

N

name - Variable in class com.microsoft.aad.msal4j.RequestedClaim
 
NO_TOKEN_IN_CACHE - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorMessage
Token not found in the cache
nonce(String) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
A value included in the request that is also returned in the token response.
nonce() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 

O

OnBehalfOfParameters - Class in com.microsoft.aad.msal4j
Object containing parameters for On-Behalf-Of flow.
OnBehalfOfParameters.OnBehalfOfParametersBuilder - Class in com.microsoft.aad.msal4j
 
openBrowser(URL) - Method in interface com.microsoft.aad.msal4j.OpenBrowserAction
Override for providing custom browser initialization logic.
OpenBrowserAction - Interface in com.microsoft.aad.msal4j
Interface to be implemented to override system browser initialization logic.
openBrowserAction() - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions
Allows developers to implement their own logic for starting a browser and navigating to a specific Uri.
openBrowserAction(OpenBrowserAction) - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions.SystemBrowserOptionsBuilder
 

P

password() - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters
 
password(char[]) - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters.UserNamePasswordParametersBuilder
 
PASSWORD_REQUIRED_FOR_MANAGED_USER - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
Password is required for managed user.
privateKey() - Method in interface com.microsoft.aad.msal4j.IClientCertificate
Returns private key of the credential.
prompt(Prompt) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
Indicates the type of user interaction that is required.
prompt() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
prompt(Prompt) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
prompt() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
Indicate the type of user interaction that is required.
Prompt - Enum in com.microsoft.aad.msal4j
Indicate the type of user interaction that is required when sending authorization code request.
proxy(Proxy) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Sets Proxy configuration to be used by the client application (MSAL4J by default uses HttpsURLConnection) for all network communication.
proxy() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
publicCertificateHash() - Method in interface com.microsoft.aad.msal4j.IClientCertificate
Base64 encoded hash of the the public certificate.
PublicClientApplication - Class in com.microsoft.aad.msal4j
Class to be used to acquire tokens for public client applications (Desktop, Mobile).
PublicClientApplication.Builder - Class in com.microsoft.aad.msal4j
 

R

readTimeoutForDefaultHttpClient(Integer) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Sets the read timeout value used in HttpsURLConnection connections made by DefaultHttpClient, and is not needed if using a custom HTTP client
readTimeoutForDefaultHttpClient() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
reason() - Method in exception com.microsoft.aad.msal4j.MsalInteractionRequiredException
Reason for the MsalInteractionRequiredException, enabling you to do more actions or inform the user depending on your scenario.
redirectUri(URI) - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
 
redirectUri() - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters
Redirect URI registered in the Azure portal, and which was used in the first step of OAuth2.0 authorization code flow.
redirectUri(String) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
The redirect URI where authentication responses can be received by your application.
redirectUri() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
redirectUri(URI) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
redirectUri() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
Redirect URI where MSAL will listen to for the authorization code returned by Azure AD.
refreshToken() - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters
Refresh token received from the STS
refreshToken(String) - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters.RefreshTokenParametersBuilder
 
RefreshTokenParameters - Class in com.microsoft.aad.msal4j
Object containing parameters for refresh token request.
RefreshTokenParameters.RefreshTokenParametersBuilder - Class in com.microsoft.aad.msal4j
 
removeAccount(IAccount) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
removeAccount(IAccount) - Method in interface com.microsoft.aad.msal4j.IBroker
 
requestClaimInAccessToken(String, RequestedClaimAdditionalInfo) - Method in class com.microsoft.aad.msal4j.ClaimsRequest
Inserts a claim into the list of claims to be added to the "access_token" section of an OIDC claims request
requestClaimInIdToken(String, RequestedClaimAdditionalInfo) - Method in class com.microsoft.aad.msal4j.ClaimsRequest
Inserts a claim into the list of claims to be added to the "id_token" section of an OIDC claims request
requestClaimInUserInfo(String, RequestedClaimAdditionalInfo) - Method in class com.microsoft.aad.msal4j.ClaimsRequest
Inserts a claim into the list of claims to be added to the "userinfo" section of an OIDC claims request
RequestedClaim - Class in com.microsoft.aad.msal4j
Represents an individual requested claims that's part of a complete claims request parameter
RequestedClaim(String, RequestedClaimAdditionalInfo) - Constructor for class com.microsoft.aad.msal4j.RequestedClaim
 
RequestedClaimAdditionalInfo - Class in com.microsoft.aad.msal4j
Represents the additional information that can be sent to an authorization server for a request claim in the claim request parameter
RequestedClaimAdditionalInfo(boolean, String, List<String>) - Constructor for class com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo
 
requestParameters() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
responseMode(ResponseMode) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
Specifies the method that should be used to send the authentication result to your app.
responseMode() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
ResponseMode - Enum in com.microsoft.aad.msal4j
Values for possible methods in which AAD can send the authorization result back to the calling application
retryInMs() - Method in exception com.microsoft.aad.msal4j.MsalThrottlingException
how long to wait before repeating request

S

scopes - Variable in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
scopes(Set<String>) - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
 
scopes() - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters
Scopes to which the application is requesting access
scopes(Set<String>) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
Scopes which the application is requesting access to and the user will consent to.
scopes() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
scopes(Set<String>) - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder
 
scopes() - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters
Scopes for which the application is requesting access to.
scopes() - Method in class com.microsoft.aad.msal4j.DeviceCode
 
scopes(String) - Method in class com.microsoft.aad.msal4j.DeviceCode
 
scopes(Set<String>) - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder
 
scopes() - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters
Scopes to which the application is requesting access to.
scopes() - Method in interface com.microsoft.aad.msal4j.IAuthenticationResult
 
scopes(Set<String>) - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters.IntegratedWindowsAuthenticationParametersBuilder
 
scopes() - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters
Scopes that the application is requesting access to
scopes(Set<String>) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
scopes() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
Scopes that the application is requesting access to and the user will consent to.
scopes(Set<String>) - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters.OnBehalfOfParametersBuilder
 
scopes() - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters
 
scopes(Set<String>) - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters.RefreshTokenParametersBuilder
 
scopes() - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters
Scopes the application is requesting access to
scopes() - Method in class com.microsoft.aad.msal4j.SilentParameters
Scopes application is requesting access to.
scopes(Set<String>) - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
scopes() - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters
Scopes application is requesting access to
scopes(Set<String>) - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters.UserNamePasswordParametersBuilder
 
self() - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication.Builder
 
self() - Method in class com.microsoft.aad.msal4j.PublicClientApplication.Builder
 
send(HttpRequest) - Method in interface com.microsoft.aad.msal4j.IHttpClient
Should implement execution of outgoing HTTP request with HTTP client of choice.
sendX5c(boolean) - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication.Builder
Specifies if the x5c claim (public key of the certificate) should be sent to the STS.
sendX5c() - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication
 
sendX5c() - Method in interface com.microsoft.aad.msal4j.IConfidentialClientApplication
 
serialize() - Method in interface com.microsoft.aad.msal4j.ITokenCache
Serialize token cache to json
serialize() - Method in class com.microsoft.aad.msal4j.TokenCache
 
setAccessToken(String) - Method in class com.microsoft.aad.msal4j.TokenProviderResult
 
setClaims(String) - Method in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
setCorrelationId(String) - Method in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
setEssential(boolean) - Method in class com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo
 
setExpiresInSeconds(long) - Method in class com.microsoft.aad.msal4j.TokenProviderResult
 
setIdTokenRequestedClaims(List<RequestedClaim>) - Method in class com.microsoft.aad.msal4j.ClaimsRequest
 
setRefreshInSeconds(long) - Method in class com.microsoft.aad.msal4j.TokenProviderResult
 
setScopes(Set<String>) - Method in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
setTenantId(String) - Method in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
setTenantId(String) - Method in class com.microsoft.aad.msal4j.TokenProviderResult
 
setTokenCacheAccessAspect(ITokenCacheAccessAspect) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Sets ITokenCacheAccessAspect to be used for cache_data persistence.
setValue(String) - Method in class com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo
 
setValues(List<String>) - Method in class com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo
 
SilentParameters - Class in com.microsoft.aad.msal4j
Object containing parameters for silent requests.
SilentParameters.SilentParametersBuilder - Class in com.microsoft.aad.msal4j
 
skipCache(Boolean) - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder
 
skipCache() - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters
Indicates whether the request should skip looking into the token cache.
skipCache(Boolean) - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters.OnBehalfOfParametersBuilder
 
skipCache() - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters
Indicates whether the request should skip looking into the token cache.
sslSocketFactory(SSLSocketFactory) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Sets SSLSocketFactory to be used by the client application for all network communication.
sslSocketFactory() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
state(String) - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder
A value included in the request that is also returned in the token response.
state() - Method in class com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters
 
statusCode() - Method in class com.microsoft.aad.msal4j.HttpResponse
HTTP response status code
statusCode(int) - Method in class com.microsoft.aad.msal4j.HttpResponse
HTTP response status code
statusCode() - Method in interface com.microsoft.aad.msal4j.IHttpResponse
 
statusCode() - Method in exception com.microsoft.aad.msal4j.MsalServiceException
Status code returned from http layer
statusMessage() - Method in exception com.microsoft.aad.msal4j.MsalServiceException
Status message returned from the http layer
systemBrowserOptions(SystemBrowserOptions) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
systemBrowserOptions() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
Sets SystemBrowserOptions to be used by the PublicClientApplication
SystemBrowserOptions - Class in com.microsoft.aad.msal4j
Options for using the default OS browser as a separate process to handle interactive authentication.
SystemBrowserOptions.SystemBrowserOptionsBuilder - Class in com.microsoft.aad.msal4j
 

T

tenant(String) - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
 
tenant() - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters
Overrides the tenant value in the authority URL for this request
tenant(String) - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder
 
tenant() - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters
Overrides the tenant value in the authority URL for this request
tenant(String) - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder
 
tenant() - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters
Overrides the tenant value in the authority URL for this request
tenant(String) - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters.IntegratedWindowsAuthenticationParametersBuilder
 
tenant() - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters
Overrides the tenant value in the authority URL for this request
tenant(String) - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
tenant() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters
Overrides the tenant value in the authority URL for this request
tenant(String) - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters.OnBehalfOfParametersBuilder
 
tenant() - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters
Overrides the tenant value in the authority URL for this request
tenant(String) - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters.RefreshTokenParametersBuilder
 
tenant() - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters
Overrides the tenant value in the authority URL for this request
tenant(String) - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
tenant() - Method in class com.microsoft.aad.msal4j.SilentParameters
Overrides the tenant value in the authority URL for this request
tenant() - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters
Overrides the tenant value in the authority URL for this request
tenant(String) - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters.UserNamePasswordParametersBuilder
 
tenantId - Variable in class com.microsoft.aad.msal4j.AppTokenProviderParameters
 
tenantProfile() - Method in interface com.microsoft.aad.msal4j.IAuthenticationResult
 
THROTTLED_REQUEST - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
Request was throttled according to instructions from STS.
tokenCache - Variable in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
tokenCache() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
tokenCache() - Method in interface com.microsoft.aad.msal4j.ITokenCacheAccessContext
 
TokenCache - Class in com.microsoft.aad.msal4j
Cache used for storing tokens.
TokenCache(ITokenCacheAccessAspect) - Constructor for class com.microsoft.aad.msal4j.TokenCache
Constructor for token cache
TokenCache() - Constructor for class com.microsoft.aad.msal4j.TokenCache
Constructor for token cache
tokenCache() - Method in class com.microsoft.aad.msal4j.TokenCacheAccessContext
 
tokenCache(ITokenCache) - Method in class com.microsoft.aad.msal4j.TokenCacheAccessContext.TokenCacheAccessContextBuilder
 
TokenCacheAccessContext - Class in com.microsoft.aad.msal4j
Context in which the the token cache is accessed
TokenCacheAccessContext.TokenCacheAccessContextBuilder - Class in com.microsoft.aad.msal4j
 
TokenProviderResult - Class in com.microsoft.aad.msal4j
 
TokenProviderResult() - Constructor for class com.microsoft.aad.msal4j.TokenProviderResult
 
toParameters() - Method in class com.microsoft.aad.msal4j.CustomJWTAuthentication
 
toString() - Method in class com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
 
toString() - Method in class com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder
 
toString() - Method in class com.microsoft.aad.msal4j.DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder
 
toString() - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters.IntegratedWindowsAuthenticationParametersBuilder
 
toString() - Method in class com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder
 
toString() - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters.OnBehalfOfParametersBuilder
 
toString() - Method in enum com.microsoft.aad.msal4j.Prompt
 
toString() - Method in class com.microsoft.aad.msal4j.RefreshTokenParameters.RefreshTokenParametersBuilder
 
toString() - Method in enum com.microsoft.aad.msal4j.ResponseMode
 
toString() - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
toString() - Method in class com.microsoft.aad.msal4j.SystemBrowserOptions.SystemBrowserOptionsBuilder
 
toString() - Method in class com.microsoft.aad.msal4j.TokenCacheAccessContext.TokenCacheAccessContextBuilder
 
toString() - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters.UserNamePasswordParametersBuilder
 
transformAuthority(URL) - Static method in class com.microsoft.aad.msal4j.CIAMAuthority
This method takes a CIAM authority string of format "tenant.ciamlogin.com" or "https://tenant.ciamlogin.com" and converts it into a full authority url with a path segment of format "/tenant.onmicrosoft.com"

U

UNABLE_TO_START_HTTP_LISTENER - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
Unable to start Http listener to the specified port.
UNKNOWN - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
Unknown error occurred
url() - Method in class com.microsoft.aad.msal4j.HttpRequest
HTTP request url
USER_REALM_DISCOVERY_FAILED - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
User realm discovery failed
userAssertion(IUserAssertion) - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters.OnBehalfOfParametersBuilder
 
userAssertion() - Method in class com.microsoft.aad.msal4j.OnBehalfOfParameters
 
UserAssertion - Class in com.microsoft.aad.msal4j
Credential type containing an assertion representing a delegated user identity.
UserAssertion(String) - Constructor for class com.microsoft.aad.msal4j.UserAssertion
Constructor to create credential with a jwt token encoded as a base64 url encoded string.
userCode() - Method in class com.microsoft.aad.msal4j.DeviceCode
code which user needs to provide when authenticating at the verification URI
UserIdentifier - Class in com.microsoft.aad.msal4j
Used for populating the X-AnchorMailbox header, which is used in the cached credential service (CCS) routing
username() - Method in interface com.microsoft.aad.msal4j.IAccount
 
username(String) - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters.IntegratedWindowsAuthenticationParametersBuilder
 
username() - Method in class com.microsoft.aad.msal4j.IntegratedWindowsAuthenticationParameters
Identifier of user account for which to acquire tokens for
username() - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters
Username of the account
username(String) - Method in class com.microsoft.aad.msal4j.UserNamePasswordParameters.UserNamePasswordParametersBuilder
 
UserNamePasswordParameters - Class in com.microsoft.aad.msal4j
Object containing parameters for Username/Password flow.
UserNamePasswordParameters.UserNamePasswordParametersBuilder - Class in com.microsoft.aad.msal4j
 

V

validateAuthority(boolean) - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder
Set a boolean value telling the application if the authority needs to be verified against a list of known authorities.
validateAuthority() - Method in class com.microsoft.aad.msal4j.AbstractClientApplicationBase
 
valueOf(String) - Static method in enum com.microsoft.aad.msal4j.AzureCloudEndpoint
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.aad.msal4j.HttpMethod
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.aad.msal4j.InteractionRequiredExceptionReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.aad.msal4j.Prompt
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.aad.msal4j.ResponseMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.microsoft.aad.msal4j.AzureCloudEndpoint
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microsoft.aad.msal4j.HttpMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microsoft.aad.msal4j.InteractionRequiredExceptionReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microsoft.aad.msal4j.Prompt
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microsoft.aad.msal4j.ResponseMode
Returns an array containing the constants of this enum type, in the order they are declared.
verificationUri() - Method in class com.microsoft.aad.msal4j.DeviceCode
URI where user can authenticate

W

WSTRUST_ENDPOINT_NOT_FOUND_IN_METADATA_DOCUMENT - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
WS-Trust Endpoint not found in Metadata document
WSTRUST_INVALID_RESPONSE - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
WS-Trust endpoint response did not contain the required fields
WSTRUST_SERVICE_ERROR - Static variable in class com.microsoft.aad.msal4j.AuthenticationErrorCode
WS-Trust request resulted in service error
A B C D E F G H I L M N O P R S T U V W 
Skip navigation links

Copyright © 2013–2023. All rights reserved.