POST wrapper/user/add

(SLUserAdd) Adds a new User to a FinScan Organization

Request Information

URI Parameters

None.

Body Parameters

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		string	None.
userUserName		string	None.
userDisplayName		string	None.
userPassword		string	None.
userStatus		SLClientStatusEnum	None.
userEAddress		string	None.
userPhone		string	None.
userGroups		Collection of string	None.
userDenyGUILogin		SLYesNoEnum	None.
userComments		string	None.
userIsComplianceCentric		SLYesNoEnum	None.
userLanguage		SLLanguageCodesEnum	None.
userPasswordNeverExpires		SLYesNoEnum	None.
userWebServiceIdentity		SLWebServiceIdentitiesEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "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/xml, text/xml

Sample:

<LSTServicesUserAddRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <organizationName>sample string 1</organizationName>
  <password>sample string 3</password>
  <userComments>sample string 10</userComments>
  <userDenyGUILogin>No</userDenyGUILogin>
  <userDisplayName>sample string 6</userDisplayName>
  <userEAddress>sample string 8</userEAddress>
  <userGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </userGroups>
  <userIsComplianceCentric>No</userIsComplianceCentric>
  <userLanguage>ENG</userLanguage>
  <userName>sample string 2</userName>
  <userOrganizationName>sample string 4</userOrganizationName>
  <userPassword>sample string 7</userPassword>
  <userPasswordNeverExpires>No</userPasswordNeverExpires>
  <userPhone>sample string 9</userPhone>
  <userStatus>Active</userStatus>
  <userUserName>sample string 5</userUserName>
  <userWebServiceIdentity>NONE</userWebServiceIdentity>
</LSTServicesUserAddRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesUserAddResponse

Name	Description	Type	Additional information
status	The Current Status of the Client matches within FinScan [Pass, Pending, Fail, Error or Duplicate].	SLResultTypeEnum	None.
message	String containing information on the Search 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

Sample:

{
  "status": 0,
  "message": "sample string 1",
  "version": "sample string 2",
  "isiReserved": "sample string 3"
}

application/xml, text/xml

Sample:

<LSTServicesUserAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <isiReserved>sample string 3</isiReserved>
  <message>sample string 1</message>
  <status>PASS</status>
  <version>sample string 2</version>
</LSTServicesUserAddResponse>