Skip to content

Update - Web Adaptors Configuration

URL:
https://<root>/system/webadaptors/config/update
Methods:
POST
Version Introduced:
10.2.1

Access requirements

Required privileges

The Portal 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.


Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal 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 generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.


Learn how to generate a token

Description

The update operation is used to change the common properties and configuration of the ArcGIS Web Adaptor configured with the portal. The properties are stored as a JSON object and, therefore, every update must include all the necessary properties.

Request parameters

ParameterDetails

webAdaptorsConfig

The JSON object containing all the properties in the configuration. Only one property, sharedKey, is supported. The sharedKey property represents credentials that are shared with the ArcGIS Web Adaptor. The web adaptor uses these credentials to communicate with the portal.

Example
Use dark colors for code blocksCopy
1
webAdaptorsConfig={"sharedKey": "randomsharedsecret"}

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 operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /<context>/portaladmin/system/webadaptors/config/update HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

webAdaptorsConfig={"sharedKey": "randomsharedsecret"}&f=json

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

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