Package com.arcgismaps.httpcore.authentication

Types

Link copied to clipboard
class ArcGISAuthenticationChallenge

An object that represents an ArcGIS authentication challenge.

Link copied to clipboard
fun interface ArcGISAuthenticationChallengeHandler

//TODO

Link copied to clipboard
sealed class ArcGISAuthenticationChallengeResponse

Possible responses to an ArcGIS authentication challenge.

Link copied to clipboard
sealed class ArcGISCredential : JsonSerializable

An object used to access secured ArcGIS resources.

Link copied to clipboard
class ArcGISCredentialStore

An object that stores ArcGISCredential objects.

Link copied to clipboard
class AuthenticationCancelledException(message: String = "User cancelled authentication challenge", cause: Throwable? = null) : Exception

Exception to be used when the User cancels the NetworkAuthenticationChallenge.

Link copied to clipboard
class AuthenticationManager

Provides objects for authenticating Network-secured and ArcGIS-secured resources. For ArcGIS-secured resources, users can get or set an ArcGISAuthenticationChallengeHandler and associated ArcGISCredentialStore. For Network-secured resources users can get or set a NetworkAuthenticationChallengeHandler and associated NetworkCredentialStore.

Link copied to clipboard
data class CertificateCredential(val alias: String) : NetworkCredential

Represents a digital certificate used to access certificate secured resources.

Link copied to clipboard
class ForbiddenException(message: String, cause: Throwable? = null) : HttpResponseException

Exception representing a 403 - Forbidden response HTTP error. This HTTP error occurs when the user that generated the token does not have privilege to access the folder or service including when a Client Certificate is required to access this resource.

Link copied to clipboard
sealed class HttpResponseException : Exception

Signals a non 2xx HTTP response.

Link copied to clipboard
class HttpUnauthorizedException(message: String, cause: Throwable? = null) : HttpResponseException

Exception representing a 401 - Unauthorized response HTTP error. This HTTP error occurs when a network request is made to a NTLM-secured service, with no or invalid username/password.

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

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

Link copied to clipboard
fun interface NetworkAuthenticationChallengeHandler

Implement this interface to handle NetworkAuthenticationChallenges.

Link copied to clipboard
sealed class NetworkAuthenticationChallengeResponse

Possible responses to a network authentication challenge.

Link copied to clipboard
sealed class NetworkAuthenticationType

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

Link copied to clipboard
interface NetworkCredential

Defines the concept of a Credential, allowing various different types of authenticating credentials to be passed to network requests.

Link copied to clipboard
class NetworkCredentialStore : Closeable

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

Link copied to clipboard
class OAuthUserConfiguration : JsonSerializable

An object used to configure an OAuthUserCredential.

Link copied to clipboard
class OAuthUserCredential : ArcGISCredential

A credential object to access OAuth token secured ArcGIS resources.

Link copied to clipboard
data class OAuthUserSignIn

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

Link copied to clipboard
class OAuthUserTokenInfo

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

Link copied to clipboard
data class PasswordCredential(val username: String, val password: String) : NetworkCredential

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

Link copied to clipboard
class PregeneratedTokenCredential : ArcGISCredential

An object used to access token-secured ArcGIS resources.

Link copied to clipboard
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
class TokenCredential : ArcGISCredential

An object used to access token-secured ArcGIS resources.

Link copied to clipboard
class TokenInfo

The access token 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 all other API functionality.

Link copied to clipboard
sealed class UserInterfaceStyle

Constants indicating the interface style.