AddUserToRole

The AddUserToRole method adds a user to a specific access role.

Note: Users can have multiple access roles. Permissions are aggregated across all access roles for a given user. For example, if 1 role gives a user Read permissions to a page and another role gives Update permissions to the same page, the user has both Read and Update permissions.

On this page

Usage

Privileges. This method requires Update privileges.

Parameters.

The parameters for the AddUserToRole method are described in the following table.
Parameter	Data Type	Value
sessionToken	String	Valid sessionToken returned by the general.CreateUserSession method.
userId	Integer	Internal ID of the user returned by the accesscontrol.LookupGroup method.
roleId	Integer	Internal ID of the access role to which you want to add the user as contained in the results of the accessrole.GetRoles method.

Output. This method returns an integer. If the method is successful, the value is 1. If there is a failure, the API issues an exception.

Samples

Sample C# Code

iReturnCode = accesscontrol.AddUserToRole(sSessionToken, 123, 456);

Sample Request

The following is a sample SOAP 1.1 request and response. The placeholders shown would be replaced with actual values. SOAP 1.2 also is supported.

POST /archer/ws/accesscontrol.asmx HTTP/1.1

Host: staging

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://archer-tech.com/webservices/AddUserToRole"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<sessionToken>string</sessionToken>

</AddUserToRole>

</soap:Body>

</soap:Envelope>

Sample Response

HTTP/1.1 200 OK