com.microsoft.identity.client

Class AuthenticationResult

java.lang.Object

com.microsoft.identity.client.AuthenticationResult

All Implemented Interfaces:

IAuthenticationResult

public final class AuthenticationResult
extends java.lang.Object
implements IAuthenticationResult

MSAL successful authentication result. When auth succeeds, token will be wrapped into the AuthenticationResult and passed back through the AuthenticationCallback.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessToken()
IAccount	getAccount() Gets the Account.
java.lang.String	getAuthenticationScheme() Gets the authentication scheme (Bearer, PoP, etc)....
java.lang.String	getAuthorizationHeader() Gets the fully-formed Authorization header value.
java.util.UUID	getCorrelationId() Gets the correlation id used during the acquire token request.
java.util.Date	getExpiresOn()
java.lang.String[]	getScope()
java.lang.String	getTenantId()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAccessToken

public java.lang.String getAccessToken()

Specified by:

getAccessToken in interface IAuthenticationResult

Returns:

The access token requested.

getAuthorizationHeader

public java.lang.String getAuthorizationHeader()

Description copied from interface: IAuthenticationResult

Gets the fully-formed Authorization header value. Includes the Authentication scheme.

Example: Bearer eyJ1aWQiOiJj.......

Specified by:

getAuthorizationHeader in interface IAuthenticationResult

Returns:

The Authorization header value.

getAuthenticationScheme

public java.lang.String getAuthenticationScheme()

Description copied from interface: IAuthenticationResult

Gets the authentication scheme (Bearer, PoP, etc)....

Specified by:

getAuthenticationScheme in interface IAuthenticationResult

Returns:

The authentication scheme name.

getExpiresOn

public java.util.Date getExpiresOn()

Specified by:

getExpiresOn in interface IAuthenticationResult

Returns:

The expiration time of the access token returned in the Token property. This value is calculated based on current UTC time measured locally and the value expiresIn returned from the service.

getTenantId

public java.lang.String getTenantId()

Specified by:

getTenantId in interface IAuthenticationResult

Returns:

A unique tenant identifier that was used in token acquisition. Could be null if tenant information is not returned by the service.

getAccount

public IAccount getAccount()

Description copied from interface: IAuthenticationResult

Gets the Account.

Specified by:

getAccount in interface IAuthenticationResult

Returns:

The Account to get.

getScope

public java.lang.String[] getScope()

Specified by:

getScope in interface IAuthenticationResult

Returns:

The scopes returned from the service.

getCorrelationId

public java.util.UUID getCorrelationId()

Description copied from interface: IAuthenticationResult

Gets the correlation id used during the acquire token request. Could be null if an error occurs when parsing from String or if not set.

Specified by:

getCorrelationId in interface IAuthenticationResult

Returns:

a UUID representing a correlation id