LookupDomainUserId
The LookupDomainUserId method returns a user’s ID from the system.
On this page
Usage
Privileges. This method requires Read privileges.
Parameters.
Parameter |
Data Type |
Value |
---|---|---|
sessionToken |
String |
Valid sessionToken returned by the general.CreateUserSession method |
username |
String |
Provides the user name of the user as returned by the accesscontrol. |
userDomain |
String |
Name of the domain to which the users and groups belong |
Output. This method returns an integer. If the method is successful, the value is the corresponding user ID. If there is a failure, the API issues an exception.
Samples
Sample C# Code
iUserID = accesscontrol.LookupDomainUserId(sSessionToken, “username”, “domain”);
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/LookupDomainUserId"
<?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>
<LookupDomainUserId xmlns="http://archer-tech.com/webservices/">
<sessionToken>string</sessionToken>
<username>string</username>
<usersDomain>string</usersDomain>
</LookupDomainUserId>
</soap:Body>
</soap:Envelope>
Sample Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?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>
<LookupDomainUserIdResponse xmlns="http://archer-tech.com/webservices/">
<LookupDomainUserIdResult>int</LookupDomainUserIdResult>
</LookupDomainUserIdResponse>
</soap:Body>
</soap:Envelope>