TokenCredential

A credential that accesses token-secured ArcGIS content and services. To create a token credential, provide a secured service URL, valid username, and password. Alternatively, you can create a token credential for network secure resources that are secured using network authentication, such as Integrated Windows Authentication (IWA) or Public Key Infrastructure (PKI). In both bases, you can specify a token expiration in minutes.

If you use this TokenCredential as part of the secure resource challenge handling, it will be stored in the ArcGISCredentialStore of the AuthenticationManager. It will be used by all subsequent requests that have a matching URL context.

Since

200.1.0

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The length of time a token credential remains valid. Represented in minutes. If not explicitly set, the server default is used. If unspecified, the server returns a token with an expiration interval of 120 minutes (2 hours). The server default for the maximum allowed expiration time is 21600 minutes (15 days), but this value can be configured on the server.

Inherited properties

Link copied to clipboard

The referer used to generate a token.

Link copied to clipboard

The URL by which the root of a server is accessed. This is the URL against which rest endpoints are resolved. For example, "https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/FeatureServer/0" would have a server context of "https://sampleserver3.arcgisonline.com/ArcGIS", on which we could add "/rest/info" or "/rest" to fetch the server information.

Link copied to clipboard

The user associated with the credential.

Functions

Link copied to clipboard
suspend fun getTokenInfo(): Result<TokenInfo>

Returns an instance of TokenInfo generated by this credential. If the token has expired, this method regenerates the access token. Token expiration is based on the TokenCredential.tokenExpirationInterval.

Inherited functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.