JSON API » roles » roles/access/set

Sets whether a role has access to a role privilege.

Input parameters

Requires authentication and the system role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
role	Integer	ID of role.	Yes
privilege	String	Privilege.	Yes
access	Integer	1 if role has access, 2 if role has read-only access, 0 if role does not have access.	Yes
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The role does not exist, or you do not have permission to view it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/roles/access/set/?auth_username=user;auth_password=password;role=123;privilege=system;access=1

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.