AuthenticationManager interface

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

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

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

getAuthType()

Returns the current authentication type in use.

function getAuthType()

Returns

AuthenticationType

getClientId()

Returns the current client ID in use.

function getClientId()

Returns

string

getToken()

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

function getToken()

Returns

string

initialize()

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

function initialize()

Returns

Promise<void>

signRequest(RequestParameters)

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

function signRequest(params: RequestParameters)

Parameters

params

RequestParameters

The RequestParameters to update.

Returns

RequestParameters