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

A

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(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(ClientCredentialParameters) - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication
 
acquireToken(OnBehalfOfParameters) - Method in class com.microsoft.aad.msal4j.ConfidentialClientApplication
 
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
 
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
 
assertion() - Method in interface com.microsoft.aad.msal4j.IClientAssertion
 
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
 
authorityUrl() - Method in class com.microsoft.aad.msal4j.SilentParameters
 
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
Parameters for AbstractClientApplicationBase.getAuthorizationRequestUrl(AuthorizationRequestUrlParameters)
AuthorizationRequestUrlParameters.Builder - Class in com.microsoft.aad.msal4j
 
AzureCloudEndpoint - Enum in com.microsoft.aad.msal4j
All the national clouds authenticate users separately in each environment and have separate authentication endpoints.

B

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, 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
Builder for SilentParameters
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
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.ConfidentialClientApplication
 
clientAuthentication() - Method in class com.microsoft.aad.msal4j.PublicClientApplication
 
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.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
 
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.
createFromCertificate(InputStream, String) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientCertificate instance from a certificate
createFromCertificate(PrivateKey, X509Certificate) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientCertificate instance.
createFromCertificateChain(PrivateKey, List<X509Certificate>) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientCertificate instance.
createFromClientAssertion(String) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientAssertion instance.
createFromSecret(String) - Static method in class com.microsoft.aad.msal4j.ClientCredentialFactory
Static method to create a ClientSecret instance from a client secret

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
 
errorCode() - Method in exception com.microsoft.aad.msal4j.MsalException
Authentication error code
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
 
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
 
forceRefresh(boolean) - Method in class com.microsoft.aad.msal4j.SilentParameters.SilentParametersBuilder
 
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

G

getAssertion() - Method in interface com.microsoft.aad.msal4j.IUserAssertion
Gets the assertion.
getAssertion() - Method in class com.microsoft.aad.msal4j.UserAssertion
Gets the assertion.
getClaims() - Method in interface com.microsoft.aad.msal4j.ITenantProfile
A map of claims taken from an ID token.
getEncodedPublicKeyCertificateChain() - Method in interface com.microsoft.aad.msal4j.IClientCertificate
Base64 encoded public certificate.
getIdTokenRequestedClaims() - Method in class com.microsoft.aad.msal4j.ClaimsRequest
 
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
 
HttpMethod - Enum in com.microsoft.aad.msal4j
Http request method.
httpMethod() - Method in class com.microsoft.aad.msal4j.HttpRequest
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.
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 For more details, see https://aka.ms/msal4j-client-credentials
IClientSecret - Interface in com.microsoft.aad.msal4j
Representation of client credential containing a secret in string format For more details, see https://aka.ms/msal4j-client-credentials
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
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).
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 For more details, see https://aka.ms/msal4j-token-cache
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 For more details, see https://aka.ms/msal4j-token-cache
IUserAssertion - Interface in com.microsoft.aad.msal4j
Interface representing a delegated user identity used by downstream applications in On-Behalf-Of flow

L

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.
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
 
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.
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

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
 
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
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(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(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
 
setEssential(boolean) - Method in class com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo
 
setIdTokenRequestedClaims(List<RequestedClaim>) - Method in class com.microsoft.aad.msal4j.ClaimsRequest
 
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
 
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

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() - 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 For more details, see https://aka.ms/msal4j-token-cache
TokenCacheAccessContext.TokenCacheAccessContextBuilder - Class in com.microsoft.aad.msal4j
 
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
 

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
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

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
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–2020. All rights reserved.