OAuthUserCredential

A credential for accessing OAuth token secured ArcGIS resources.

Since

200.1.0

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

An authorization code to generate the OAuth token.

Link copied to clipboard

The OAuth configuration details of an application that can sign into an ArcGIS Online or ArcGIS Enterprise portal using OAuth.

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 OAuthUserTokenInfo generated by this credential. If the access token has expired, this method regenerates it. If the OAuthUserConfiguration.refreshTokenExchangeInterval is set, this method exchanges the refresh token at specified interval. While regenerating the access token or exchanging the refresh token, if the refresh token is expired, an invalid token error is returned.

Link copied to clipboard
suspend fun revokeToken(): Result<Unit>

Sends a network request to revoke OAuth refresh and access tokens. This call will fail if the tokens have not been successfully revoked.

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.