- URL:
- https://<root>/license/releaseLicense
- Methods:
GET- Version Introduced:
- 10.3
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 release operation checks in an organization member's license for ArcGIS Pro, ArcGIS Drone2Map, or ArcGIS AllSource (added at ArcGIS Enterprise 11.5) that was checked out for offline or disconnected use. These licenses can only be used on one device at a time and must be checked in with a valid access token and refresh token. If the refresh token for the device is lost, damaged, corrupted, or formatted, the user will not be able to check in the license. This also prevents the user from logging in to the software from another device. This operation can be used to release an outstanding license and allow the member to check out a new license for disconnected use, or use ArcGIS Pro, ArcGIS Drone2Map, or ArcGIS AllSource in a connected environment.
Request parameters
| Parameter | Details |
|---|---|
| The user name of the account. Example |
| The product license being released. Values: |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the release operation:
POST /<context>/portaladmin/license/releaseLicense HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
username=jdoe&appId=drone2map&f=jsonJSON Response example
{"status": "success"}