IRegisterAppOptions

Interface

Options to register an app.

Inheritance: IRegisterAppOptionsOmit<IRequestOptions"params">

Properties

Hide inherited properties
PropertyTypeNotes

App types. For more info, refer to AppType.

ArcGISIdentityManager authentication.

credentials
inherited
RequestCredentials

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

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[]

Http Referrers set for this app.

string

itemId that the newly registered app will be based on.

maxUrlLength
inherited
number

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

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 | "portal:apikey:basemaps" | "premium:user:demographics" | "premium:user:elevation" | "premium:user:featurereport" | "premium:user:geocode" | "premium:user:geocode:stored" | "premium:user:geocode:temporary" | "premium:user:geoenrichment" | "premium:user:networkanalysis" | "premium:user:networkanalysis:routing" | "premium:user:networkanalysis:optimizedrouting" | "premium:user:networkanalysis:closestfacility" | "premium:user:networkanalysis:servicearea" | "premium:user:networkanalysis:locationallocation" | "premium:user:networkanalysis:vehiclerouting" | "premium:user:networkanalysis:origindestinationcostmatrix" | "premium:user:places" | "premium:user:spatialanalysis" | "premium:publisher:geoanalytics" | "premium:publisher:rasteranalysis"[]

Privilege lists. For more info, refer to Privileges.

rawResponse
inherited
boolean

Return the raw response

string[]

Redirect URIs set for this app.

signal
inherited
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.

appType

Interface Property
appType: AppType

App types. For more info, refer to AppType.

authentication

Interface Property
authentication: ArcGISIdentityManager

ArcGISIdentityManager authentication.

credentials

optionalinherited
Interface Property
credentials: RequestCredentials

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

Inherited from Omit.credentials

headers

optionalinherited
Interface Property
headers: { [key: string]: any }

Additional Headers to pass into the request.

Type declaration
  • [key: string]: any
Inherited from Omit.headers

hideToken

optionalinherited
Interface Property
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.

Inherited from Omit.hideToken

httpMethod

optionalinherited
Interface Property
httpMethod: HTTPMethods

The HTTP method to send the request with.

Inherited from Omit.httpMethod

httpReferrers

Interface Property
httpReferrers: string[]

Http Referrers set for this app.

itemId

Interface Property
itemId: string

itemId that the newly registered app will be based on.

maxUrlLength

optionalinherited
Interface Property
maxUrlLength: number

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

Inherited from Omit.maxUrlLength

portal

optionalinherited
Interface Property
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'.

Inherited from Omit.portal

privileges

Interface Property
privileges: Privileges | "portal:apikey:basemaps" | "premium:user:demographics" | "premium:user:elevation" | "premium:user:featurereport" | "premium:user:geocode" | "premium:user:geocode:stored" | "premium:user:geocode:temporary" | "premium:user:geoenrichment" | "premium:user:networkanalysis" | "premium:user:networkanalysis:routing" | "premium:user:networkanalysis:optimizedrouting" | "premium:user:networkanalysis:closestfacility" | "premium:user:networkanalysis:servicearea" | "premium:user:networkanalysis:locationallocation" | "premium:user:networkanalysis:vehiclerouting" | "premium:user:networkanalysis:origindestinationcostmatrix" | "premium:user:places" | "premium:user:spatialanalysis" | "premium:publisher:geoanalytics" | "premium:publisher:rasteranalysis"[]

Privilege lists. For more info, refer to Privileges.

rawResponse

optionalinherited
Interface Property
rawResponse: boolean

Return the raw response

Inherited from Omit.rawResponse

redirect_uris

Interface Property
redirect_uris: string[]

Redirect URIs set for this app.

signal

optionalinherited
Interface Property
signal: AbortSignal

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

Inherited from Omit.signal

suppressWarnings

optionalinherited
Interface Property
suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

Inherited from Omit.suppressWarnings

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