/api/users/updateUserPassword (Update user password)

Update user password

PATCH/api/users/updateUserPassword

Use it in a workflow

Add a step and choose the TradeBeyond connector.
Pick the /api/users/updateUserPassword (Update user password) action (under CbxUserController).
Fill in the fields below, then reference the result from later steps as {{apiUsersUpdateuserpasswordUpdateUserPassword.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

aliasstring

ssoUserIdstring

additionalSsoUserIdsstring

loginIdstring

firstNamestring

lastNamestring

userNamestring

oldPasswordstring

newPasswordstring

emailstring

phonestring

mobilestring

isReceiveNotificationboolean

languageobject

codestringrequired

namestring

versioninteger (int32)

defaultModuleobject

codestringrequired

namestring

versioninteger (int32)

newuiTimeZoneobject

codestringrequired

namestring

versioninteger (int32)

dateFormatobject

codestringrequired

namestring

versioninteger (int32)

substituteListarray<object>

refEntitystring

codestring

refKeystring

statusstring

factCodestring

idstringrequired

refNostring

namestring

versioninteger (int32)

isSystemSSOUserboolean

isAdminUserboolean

lastLogonTimestring (date-time)

photoIdobject

idstringrequired

fileNamestring

thumbnailboolean

filePathstring

fileSizestring

protocolstring

createUserstring

createUserNamestring

updateUserstring

updateUserNamestring

urlstring

angleinteger (int32)

hasMessageboolean

extraDataobject

Thumbnail urlstring

effectiveFromstring (date)

effectiveTostring (date)

json

{
  "alias": "string",
  "ssoUserId": "string",
  "additionalSsoUserIds": "string",
  "loginId": "string",
  "firstName": "string",
  "lastName": "string",
  "userName": "string",
  "oldPassword": "string",
  "newPassword": "string",
  "email": "string",
  "phone": "string",
  "mobile": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{apiUsersUpdateuserpasswordUpdateUserPassword.response.data.<field>}}.

idstring

refNostring

versioninteger (int32)

userNamestring

docStatusstring

json

{
  "id": "string",
  "refNo": "string",
  "version": 0,
  "userName": "string",
  "docStatus": "string"
}

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.

Was this page helpful?