- URL:
- https://<root>/orgs/<orgID>/license/validateURL
- Methods:
POST- Version Introduced:
- 12.1
Access requirements
Required privileges
The ArcGIS Enterprise 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 ArcGIS Enterprise 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 ArcGIS Portal Directory API. For security reasons, all POST requests made to the ArcGIS Enterprise Administrator API must include a token in the request body.
Description
The validate operation checks if the URL listed in your organization's license file matches your organization URL. If the URLs match, the operation will complete and return to the previous directory as an HTML response. If the URLs do not match, the operation will return a descriptive error message.
Request parameters
| Parameter | Details |
|---|---|
(Optional) | The response format. The default response is Values: |
Example usage
The following is a sample POST request for the validate operation:
POST /<context>/admin/orgs/0123456789ABCDEF/license/validateURL HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjsonJSON Response example
The following is the response if the validate operation is successful:
{"status": "success"}The following is a sample response if the validate operation is unsuccessful:
{
"error": {
"code": 500,
"message": "The organizationURL specified in your license file does not match the actual URL: organization.example.com/<context>. If members of your organization require access to ArcGIS Pro, ArcGIS Drone2Map, or ArcGIS AllSource through named user licensing, obtain a new portal license file from My Esri. Specify the correct organization URL and import the license file. If named user licensing of these applications is not necessary, no action is required.",
"details": null
}
}