IRevokeTokenOptions

Interface

Inheritance: IRevokeTokenOptionsIRequestOptions

Properties

PropertyTypeNotes
authentication
 optional 

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

string

The client id fo the application that generated the tokens. Applications can only revoke tokens they created.

credentials
 optional 
RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

headers
 optional 
{ [key: string]: any }

Additional Headers to pass into the request.

hideToken
 optional 
boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod
 optional 

The HTTP method to send the request with.

maxUrlLength
 optional 
number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params
 optional 

Additional parameters to pass in the request.

portal
 optional 
string

The portal of the tokens to revoke. Defaults to https://www.arcgis.com/sharing/rest.

rawResponse
 optional 
boolean

Return the raw response

signal
 optional 
AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

suppressWarnings
 optional 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

string

The token or refresh token to revoke. If a refresh token is passed all access tokens generated with that refresh token are also revoked.

authentication optional

authentication: string | IAuthenticationManager

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

clientId

clientId: string

The client id fo the application that generated the tokens. Applications can only revoke tokens they created.

credentials optional

credentials: RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

headers optional

headers: { [key: string]: any }

Additional Headers to pass into the request.

hideToken optional

hideToken: boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod optional

httpMethod: HTTPMethods

The HTTP method to send the request with.

maxUrlLength optional

maxUrlLength: number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params optional

params: IParams

Additional parameters to pass in the request.

portal optional

portal: string

The portal of the tokens to revoke. Defaults to https://www.arcgis.com/sharing/rest.

rawResponse optional

rawResponse: boolean

Return the raw response

signal optional

signal: AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

suppressWarnings optional

suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

token

token: string

The token or refresh token to revoke. If a refresh token is passed all access tokens generated with that refresh token are also revoked.

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