Skip to content

Interface

Options to register an API Key.

Inheritance: ICreateApiKeyOptionsOmit<IRegisterAppOptions"itemId" | "redirect_uris" | "appType" | "httpReferrers">

Properties

Hide inherited properties
PropertyTypeNotes
apiToken1ExpirationDateDate

Expiration date of the access token in slot 1 of this API Key.

apiToken2ExpirationDateDate

Expiration date of the access token in slot 2 of this API Key.

IAuthenticationManager

IAuthenticationManager authentication.

categoriesstring[]
credentials
inherited
RequestCredentials

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

culturestring
descriptionstring
documentationstring
extentnumber[][]
generateToken1boolean

Generate a new access token in slot 1 of this API. Will override and invalidate any existing token.

generateToken2boolean

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
HTTPMethods

The HTTP method to send the request with.

httpReferrersstring[]
maxUrlLength
inherited
number

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

ownerstring
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
Privileges

Privilege lists. For more info, refer to Privileges.

propertiesany
rawResponse
inherited
boolean

Return the raw response

signal
inherited
AbortSignal

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

snippetstring
spatialReferenceISpatialReference
boolean

Suppress any ArcGIS REST JS related warnings for this request.

tagsstring[]
titlestring
typeKeywordsstring[]
urlstring

apiToken1ExpirationDate

optional
Interface Property

apiToken2ExpirationDate

optional
Interface Property

authentication

inherited
Interface Property

categories

optional
Interface Property
categories: string[]

credentials

optionalinherited
Interface Property

culture

optional
Interface Property
culture: string

description

optional
Interface Property
description: string

documentation

optional
Interface Property
documentation: string

extent

optional
Interface Property
extent: number[][]

generateToken1

optional
Interface Property

generateToken2

optional
Interface Property

headers

optionalinherited
Interface Property

hideToken

optionalinherited
Interface Property

httpMethod

optionalinherited
Interface Property

httpReferrers

optional
Interface Property
httpReferrers: string[]

maxUrlLength

optionalinherited
Interface Property

owner

optional
Interface Property
owner: string

portal

optionalinherited
Interface Property

privileges

inherited
Interface Property

properties

optional
Interface Property
properties: any

rawResponse

optionalinherited
Interface Property

signal

optionalinherited
Interface Property

snippet

optional
Interface Property
snippet: string

spatialReference

optional
Interface Property
spatialReference: ISpatialReference

suppressWarnings

optionalinherited
Interface Property

tags

optional
Interface Property
tags: string[]

title

Interface Property
title: string

typeKeywords

optional
Interface Property
typeKeywords: string[]

url

optional
Interface Property
url: string

Methods

Hide inherited methods
MethodReturnsNotes
request(url, requestOptions)
inherited
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).

request

optionalinherited
Interface Method
request(urlstring, requestOptionsInternalRequestOptions): 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).

Parameters
ParameterTypeNotes
urlstring
requestOptionsInternalRequestOptions
Returns 
Promise<any>
Inherited from Omit.request

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