Package-level declarations

Types

Link copied to clipboard

An ArcGIS authentication challenge. An ArcGIS authentication challenge is raised by the ArcGISAuthenticationChallengeHandler if an ArcGIS secured resource requires OAuth or ArcGIS Token authentication.

Link copied to clipboard
Link copied to clipboard

A base class for types of ArcGIS credentials used to access secured resources. This is a base class for ArcGIS credentials requiring OAuth or ArcGIS Token authentication, such as OAuthUserCredential, OAuthApplicationCredential, PregeneratedTokenCredential and TokenCredential.

Link copied to clipboard

A store for instances of the subclasses of ArcGISCredential. The credential provided while handling an authentication challenge is placed in the ArcGIS credential store of the ArcGISEnvironment.authenticationManager and used by all subsequent requests that have a matching server context.

Link copied to clipboard

The manager of requests for secure resources made by the application.

Link copied to clipboard
@Serializable
@SerialName(value = "certificate")
data class CertificateCredential(val alias: String) : NetworkCredential

Represents a digital certificate used to access certificate secured resources.

Link copied to clipboard
data class NetworkAuthenticationChallenge(val hostname: String, val networkAuthenticationType: NetworkAuthenticationType, val cause: Throwable)

Represents an authentication challenge that is raised upon encountering an authentication error. This class provides information about the authentication challenge, such as the request hostname, the NetworkAuthenticationType, and the cause.

Link copied to clipboard

Implement this interface to handle NetworkAuthenticationChallenges.

Link copied to clipboard

Possible responses to a network authentication challenge.

Link copied to clipboard
@Serializable
sealed class NetworkAuthenticationType

Represents the different types of authentication challenges that can be raised.

Link copied to clipboard
@Serializable
sealed class NetworkCredential : JsonSerializable

A credential that can be used to authenticate network connections.

Link copied to clipboard

Stores credentials of type NetworkCredential for use in network-secured requests.

Link copied to clipboard

The OAuth application credential generates a short-lived access token that gives your application permission to access ready-to-use services, such as basemap layers, geocoding, and routing, in ArcGIS. It is important to treat client secret as you would your password. You must keep it confidential and we recommended not storing in your application.

Link copied to clipboard

The OAuth application token information that can be used to access ready-to-use services, such as basemap layers, geocoding, and routing.

Link copied to clipboard

The OAuth user configuration information used by an OAuthUserCredential.

Link copied to clipboard

A credential for accessing OAuth token secured ArcGIS resources.

Link copied to clipboard
data class OAuthUserSignIn

Provides data required for prompting a user for an OAuthUserCredential. Once a user has completed an OAuthUserLoginPrompt, the OAuth sign in is completed by calling complete or cancel depending on the result of the OAuth user login prompt.

Link copied to clipboard

The OAuth user token information that can be used by clients in exchange for user credentials.

Link copied to clipboard
@Serializable
@SerialName(value = "password")
data class PasswordCredential(val username: String, val password: String) : NetworkCredential

Credential that is used to authenticate against HTTP-secured services.

Link copied to clipboard

A credential used to access token-secured ArcGIS resources using a token that is generated outside of your application.

Link copied to clipboard

The exchange interval for the refresh token held by an OAuth credential. Use this to exchange a refresh token before it expires. This will limit the number of times a user will have to login because of expiring tokens.

Link copied to clipboard

The requested expiration interval for the OAuth refresh token.

Link copied to clipboard
@Serializable
@SerialName(value = "servertrust")
object ServerTrust : NetworkCredential

Represents a response to trust the Server Certificate of an HTTP network connection that is self signed or signed by an unknown root authority (for example an enterprise root certificate).

Link copied to clipboard

A credential used to access token-secured ArcGIS resources.

Link copied to clipboard
class TokenInfo

The access token information that can be used by clients in exchange for user credentials. The access token represents the authenticated user for a certain amount of time to access API functionality.