Update Token Configuration

URL:
https://<root>/security/tokens/update
Methods:
POST
Required Capability:
Access allowed with the "Security and Infrastructure" privilege
Version Introduced:
10.2.1

Description

The update operation updates the shared key that is used to generate tokens and encrypt specific elements of your ArcGIS Enterprise portal licensing information. Starting at ArcGIS Enterprise 11.4, this operation generates a new base64 encoded key rather than requiring a new shared key be manually provided by administrators. For organizations using a version of Enterprise at 11.3 or earlier, a manual key will still need to be provided. Keys must either be a 32-byte string or 44 characters if the key is base64 encoded. Key length is verified prior to any changes taking place.

Performing the request will update the token configuration information with the new key (either generated by the system or provided by an administrator) and any previously issued tokens and encryption will be invalidated. Once the operation is complete, ArcGIS Enterprise portal will restart and remain inaccessible for some time.

Request parameters

ParameterDetails

tokenConfig

The JSON object representing the token configuration. It must contain an attribute named sharedKey. Starting at ArcGIS Enterprise 11.4, this key will be generated. For versions 11.3 or earlier, administrators must provide a new key. The key needs to be either a 32-byte string or 44 characters if the key is base64 encoded.

Example
1
tokenConfig={"sharedKey": "gbw6+cxasO+Rq0wHUWtnS040mLW1mO4Sh+vmbW7F+cs="}

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the update operaiton:

1
2
3
4
5
6
7
8
POST /webadaptor/portaladmin/security/tokens/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

tokenConfig={
  "sharedKey": "gbw6+cxasO+Rq0wHUWtnS040mLW1mO4Sh+vmbW7F+cs="
}&f=pjson

JSON Response example

1
2
3
4
{
  "status": "success",
  "recheckAfterSeconds": 10
}

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close