POST wrapper/user/get
(SLUserGet) Gets the details for a User in a FinScan Organization
Request Information
URI Parameters
None.
Body Parameters
LSTServicesUserGetRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| organizationName |
The User's Organization Name. |
string |
None. |
| userName |
The User's Name. |
string |
None. |
| password |
The User's Password. |
string |
None. |
| userOrganizationName |
The Organization Name of the User to Get. |
string |
None. |
| userUserName |
The UserName of the User to Get. |
string |
None. |
Request Formats
application/json, text/json
{
"organizationName": "sample string 1",
"userName": "sample string 2",
"password": "sample string 3",
"userOrganizationName": "sample string 4",
"userUserName": "sample string 5"
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
LSTServicesUserGetResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| status |
The Current Status of the User Get within FinScan [Pass or Error]. |
SLResultTypeEnum |
None. |
| message |
String containing information on the User Get status/results including Error details. |
string |
None. |
| userDisplayName |
The name displayed for the User within FinScan. |
string |
None. |
| userStatus |
The Status of the User [Active or Inactive] |
SLClientStatusEnum |
None. |
| userEAddress |
The Email Address of the User. |
string |
None. |
| userPhone |
The Phone Number of the User. |
string |
None. |
| userGroups |
The Groups of the User. |
Collection of string |
None. |
| userDenyGUILogin |
Whether the User is Allowed to Log Into FinScan |
SLYesNoEnum |
None. |
| userComments |
The Comments of the User. |
string |
None. |
| userIsComplianceCentric |
Whether the User is Compliance Centric (or Client Centric) for Review. |
SLYesNoEnum |
None. |
| userLanguage |
The Language of the User. |
SLLanguageCodesEnum |
None. |
| userPasswordNeverExpires |
Whether the User's Password will expire. |
SLYesNoEnum |
None. |
| userWebServiceIdentity |
Whether or not the User is allowed to make Web Service calls. |
SLWebServiceIdentitiesEnum |
None. |
| version |
The version of the Wrapper. |
string |
None. |
| isiReserved |
A field used to return debugging information. |
string |
None. |
Response Formats
application/json, text/json
{
"status": 0,
"message": "sample string 1",
"userDisplayName": "sample string 2",
"userStatus": 0,
"userEAddress": "sample string 3",
"userPhone": "sample string 4",
"userGroups": [
"sample string 1",
"sample string 2"
],
"userDenyGUILogin": 0,
"userComments": "sample string 5",
"userIsComplianceCentric": 0,
"userLanguage": 0,
"userPasswordNeverExpires": 0,
"userWebServiceIdentity": 0,
"version": "sample string 6",
"isiReserved": "sample string 7"
}