Get User Details: The GetUserDetails method allows you to retrieve the details about a user.
REQUEST ATTRIBUTES
userId |
int |
|
---|---|---|
tokenIn |
string |
This is the security token that is obtained by the previous API call. See API Security topic for more details |
RETURN ATTRIBUTES
addressLine1 |
string |
|
---|---|---|
addressLine2 |
string |
|
alternateEmailAddress |
string |
|
countryISO |
string |
|
cellphone |
string |
|
customId |
string |
|
directoryServiceUserName |
string |
|
emailAddress |
string |
|
fax |
string |
|
firstName |
string |
|
GetUserDetailsResult |
int |
An integer result indicating success (= 0) or an error (<> 0) |
isActive |
boolean |
Indicates if the user is active or not |
languageISO |
string |
|
lastName |
string |
|
roles |
bitfield |
Valid options are: 1 = Apps 2 = Reports 4 = Connections 8 = Users 16 = Account 32 = API 64 = External Portal 128 = Folders 256 = Archiving 512 = Publish 1024 = Failed Notification |
skype |
string |
|
stateProvince |
string |
|
telephone |
string |
|
title |
string |
|
tokenOut |
string |
This is the new security token that should be used for the next function call after this one. See the API Security topic for more details |
town |
string |
|
userType |
string |
Valid options are: Basic Advanced Limited |
zipCode |
string |
REST
The following is a sample REST request and response. The placeholders shown need to be replaced with actual values.
POST /REST/api/portal/GetUserDetails HTTP/1.1 Host: <server url> Content-Type: multipart/form-data
Content-Disposition: form-data; name="UserId" string Content-Disposition: form-data; name="tokenIn" string |
HTTP/1.1 200 OK Content-Length: length Content-Type: application/json; charset=utf-8 { "addressLine1":string, "addressLine2":string, "alternateEmailAddress":string, "countryISO":string, "cellphone":string, "customId":string, "directoryServiceUserName":string, "emailAddress":string, "fax":string, "firstName":string, "GetUserDetailsResult":int, "isActive":boolean, "languageISO":string, "lastName":string, "roles":bitfield, "skype":string, "stateProvince":string, "telephone":string, "title":string, "tokenOut":string, "town":string, "userType":string, "zipCode":string } |
Return to: Account API Methods (REST), Integration