POST wrapper/user/add
(SLUserAdd) Adds a new User to a FinScan Organization
Request Information
URI Parameters
None.
Body Parameters
LSTServicesUserAddRequestName | 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 in which to Add the User |
string |
None. |
userUserName |
The Name of the User to be Added. |
string |
None. |
userDisplayName |
The name to be displayed for the User within FinScan. |
string |
None. |
userPassword |
The Password of the User to be Added. |
string |
None. |
userStatus |
The Status of the User to be Added [Active or Inactive] |
SLClientStatusEnum |
None. |
userEAddress |
The Email Address of the User to be Added. |
string |
None. |
userPhone |
The Phone Number of the User to be Added. |
string |
None. |
userGroups |
The Groups of the User to be Added. |
Collection of string |
None. |
userDenyGUILogin |
Whether the User is Allowed to Log Into FinScan |
SLYesNoEnum |
None. |
userComments |
The Comments of the User to be Added. |
string |
None. |
userIsComplianceCentric |
Whether the User is Compliance Centric (or Client Centric) for Review. |
SLYesNoEnum |
None. |
userLanguage |
The Language of the User to be Added. |
SLLanguageCodesEnum |
None. |
userPasswordNeverExpires |
Whether the User's Password will expire. |
SLYesNoEnum |
None. |
userWebServiceIdentity |
Controls whether or not the User is allowed to make Web Service calls. |
SLWebServiceIdentitiesEnum |
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", "userDisplayName": "sample string 6", "userPassword": "sample string 7", "userStatus": 0, "userEAddress": "sample string 8", "userPhone": "sample string 9", "userGroups": [ "sample string 1", "sample string 2" ], "userDenyGUILogin": 0, "userComments": "sample string 10", "userIsComplianceCentric": 0, "userLanguage": 0, "userPasswordNeverExpires": 0, "userWebServiceIdentity": 0 }
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
LSTServicesUserAddResponseName | Description | Type | Additional information |
---|---|---|---|
status |
The Current Status of the Add User within FinScan [Pass or Error]. |
SLResultTypeEnum |
None. |
message |
String containing information on the Add User status/results including Error details. |
string |
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", "version": "sample string 2", "isiReserved": "sample string 3" }