IapConfiguration class final

The Identity-Aware Proxy (IAP) configuration information used by an IapCredential.

Currently, only the Microsoft Entra Application Proxy is supported via the Microsoft Identity Platform.

Implemented types
Mixed-in types

Constructors

IapConfiguration({required Uri authorizeUri, required Uri tokenUri, required Uri logoutUri, required String clientId, String clientSecret = '', required Uri redirectUri, String iapClientId = '', required List<String> scopes, required List<String> hostsBehindProxy, IapAuthorizationPromptType authorizationPromptType = IapAuthorizationPromptType.unspecified})
Creates an Identity-Aware Proxy (IAP) configuration from the specified parameters.
factory
IapConfiguration.forMicrosoft({required String tenantId, required String clientId, required Uri redirectUri, required List<String> hostsBehindProxy, IapAuthorizationPromptType authorizationPromptType = IapAuthorizationPromptType.unspecified})
Creates an Identity-Aware Proxy (IAP) configuration for Microsoft Entra Application Proxy from the specified parameters.
factory
IapConfiguration.fromJson(Map<CaseInsensitiveString, dynamic> json)
Creates an instance of this class from JSON of the data type used by jsonDecode.
factory
IapConfiguration.fromJsonString(String jsonString)
Creates an instance of this class from a JSON String.
factory

Properties

authorizationPromptType → IapAuthorizationPromptType
The type of user interaction required for authentication and consent while signing in to the Identity-Aware Proxy (IAP).
no setter
authorizeUri → Uri
The Identity-Aware Proxy (IAP) authorize endpoint that facilitates user authentication.
no setter
clientId → String
A unique application-specific identifier associated with an application which is registered with the Identity-Aware Proxy (IAP) portal.
no setter
clientSecret → String
A private key used to verify that the application is authorized to access secured services.
no setter
hashCode → int
The hash code for this object.
no setteroverride
hostsBehindProxy → List<String>
The hosts of the ArcGIS resources that are to be accessed behind the Identity-Aware Proxy (IAP).
no setter
iapClientId → String
A unique identifier associated with an application which is registered with the Identity-Aware Proxy (IAP) portal.
no setter
logoutUri → Uri
The Identity-Aware Proxy (IAP) endpoint used to log the user out of the web session and invalidate any associated tokens.
no setter
redirectUri → Uri
The URL that the Identity-Aware Proxy (IAP) login and logout pages will redirect to when authentication completes. The scheme of this URL must be registered as a custom URL scheme in the application.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scopes → List<String>
A list of permissions that define the access level for which the user should be authenticated.
no setter
tokenUri → Uri
The Identity-Aware Proxy (IAP) endpoint responsible for generating access, ID, and refresh tokens.
no setter

Methods

canBeUsedForUri(Uri uri) → bool
Checks if this configuration can be used for the given URL.
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.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override

Static Methods

create(Uri fileUri) → Future<IapConfiguration>
Creates an Identity-Aware Proxy (IAP) configuration from a JSON file on disk.