- URL:
- https://<root>/security/roles/add
- 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 add operation adds a role to the role store. This operation is available only when the role store is a read-write store, such as the default ArcGIS Server store. If the role you attempt to add has a name that matches a role that already exists in the role store, an error will be returned.
Request parameters
| Parameter | Details |
|---|---|
| The name of the role. The name must be unique in the role store. Example |
| An optional field to add comments or a description for the role. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the add operation:
POST /<context>/admin/security/roles/add HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
rolename=editors&description=Group of users that can edit maps&f=pjsonJSON Response example
{"status": "success"}