Getting user information in JSON-RPC API
To get information about a user using their name, use the GetUserInfo
method.
Required parameters
Parameter | Description | Supported values |
---|---|---|
partnerId (required) |
The ID of the customer the user is created for (retrieved through the GetPartnerInfo method) |
<int> Integer |
nameOrEmail (required) |
The name or email address of the user to show details for | <std::String>
|
password
|
The password for the user to show details for | <std::String>
|
Sample request
{ "id": "jsonrpc", "visa": "{{visa}}", "method": "GetUserInfo", "jsonrpc": "2.0", "params": { "partnerId": 123456, "nameOrEmail": "user@domain.com" } }
Sample response
{ "id": "jsonrpc", "jsonrpc": "2.0", "result": { "result": { "EmailAddress": "user@domain.com", "FirstLoginTime": 1544458672, "FirstName": "User", "Flags": [ "SecurityOfficer" ], "FullName": "Test", "Id": 987654, "LastLoginTime": 1555593295, "Name": "user@domain.com", "PartnerId": 123456, "Password": null, "PhoneNumber": "", "RoleId": 1, "Title": "Reseller" } }, "visa": "{{visa}}" }