IAuthenticationManager

Interface

Authentication can be supplied to request via ArcGISIdentityManager, ApplicationCredentialsManager or APIKeyManager. These classes implement Code IAuthenticationManager.

Use dark colors for code blocksCopy
const session = new ArcGISIdentityManager({
  username: "jsmith",
  password: "123456",
  // optional
  portal: "https://[yourserver]/arcgis/sharing/rest"
})

request(url, { authentication: session })

Properties

Property	Type	Notes
`canRefresh` optional	`boolean`	Optional. Should return `true` if these credentials can be refreshed and `false` if it cannot.
`portal`	`string`	Defaults to 'https://www.arcgis.com/sharing/rest'.

canRefresh optional

canRefresh: boolean

Optional. Should return true if these credentials can be refreshed and false if it cannot.

portal

portal: string

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

Methods

Method	Returns	Notes
`getDomainCredentials(url)` optional	`RequestCredentials`	Optional. Returns the proper `credentials` option for `fetch` for a given domain.
`getToken(url, requestOptions?)`	`Promise<string>`	Returns the proper token for a given URL and request options.
`refreshCredentials(requestOptions?)` optional	`Promise<IAuthenticationManager>`	Optional. Refresh the stored credentials.

getDomainCredentials optional

getDomainCredentials(url: string): RequestCredentials

Optional. Returns the proper credentials option for fetch for a given domain.

See trusted server. Used internally by underlying request methods to add support for specific security considerations.

Parameters

Parameter	Type	Notes
`url`	string	The url of the request

Returns

RequestCredentials

"include" or "same-origin"

getToken

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

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

Parameters

Parameter	Type	Notes
`url`	string	The requested URL.
`requestOptions`	ITokenRequestOptions	the requests options.

Returns

Promise<string>

refreshCredentials optional

refreshCredentials(requestOptions?: ITokenRequestOptions): Promise<IAuthenticationManager>

Optional. Refresh the stored credentials.

Parameters

Parameter	Type
`requestOptions`	ITokenRequestOptions

Returns

Promise<IAuthenticationManager>

ArcGIS REST JSAPI Reference

IAuthenticationManager

Was this page helpful?

Was this page helpful?