Skip To Content ArcGIS for Developers Sign In Dashboard

OAuthClientInfo QML Type

The client authentication information obtained from registering an application with a Portal or ArcGIS Online. More...

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Signals

Detailed Description

Applications can generate tokens that can access ArcGIS Online content and services using OAuth client information configured for OAuthMode::App.

This information can also allow ArcGIS Online users to authorize your application to access ArcGIS Online content and services on their behalf by configuring with OAuthMode::User. Usage will be billed to that user and you can access that user's private content.

Your Client Secret should never be accessible to users or other developers. Treat it like a password.

See also JsonSerializable.

Property Documentation

clientId : string

The client ID associated with the application.


clientSecret : string

The client secret associated with the application.


json : jsobject

Client authentication information obtained from registering an application with a Portal or ArcGIS Online.


oAuthMode : Enums.OAuthMode

The Enums.OAuthMode used for obtaining an OAuth access token.

See also Enums.OAuthMode.


redirectUri : string

The URI where the access token or authorization code will be delivered upon successful authorization.


[default] refreshTokenExchangeInterval : int

The requested exchange interval (in minutes) for the refreshToken generated by the OAuth request.

If refreshTokenExpirationInterval is set to -1 then refreshToken is considered to be permanent. However, the portal/server allows the refreshToken to be valid for maximum 90 days only. In order for it to be permanent, refreshToken token needs to exchanged every n minutes.

This will be used only when refreshTokenExpirationInterval is set to -1.

Note: If exchange interval is set 0 or less than 0 then it will be set to default value 1440 minutes (1 day).

Note: If exchange interval is set more than 129600 minutes (90 days) then it will be clamped to 129600 minutes (90 days).

Note: It is recommended to keep this interval as low as possible because long lived refresh tokens may increase the security risk.

This property was introduced in Esri.ArcGISRuntime 100.8.


refreshTokenExpirationInterval : int

The requested expiration interval (in minutes) for the refresh token generated by the OAuth request.

The max interval can be overridden by the portal administrator. If this is not set, then refreshToken is valid for two weeks.

Note: For a permanent refresh token (if the portal supports it), use -1.

This property was introduced in Esri.ArcGISRuntime 100.6.


unknownJson : jsobject

Returns the unknown JSON from the source JSON.

See also JsonSerializable.


unsupportedJson : jsobject

Returns the unsupported data from the source JSON.

See also JsonSerializable.


Signal Documentation

clientIdChanged()

Emitted when the clientId property changes.

Note: The corresponding handler is onClientIdChanged.


clientSecretChanged()

Emitted when the clientSecret property changes.

Note: The corresponding handler is onClientSecretChanged.


oAuthModeChanged()

Emitted when the oAuthMode property changes.

Note: The corresponding handler is onOAuthModeChanged.


redirectUriChanged()

Emitted when the redirectUri property changes.

Note: The corresponding handler is onRedirectUriChanged.


refreshTokenExchangeIntervalChanged()

Emitted when the refreshTokenExchangeInterval property changes.

Note: The corresponding handler is onRefreshTokenExchangeIntervalChanged.

This signal was introduced in Esri.ArcGISRuntime 100.8.


refreshTokenExpirationIntervalChanged()

Emitted when the refreshTokenExpirationInterval property changes.

Note: The corresponding handler is onRefreshTokenExpirationIntervalChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.



Feedback on this topic?