ApplicationCredentialsManager

Class

Used to authenticate methods in ArcGIS REST JS with oAuth 2.0 application credentials. The instance of ApplicationCredentialsManager can be passed to IRequestOptions.authentication to authenticate requests.

Use dark colors for code blocksCopy
import { ApplicationCredentialsManager } from '@esri/arcgis-rest-request';

const session = ApplicationCredentialsManager.fromCredentials({
  clientId: "abc123",
  clientSecret: "••••••"
})

Implements

IAuthenticationManager

Constructors

new ApplicationCredentialsManager(options: IApplicationCredentialsManagerOptions): ApplicationCredentialsManager

Parameters

Parameter	Type
`options`	IApplicationCredentialsManagerOptions

Returns

ApplicationCredentialsManager

Properties

Property	Type	Notes
`portal`	`string`	Defaults to 'https://www.arcgis.com/sharing/rest'.

portal

portal: string

Defaults to 'https://www.arcgis.com/sharing/rest'.

Methods

Method	Returns	Notes
`getToken(url, requestOptions?)`	`Promise<string>`	Returns the proper token for a given URL and request options.
`refreshCredentials()`	`Promise<ApplicationCredentialsManager>`	Optional. Refresh the stored credentials.
`refreshToken(requestOptions?)`	`Promise<string>`
`fromCredentials(options)` static	`ApplicationCredentialsManager`	Preferred method for creating an `ApplicationCredentialsManager`

getToken

getToken(url: string, requestOptions?: ITokenRequestOptions): Promise<string>

Returns the proper token for a given URL and request options.

Parameters

Parameter	Type
`url`	string
`requestOptions`	ITokenRequestOptions

Returns

Promise<string>

refreshCredentials

refreshCredentials(): Promise<ApplicationCredentialsManager>

Optional. Refresh the stored credentials.

Returns

Promise<ApplicationCredentialsManager>

refreshToken

refreshToken(requestOptions?: ITokenRequestOptions): Promise<string>

Parameters

Parameter	Type
`requestOptions`	ITokenRequestOptions

Returns

Promise<string>

fromCredentials static

fromCredentials(options: IApplicationCredentialsManagerOptions): ApplicationCredentialsManager

Preferred method for creating an ApplicationCredentialsManager

Parameters

Parameter	Type
`options`	IApplicationCredentialsManagerOptions

Returns

ApplicationCredentialsManager

ArcGIS REST JSAPI Reference

ApplicationCredentialsManager

Was this page helpful?

Was this page helpful?