IRevokeTokenOptions
Interface
Properties
| Property | Type | Notes |
|---|---|---|
string | IAuthenticationManager | The instance of | |
string | The client id fo the application that generated the tokens. Applications can only revoke tokens they created. | |
RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. | |
{ [key: string]: any } | Additional Headers to pass into the request. | |
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. | |
The HTTP method to send the request with. | ||
number | If the length of a GET request's URL exceeds | |
Additional parameters to pass in the request. | ||
string | The portal of the tokens to revoke. Defaults to | |
boolean | Return the raw response | |
AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. | |
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
clientId
clientId: stringThe client id fo the application that generated the tokens. Applications can only revoke tokens they created.
credentials optional
credentials: RequestCredentialsA 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: booleanPrevents 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: HTTPMethodsThe HTTP method to send the request with.
maxUrlLength optional
maxUrlLength: numberIf the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
params optional
params: IParamsAdditional parameters to pass in the request.
portal optional
portal: stringThe portal of the tokens to revoke. Defaults to https://www.arcgis.com/sharing/rest.
rawResponse optional
rawResponse: booleanReturn the raw response
signal optional
signal: AbortSignalAn AbortSignal object instance; allows you to abort a request and via an AbortController.
suppressWarnings optional
suppressWarnings: booleanSuppress any ArcGIS REST JS related warnings for this request.
token
token: stringThe token or refresh token to revoke. If a refresh token is passed all access tokens generated with that refresh token are also revoked.
authentication: string | IAuthenticationManagerThe instance of
ApiKey,ArcGISIdentityManagerorApplicationSessionto use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.