Update Token Configuration

• URL:https://<tokens-url>/update(POST only)
  
• Required Capability:Default administrator role | Security and infrastructure privilege
• Version Introduced:10.2.1

Description

Shared keys are used to generate tokens and, starting at ArcGIS Enterprise 10.7, encrypt specific elements of your portal licensing information. You can use this operation to update your shared key, though updated keys need to be of appropriate length to ensure strong encryption. Updating the token configuration information will invalidate previously issued tokens and encryption.

Once this operation is complete, your portal will be restarted and remain inaccessible for a few moments.

Caution:

At 10.7, ensure that you do not have any expired licenses assigned to your users before updating the shared key. After updating the shared key and once the portal restart is complete, you will need to call the populateLicense operation. Failing to perform the populateLicense operation will cause licensing issues and your users may not be able to access the Enterprise portal. Starting at Enterprise 10.7.1, this step will no longer be necessary.

Request parameters

Parameter	Details
tokenConfig	The JSON object representing the token configuration. It must contain an attribute named sharedKey. Example tokenConfig={"sharedKey": "gbw6+cxasO+Rq0wHUWtnS040mLW1mO4Sh+vmbW7F+cs="}
f	The response format. The default response format is html. Values: html | json | pjson

Example usage

Below is a sample POST request for update, formatted for readability:

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=json

JSON Response example

{
  "status": "success",
  "recheckAfterSeconds": 10
}