UpdateUserName

The UpdateUserName method sets the user name to the specified value.

Note: The provided user name must be available for use; the accesscontrol.DoesUserExist method must return false.

On this page

Usage

Privileges. This method requires Update privileges.

Parameters.

The parameters for the UpdateUserName 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 as returned by the accesscontrol.LookupUserId method
userName	String	User name

Output. This method returns an integer. If the method is successful, the value is 1 and if no change was made, the value is 0. If there is a failure, the API issues an exception.

Samples

Sample C# Code

iReturnCode = accesscontrol.UpdateUserName(sSessionToken, 123, “newusername”);

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/UpdateUserName"

<?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>

<userName>string</userName>

</UpdateUserName>

</soap:Body>

</soap:Envelope>

Sample Response

HTTP/1.1 200 OK