POST wrapper/user/update

(SLUserUpdate) Updates a User within 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	The Organization Name in which to Update the User	string	None.
userUserName	The Name of the User to be Updated.	string	None.
userPassword	The Password of the User to be Updated.	string	None.
fields	The additional fields of the User to be Updated.	SLUserUpdateFields	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",
  "userPassword": "sample string 6",
  "fields": {
    "newUserName": {
      "update": 0,
      "value": {}
    },
    "newUserDisplayName": {
      "update": 0,
      "value": {}
    },
    "newUserPassword": {
      "update": 0,
      "value": {}
    },
    "newStatus": {
      "update": 0,
      "value": {}
    },
    "newEAddress": {
      "update": 0,
      "value": {}
    },
    "newPhone": {
      "update": 0,
      "value": {}
    },
    "newGroups": [
      {
        "update": 0,
        "value": {}
      },
      {
        "update": 0,
        "value": {}
      }
    ],
    "removeGroups": [
      {
        "update": 0,
        "value": {}
      },
      {
        "update": 0,
        "value": {}
      }
    ],
    "newDenyGUILogin": {
      "update": 0,
      "value": {}
    },
    "newComments": {
      "update": 0,
      "value": {}
    },
    "newIsComplianceCentric": {
      "update": 0,
      "value": {}
    },
    "newLanguage": {
      "update": 0,
      "value": {}
    },
    "newPasswordNeverExpires": {
      "update": 0,
      "value": {}
    },
    "newWebServiceIdentity": {
      "update": 0,
      "value": {}
    }
  }
}

application/xml, text/xml

Sample:

<LSTServicesUserUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <fields>
    <newComments>
      <update>No</update>
      <value />
    </newComments>
    <newDenyGUILogin>
      <update>No</update>
      <value />
    </newDenyGUILogin>
    <newEAddress>
      <update>No</update>
      <value />
    </newEAddress>
    <newGroups>
      <SLUserUpdateField>
        <update>No</update>
        <value />
      </SLUserUpdateField>
      <SLUserUpdateField>
        <update>No</update>
        <value />
      </SLUserUpdateField>
    </newGroups>
    <newIsComplianceCentric>
      <update>No</update>
      <value />
    </newIsComplianceCentric>
    <newLanguage>
      <update>No</update>
      <value />
    </newLanguage>
    <newPasswordNeverExpires>
      <update>No</update>
      <value />
    </newPasswordNeverExpires>
    <newPhone>
      <update>No</update>
      <value />
    </newPhone>
    <newStatus>
      <update>No</update>
      <value />
    </newStatus>
    <newUserDisplayName>
      <update>No</update>
      <value />
    </newUserDisplayName>
    <newUserName>
      <update>No</update>
      <value />
    </newUserName>
    <newUserPassword>
      <update>No</update>
      <value />
    </newUserPassword>
    <newWebServiceIdentity>
      <update>No</update>
      <value />
    </newWebServiceIdentity>
    <removeGroups>
      <SLUserUpdateField>
        <update>No</update>
        <value />
      </SLUserUpdateField>
      <SLUserUpdateField>
        <update>No</update>
        <value />
      </SLUserUpdateField>
    </removeGroups>
  </fields>
  <organizationName>sample string 1</organizationName>
  <password>sample string 3</password>
  <userName>sample string 2</userName>
  <userOrganizationName>sample string 4</userOrganizationName>
  <userPassword>sample string 6</userPassword>
  <userUserName>sample string 5</userUserName>
</LSTServicesUserUpdateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesUserUpdateResponse

Name	Description	Type	Additional information
status	The Current Status of the Client matches within FinScan [Pass, Pending, Fail, Error or Duplicate].	SLResultTypeEnum	None.
code	A Code Value for the Status/Message returned.	SLWrapperCodes	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,
  "code": 0,
  "message": "sample string 1",
  "version": "sample string 2",
  "isiReserved": "sample string 3"
}

application/xml, text/xml

Sample:

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