POST wrapper/user/update

(SLUserUpdate) Updates a User within a FinScan Organization

Request Information

URI Parameters

None.

Body Parameters

LSTServicesUserUpdateRequest
NameDescriptionTypeAdditional 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": {}
      }
    ],
    "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/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesUserUpdateResponse
NameDescriptionTypeAdditional 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"
}