IapCredential

A credential that utilizes the OpenID Connect specification to access an Identity-Aware Proxy (IAP) using the IapConfiguration. This credential is used to access the ArcGIS resources that are secured behind an Identity-Aware Proxy (IAP). Currently, only the Microsoft Entra Application Proxy is supported via the Microsoft Identity Platform.

Note: Using a private or ephemeral web browser session is not recommended when creating or invalidating IapCredential and OAuthUserCredential for user authentication to access the Identity-Aware Proxy (IAP). This is because such sessions may require users to enter their credentials multiple times.

Since

200.8.0

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The authorization code received after successful authentication in a web session. This code is used to generate the IapTokenInfo.

Link copied to clipboard

The IapConfiguration information used by this credential to authenticate the user and generate tokens.

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 IapTokenInfo generated by this credential. If the access or ID token has expired, this method regenerates it. While regenerating the access or ID tokens, if the refresh token is expired, an invalid Identity-Aware Proxy (IAP) credential error is thrown.

Link copied to clipboard
suspend fun invalidate(startSignOut: (iapSignOut: IapSignOut) -> Unit): Result<Boolean>

Initiates a sign-out request that invalidates the user's identity within the web session and removes all associated tokens. After this function is called, the credential will no longer be usable.

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.