Skip to content

Interface

Options to update an API Key.

Inheritance: IUpdateApiKeyOptionsOmit<IRequestOptions"params">

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.

authenticationIAuthenticationManager

@esri/arcgis-rest-request!IAuthenticationManager authentication.

credentials
inherited
RequestCredentials

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

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
{}

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

Override previous httpReferrers if this value is provided.

itemIdstring

itemId of which API key will be updated.

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'.

privilegesstring[]

Override previous privileges if this value is provided.

rawResponse
inherited
boolean

Return the raw response

request
inherited
(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).

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.

apiToken1ExpirationDate

optional
Interface Property
apiToken1ExpirationDate: Date

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

apiToken2ExpirationDate

optional
Interface Property
apiToken2ExpirationDate: Date

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

authentication

Interface Property
authentication: IAuthenticationManager

@esri/arcgis-rest-request!IAuthenticationManager authentication.

credentials

optionalinheritedinherited
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

generateToken1

optional
Interface Property
generateToken1: boolean

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

generateToken2

optional
Interface Property
generateToken2: boolean

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

headers

optionalinheritedinherited
Interface Property
headers: {}

Additional Headers to pass into the request.

Type declaration
    Inherited from Omit.headers

    hideToken

    optionalinheritedinherited
    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

    optionalinheritedinherited
    Interface Property
    httpMethod: HTTPMethods

    The HTTP method to send the request with.

    Inherited from Omit.httpMethod

    httpReferrers

    optional
    Interface Property
    httpReferrers: string[]

    Override previous httpReferrers if this value is provided.

    itemId

    Interface Property
    itemId: string

    itemId of which API key will be updated.

    maxUrlLength

    optionalinheritedinherited
    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

    optionalinheritedinherited
    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

    optional
    Interface Property
    privileges: string[]

    Override previous privileges if this value is provided.

    rawResponse

    optionalinheritedinherited
    Interface Property
    rawResponse: boolean

    Return the raw response

    Inherited from Omit.rawResponse

    request

    optionalinheritedinherited
    Interface Property
    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).

    Type declaration
    Inherited from Omit.request

    signal

    optionalinheritedinherited
    Interface Property
    signal: AbortSignal

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

    Inherited from Omit.signal

    suppressWarnings

    optionalinheritedinherited
    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.