OAuthApplicationCredential

A credential to access OAuth token-secured ArcGIS resources using the application's credentials. The OAuth application credential generates a short-lived access token that gives your application permission to access token-secured ArcGIS content and services, such as the ArcGIS location services.

The OAuthApplicationCredential requires a private client secret. It is important to treat this as you would your password. You must keep it confidential and we recommended not storing in your application.

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

Since

200.2.0

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

A unique identifier associated with an application registered with the portal that assists with client/server OAuth authentication.

Link copied to clipboard

The URL of the portal to authenticate with.

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 20160 minutes (14 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

Returns an instance of OAuthApplicationTokenInfo generated by this credential. Expired tokens are automatically regenerated while credentials remain valid.

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.