- URL:
- https://<root>/security/roles/assignPrivilege
- Methods:
POST- Version Introduced:
- 10.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 assign operation assigns a privilege to a role.
Administrative access to ArcGIS Server is modeled as three broad tiers of privileges:
ADMINISTER—A role that possesses this privilege has unrestricted administrative access to ArcGIS Server.PUBLISH—A role that possesses this privilege can only publish GIS services to ArcGIS Server.ACCESS—No administrative access. A role with this privilege can only be granted permission to access one or more GIS services.
By assigning these privileges to one or more roles in the role store, the ArcGIS Server security model supports role-based access control to its administrative functionality. These privilege assignments are stored independent of the ArcGIS Server role store. As a result, you don't need to update your enterprise identity stores (like Active Directory).
Request parameters
| Parameter | Details |
|---|---|
| The name of the role. Example |
| The capability to assign to the role. The default capability is Values: |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the assign operation:
POST /<context>/admin/security/roles/assignPrivilege HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
rolename=editors&privilege=ADMINISTER&f=pjsonJSON Response example
{"status": "success"}