Edit

AuthenticationManager interface

  • Reference
Package:
azure-maps-control

A manager for the map control's authentication. Exposed through the authentication property of the atlas.Map class. Cannot be instantiated by the user.

Methods

dispose()

Cleans up any resources used by the authentication manager.
getAuthType()

Returns the current authentication type in use.
getClientId()

Returns the current client ID in use.
getToken()

Returns the access token with an audience URI of https://atlas.microsoft.com.
initialize()

Initializes the authentication mechanism specified in AuthenticationOptions. If this method has been called before the original initialize promise is returned.
signRequest(RequestParameters)

Adds the necessary authentication query parameters or headers to a RequestParameters. Returns the updated RequestParameters.

Method Details

dispose()

Cleans up any resources used by the authentication manager.

function dispose()

getAuthType()

Returns the current authentication type in use.

function getAuthType(): AuthenticationType

Returns

AuthenticationType

getClientId()

Returns the current client ID in use.

function getClientId(): string

Returns

string

getToken()

Returns the access token with an audience URI of https://atlas.microsoft.com.

function getToken(): string | null

Returns

string | null

initialize()

Initializes the authentication mechanism specified in AuthenticationOptions. If this method has been called before the original initialize promise is returned.

function initialize(): Promise<void>

Returns

Promise<void>

signRequest(RequestParameters)

Adds the necessary authentication query parameters or headers to a RequestParameters. Returns the updated RequestParameters.

function signRequest(params: RequestParameters): RequestParameters

Parameters

params
RequestParameters

The RequestParameters to update.

Returns

RequestParameters