- URL:
- https://<root>/system/webadaptors/<webadaptorID>
- Methods:
GET- Operations:
- Unregister Web Adaptor
- 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 generate 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.
Description
The resource for an individual web adaptor returns the properties of a web adaptor, such as its HTTP and HTTPS ports and description.
The ArcGIS Web Adaptor is a web application that runs in a front-end web server. One of the web adaptor's primary responsibilities is to forward HTTP requests from end users to Portal for ArcGIS. The web adaptor acts a reverse proxy, providing the end users with an entry point to the system, hiding the back-end servers, and providing some degree of immunity from back-end failures.
The front-end web server can authenticate incoming requests against your enterprise identity stores and provide specific authentication schemes such as Integrated Windows Authentication (IWA), HTTP Basic, or Digest.
Most importantly, a web adaptor provides your end users with a well-defined entry point to your system without exposing the internal details of your portal. Portal for ArcGIS will trust requests being forwarded by the web adaptor and will not challenge the user for any credentials. However, the authorization of the request (by looking up roles and permissions) is still enforced by the portal's sharing rules.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL for used to access an individual webadaptor resource:
https://organization.example.com/<context>/portaladmin/system/webadaptors/a62c3fed-50f9-4f15-83fa-aec7a4172af4?f=jsonJSON Response syntax
{
"id": "<id>",
"webAdaptorURL": "<url>",
"description": "<description>",
"httpPort": <httpPort>,
"httpsPort": <httpsPort>,
"machineName": "<machineName>",
"machineIP": "<machineIP>",
"refreshServerListInterval": <number>,
"reconnectServerOnFailureInterval": <number>
}JSON Response example
{
"machineName": "machine.example.com",
"machineIP": "192.168.14.15",
"webAdaptorURL": "https://organization.example.com/<context>",
"id": "8b2846c8-984e-43a9-805b-61fc22d0a2e3",
"description": "Web adaptor for Portal for ArcGIS",
"httpPort": 80,
"httpsPort": 443,
"refreshServerListInterval": 1,
"reconnectServerOnFailureInterval": 1
}