Interface
Options to register an API Key.
Properties
Property | Type | Notes |
---|---|---|
Date | Expiration date of the access token in slot 1 of this API Key. | |
Date | Expiration date of the access token in slot 2 of this API Key. | |
authentication inherited |
| |
string[] | ||
credentials inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
string | ||
string | ||
string | ||
number[][] | ||
boolean | Generate a new access token in slot 1 of this API. Will override and invalidate any existing token. | |
boolean | Generate a new access token in slot 2 of this API. Will override and invalidate any existing token. | |
headers inherited | { [key: string]: any } | Additional Headers to pass into the request. |
hideToken inherited | 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 inherited | The HTTP method to send the request with. | |
string[] | ||
maxUrlLength inherited | number | If the length of a GET request's URL exceeds |
string | ||
portal inherited | 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'. |
privileges inherited | Privilege lists. For more info, refer to | |
any | ||
rawResponse inherited | boolean | Return the raw response |
signal inherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
string | ||
suppressWarnings inherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
string[] | ||
string | ||
string[] | ||
string |
apiToken1ExpirationDate
apiToken1ExpirationDate: Date
Expiration date of the access token in slot 1 of this API Key.
apiToken2ExpirationDate
apiToken2ExpirationDate: Date
Expiration date of the access token in slot 2 of this API Key.
authentication
authentication: IAuthenticationManager
IAuthenticationManager
authentication.
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
generateToken1
generateToken1: boolean
Generate a new access token in slot 1 of this API. Will override and invalidate any existing token.
generateToken2
generateToken2: boolean
Generate a new access token in slot 2 of this API. Will override and invalidate any existing token.
headers
headers: { [key: string]: any }
Additional Headers to pass into the request.
Type declaration
- [key: string]: any
hideToken
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.
maxUrlLength
maxUrlLength: number
If the length of a GET request's URL exceeds maxUrlLength
the request will use POST instead.
portal
portal: 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'.
privileges
privileges: Privileges
Privilege lists. For more info, refer to Privileges
.
signal
signal: AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.
spatialReference
spatialReference: ISpatialReference