Namespace: Esri::GameEngine::Authentication
Class: Esri/GameEngine/Authentication/ArcGISOAuthUserTokenInfo
Since: 1.1.0
Summary
The OAuth user token information that can be used by clients, in exchange for user credentials, to access OAuth token-secured ArcGIS content and services.
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
No | Yes | The access token to be used to make an authenticated request. | ||
No | Yes | The access token expiration date. | ||
No | Yes | True if the token must be passed over HTTPS, false otherwise. | ||
No | Yes | The refresh token to be used to refresh the access token. | ||
Yes | Yes | The date that the refresh token should be exchanged. | ||
Yes | Yes | The date that the refresh token expires. |
AccessToken
FString GetAccessToken() const
The access token to be used to make an authenticated request.
IsSSLRequired
bool GetIsSSLRequired() const
True if the token must be passed over HTTPS, false otherwise.
RefreshToken
FString GetRefreshToken() const
The refresh token to be used to refresh the access token.
RefreshTokenExchangeDate
FDateTime GetRefreshTokenExchangeDate() const
The date that the refresh token should be exchanged.
RefreshTokenExpirationDate
FDateTime GetRefreshTokenExpirationDate() const
The date that the refresh token expires.
This is available only for ArcGIS.com and ArcGIS Enterprise version 10.9.1 and above.
Methods
| Signature | Return Type | Summary |
|---|---|---|
Equals(const ArcGISOAuthUserTokenInfo&) | Tests if the two ArcGISOAuthUserTokenInfo objects are equal. |
Equals
bool Equals(const ArcGISOAuthUserTokenInfo& other) const
Tests if the two ArcGISOAuthUserTokenInfo objects are equal.
Since 1.1.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
other | Yes | The token information to compare to. |
Returns bool
True if the comparison succeeds and the objects are equal, false otherwise.