IAuthenticationResult Interface

Package:

com.microsoft.identity.client

public interface IAuthenticationResult

Method Summary

Modifier and Type	Method and Description
String	getAccessToken()
IAccount	getAccount() Gets the Account.
String	getAuthenticationScheme() Gets the authentication scheme (Bearer, PoP, etc)....
String	getAuthorizationHeader() Gets the fully-formed Authorization header value. Includes the Authentication scheme. Example: Bearer eyJ1aWQiOiJj.......
UUID	getCorrelationId() 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.
Date	getExpiresOn()
String []	getScope()
String	getTenantId()

Method Details

getAccessToken

public String getAccessToken()

Returns:

The access token requested.

getAccount

public IAccount getAccount()

Gets the Account.

Returns:

The Account to get.

getAuthenticationScheme

public String getAuthenticationScheme()

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

Returns:

The authentication scheme name.

getAuthorizationHeader

public String getAuthorizationHeader()

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

Example: Bearer eyJ1aWQiOiJj.......

Returns:

The Authorization header value.

getCorrelationId

public UUID getCorrelationId()

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.

Returns:

a UUID representing a correlation id

getExpiresOn

public Date getExpiresOn()

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.

getScope

public String [] getScope()

Returns:

The scopes returned from the service.

getTenantId

public String getTenantId()

Returns:

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