- URL:
- https://<root>/system/webadaptors/config/update
- Methods:
POST- Version Introduced:
- 10.1.1
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The update operation changes the shared key used by all the Web Adaptors to encrypt key data bits in the incoming requests to the server. When you change the shared key, you will need to re-register each Web Adaptor so that they can pick up the change to the shared key.
Request parameters
| Parameter | Details |
|---|---|
| The Example |
| The response format. The default value is Values: |
Example usage
The following is a sample POST request for the update operation:
POST /<context>/admin/system/webadaptors/config/update HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
webAdaptorsConfig={"sharedKey": "my very secret passphrase for web adaptors"}&f=pjsonJSON Response example
{"status": "success"}