Update User

Updates an existing user.
post
https://yourpodURL.symphony.com/pod
/v2/admin/user/{uid}/update
Update an existing V2 User
Parameters
Path
uid*
string
User ID as a decimal integer
Header
sessionToken*
string
Session authentication token.
Body
emailAddress
string
firstName
string
lastName
string
userName
string
displayName
string
companyName
string
department
string
division
string
title
string
workPhoneNumber
string
mobilePhoneNumber
string
twoFactorAuthPhone
string
smsNumber
string
accountType
string
location
string
recommendedLanguage
string
jobFunction
string
assetClasses
array
industries
array
marketCoverage
array
responsibility
array
function
array
instrument
array
currentKey
object
User RSA key information.
previousKey
Body
Example
Schema
{
"emailAddress": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"userName": "johndoe",
"displayName": "John Doe",
"companyName": "Company",
"department": "Department",
"division": "Division",
"title": "Trader",
"workPhoneNumber": "+15419999999",
"mobilePhoneNumber": "+15419999999",
"twoFactorAuthPhone": "+15419999999",
"smsNumber": "+15419999999",
"accountType": "NORMAL",
"location": "New York",
"recommendedLanguage": "english",
"jobFunction": "Trader",
"assetClasses": [
"Equities"
],
"industries": [
"Healthcare",
"Technology"
],
"marketCoverage": [
"EMEA"
],
"responsibility": [
"BAU"
],
"function": [
"Trade Processing"
],
"instrument": [
"Equities"
],
"currentKey": {
"key": "-----BEGIN PUBLIC KEY-----\\nMIICIANBgkqhw0BAQ...cCAwEAAQ==\\n-----END PUBLIC KEY-----",
"expirationDate": 1467562406219,
"action": "SAVE"
}
}
Responses
200: OK
Success
400: Bad Request
Client error, see response body for further details.
401: Unauthorized
Unauthorized: Invalid session token.
403: Forbidden
Forbidden: Caller lacks necessary entitlement.
500: Internal Server Error
Server error, see response body for further details.

Request Example

curl -X POST \
https://acme.symphony.com/pod/v1/admin/user/7215545078541/update \
-H "sessionToken: SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"accountType": "NORMAL",
"firstName": "Jane",
"lastName": "Doe",
"username": "janedoe",
"displayName": "Jane Doe",
"companyName": "Symphony",
"department": "",
"division": "",
"title": "Sales Manager",
"workPhoneNumber": "",
"mobilePhoneNumber": "",
"twoFactorAuthPhone": "",
"location": "San Francisco",
"jobFunction": "Sales",
"assetClasses": ["Commodities"],
"industries": ["Basic Materials"],
"marketCoverage": ["EMEA"],
"responsibility": ["BAU"],
"function": ["Trade Management"],
"instrument": ["Securities"],
"currentKey": {
"key":"-----BEGIN PUBLIC KEY-----\nMIICIj...==\n-----END PUBLIC KEY-----",
"action":"SAVE"
}
}'

📘 Note - Suspension

Since 20.14, userSystemInfo from the payload includes suspension info:
  • if user is active, then the suspended attribute is set to false,
  • if user is suspended, then the suspended attribute is set to true and both suspendedUntil and suspensionReason are as well included in the payload.
Please note that even if the suspendedUntil date is in the past, the user will remain suspended=true until he first logs on the client after the suspension ended. The suspended info are then automatically updated. See the Suspend User Account endpoint for more information.

🚧 Required Permissions

Calling this endpoint requires the ACCESS_USER_PROVISIONING_API and ACCESS_ADMIN_API privileges. See Bot Permissions for a list of roles and associated privileges.

❗️ Known Issues

There is a known bug where the "Industries" and "Asset Classes" fields cannot be cleared once set. For example, if you set assetClasses on a user to [Conglomerates, Healthcare], you can update the user and set it to [Conglomerates], but you cannot update the user and clear it by setting it to [].
Last modified 2mo ago