IapCredential class final
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.
- Inheritance
-
- Object
- ArcGISCredential
- IapCredential
Properties
-
The authorization code received after successful authentication in a web
session. This code is used to generate the IapTokenInfo.
no setter
- configuration → IapConfiguration
-
The IapConfiguration information used by this credential to authenticate
the user and generate tokens.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- referer → String
-
The referer used to generate a token.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serverContext → Uri
-
The URL by which the root of a server is accessed.
no setterinherited
- username → String
-
The user associated with the credential.
no setterinherited
Methods
-
getTokenInfo(
) → Future< IapTokenInfo> - Returns an instance of IapTokenInfo generated by this credential.
-
invalidate(
) → Future< bool> - Initiates a logout request by displaying the logout page within a web session. It invalidates the user's identity and removes all associated tokens. After this function is called, the credentials will no longer be usable.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< CaseInsensitiveString, dynamic> -
Returns a JSON representation of this Object in the data type used by jsonDecode.
inherited
-
toJsonString(
) → String -
Returns a JSON representation of this Object as a String.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
IapConfiguration configuration) → Future< IapCredential> - Creates an IapCredential containing the necessary information to access the Identity-Aware Proxy (IAP) using OAuth and OpenID Connect.