Interface
Options to register an API Key.
Properties
| Property | Type | Notes |
|---|---|---|
apiToken1ExpirationDate | Date | Expiration date of the access token in slot 1 of this API Key. |
apiToken2ExpirationDate | Date | Expiration date of the access token in slot 2 of this API Key. |
authenticationinherited | IAuthenticationManager |
|
categories | string[] | |
credentialsinherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
culture | string | |
description | string | |
documentation | string | |
extent | number[][] | |
generateToken1 | boolean | Generate a new access token in slot 1 of this API. Will override and invalidate any existing token. |
generateToken2 | boolean | Generate a new access token in slot 2 of this API. Will override and invalidate any existing token. |
headersinherited | {} | Additional Headers to pass into the request. |
hideTokeninherited | 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. |
httpMethodinherited | HTTPMethods | The HTTP method to send the request with. |
httpReferrers | string[] | |
maxUrlLengthinherited | number | If the length of a GET request's URL exceeds |
owner | string | |
portalinherited | string | Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'. |
privilegesinherited | Privileges | Privilege lists. For more info, refer to |
properties | any | |
rawResponseinherited | boolean | Return the raw response |
requestinherited | (url: string, requestOptions: InternalRequestOptions) => Promise<any> | Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy). |
signalinherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
snippet | string | |
spatialReference | ISpatialReference | |
suppressWarningsinherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
tags | string[] | |
title | string | |
typeKeywords | string[] | |
url | string |
apiToken1ExpirationDate
apiToken1ExpirationDate: DateExpiration date of the access token in slot 1 of this API Key.
apiToken2ExpirationDate
apiToken2ExpirationDate: DateExpiration date of the access token in slot 2 of this API Key.
authentication
authentication: IAuthenticationManager@esri/arcgis-rest-request!IAuthenticationManager authentication.
credentials
credentials: RequestCredentialsA string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
generateToken1
generateToken1: booleanGenerate a new access token in slot 1 of this API. Will override and invalidate any existing token.
generateToken2
generateToken2: booleanGenerate a new access token in slot 2 of this API. Will override and invalidate any existing token.
hideToken
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.
maxUrlLength
maxUrlLength: numberIf the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
portal
portal: stringBase url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.
privileges
privileges: PrivilegesPrivilege lists. For more info, refer to Privileges .
request
request: (url: string, requestOptions: InternalRequestOptions) => Promise<any>Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).
Type declaration
function(url: string, requestOptions: InternalRequestOptions): Promise<any>Parameters
| Parameter | Type |
|---|---|
url | string |
request | InternalRequestOptions |
Returns
Promise<any>signal
signal: AbortSignalAn AbortSignal object instance; allows you to abort a request and via an AbortController.
spatialReference
spatialReference: ISpatialReference