GET v1/users({UserId})
Returns Details for a User
Information:
Base URL:
https://api.covasoft.net/usermanager
Example of a call would be:
https://api.covasoft.net/usermanager/v1/users({UserId})
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
UserId |
The User Id used for Getting User Details |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Details for a User
GetUserDetailsReturnName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
CorrelationId | string |
None. |
|
ClientUserId | string |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
UserName | string |
None. |
|
string |
None. |
||
IsActive | boolean |
None. |
|
ParentEntityId | integer |
None. |
|
ParentEntityName | string |
None. |
|
Profiles | Collection of Object |
None. |
|
Picture | UserPicture |
None. |
|
Address | UserAddress |
None. |
|
PhoneNumbers | Collection of UserPhoneNumber |
None. |
|
JobTitle | string |
None. |
|
Attributes | UserAttributes |
None. |
|
Version | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "CorrelationId": "sample string 1", "ClientUserId": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "UserName": "sample string 5", "Email": "sample string 6", "IsActive": true, "ParentEntityId": 1, "ParentEntityName": "sample string 8", "Profiles": [ {}, {} ], "Picture": { "Id": "dea990a8-e59c-4c92-add0-5b9c38f26d43", "Href": "http://webapihelppage2.com", "Height": 1.1, "Width": 1.1, "Md5Checksum": "sample string 3", "Name": "sample string 4", "MimeType": "sample string 5" }, "Address": { "AddressLine1": "sample string 1", "AddressLine2": "sample string 2", "City": "sample string 3", "StateCode": "sample string 4", "CountryCode": "sample string 5", "Zip": "sample string 6" }, "PhoneNumbers": [ { "Number": "sample string 1", "Extension": "sample string 2", "Type": "sample string 3" }, { "Number": "sample string 1", "Extension": "sample string 2", "Type": "sample string 3" } ], "JobTitle": "sample string 9", "Attributes": { "Department": "sample string 1", "BadgeId": 2 }, "Version": 1 }