Namespace: Esri::GameEngine::Authentication
Class: Esri/GameEngine/Authentication/ArcGISOAuthUserCredential
Since: 1.1.0
Inheritance: ArcGISCredential->ArcGISOAuthUserCredential
Summary
A credential that access OAuth token-secured ArcGIS resources using an ArcGISOAuthUserConfiguration.
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
No | Yes | An authorization code to generate the OAuth token. | ||
No | Yes | The OAuth configuration details of an application that can sign into an ArcGIS Online or ArcGIS Enterprise portal using OAuth. |
AuthorizationCode
FString GetAuthorizationCode() const
An authorization code to generate the OAuth token.
Configuration
ArcGISOAuthUserConfiguration GetConfiguration() const
The OAuth configuration details of an application that can sign into an ArcGIS Online or ArcGIS Enterprise portal using OAuth.
Methods
| Signature | Return Type | Summary |
|---|---|---|
ArcGISFuture<ArcGISOAuthUserCredential> | Creates an ArcGISOAuthUserCredential with information needed to access an ArcGIS resource. This initiates the OAuth login process by presenting the OAuth login page. | |
ArcGISFuture<ArcGISOAuthUserTokenInfo> | Returns an instance of ArcGISOAuthUserTokenInfo generated by this credential. | |
ArcGISFuture<void> | Sends a network request to revoke OAuth refresh and access tokens. |
CreateAsync
static ArcGISFuture<ArcGISOAuthUserCredential> CreateAsync(const ArcGISOAuthUserConfiguration& configuration)
Creates an ArcGISOAuthUserCredential with information needed to access an ArcGIS resource. This initiates the OAuth login process by presenting the OAuth login page.
Since 1.1.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
configuration | Yes | The OAuth configuration details of an application that can sign into an ArcGIS Online or ArcGIS Enterprise portal using OAuth. |
Returns ArcGISFuture<ArcGISOAuthUserCredential>
Returns an ArcGISOAuthUserCredential.
GetTokenInfoAsync
ArcGISFuture<ArcGISOAuthUserTokenInfo> GetTokenInfoAsync()
Returns an instance of ArcGISOAuthUserTokenInfo generated by this credential.
Since 1.1.0
Returns ArcGISFuture<ArcGISOAuthUserTokenInfo>
Returns the non-expired OAuth token information generated by this credential.