ArcGISOAuthUserCredential

Namespace: GameEngine.Authentication
Class: GameEngine/Authentication/ArcGISOAuthUserCredential
Since: 1.1.0
Inheritance: ArcGISCredential->ArcGISOAuthUserCredential

Summary

A credential that access OAuth token-secured ArcGIS resources using an ArcGISOAuthUserConfiguration.

Properties

PropertyTypeNullableReadonlySummary
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

string AuthorizationCode

An authorization code to generate the OAuth token.

Configuration

The OAuth configuration details of an application that can sign into an ArcGIS Online or ArcGIS Enterprise portal using OAuth.

Methods

SignatureReturn TypeSummary

CreateAsync(ArcGISOAuthUserConfiguration)

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.

GetTokenInfoAsync()

ArcGISFuture<ArcGISOAuthUserTokenInfo>

Returns an instance of ArcGISOAuthUserTokenInfo generated by this credential.

RevokeTokenAsync()

ArcGISFuture<void>

Sends a network request to revoke OAuth refresh and access tokens.

CreateAsync

static ArcGISFuture<ArcGISOAuthUserCredential> CreateAsync(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
NameTypeSummary
configuration

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.

RevokeTokenAsync

ArcGISFuture<void> RevokeTokenAsync()

Sends a network request to revoke OAuth refresh and access tokens.

Since 1.1.0

Returns ArcGISFuture<void>

A ArcGISFuture<T> that has no return value.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.