Interface
Options to register an app.
Properties
Property | Type | Notes |
---|---|---|
App types. For more info, refer to | ||
| ||
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 |
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 | |
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. |
suppressWarnings inherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
authentication
Interface Propertyauthentication: ArcGISIdentityManager
ArcGISIdentityManager
authentication.
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
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
Interface Propertyprivileges: 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
.
signal
signal: AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.
appType: AppType
App types. For more info, refer to
AppType
.