search

Update User

Updates an existing user.

hashtag
Update an existing V2 User

post
Path parameters
uidinteger · int64Required

User ID as a decimal integer

Header parameters
sessionTokenstringRequired

Session authentication token.

Body

V2 User record.

emailAddressstringOptionalExample: [email protected]
firstNamestringOptionalExample: John
lastNamestringOptionalExample: Doe
userNamestringOptionalExample: johndoe
displayNamestringOptionalExample: John Doe
companyNamestringOptionalExample: Company
departmentstringOptionalExample: Department
divisionstringOptionalExample: Division
titlestringOptionalExample: Trader
workPhoneNumberstringOptionalExample: +15419999999
mobilePhoneNumberstringOptionalExample: +15419999999
twoFactorAuthPhonestringOptionalExample: +15419999999
smsNumberstringOptionalExample: +15419999999
accountTypestring · enumOptionalExample: NORMALPossible values:
locationstringOptionalExample: New York
recommendedLanguagestringOptionalExample: english
jobFunctionstringOptionalExample: Trader
assetClassesstring[]OptionalExample: ["Equities"]
industriesstring[]OptionalExample: ["Healthcare","Technology"]
marketCoveragestring[]OptionalExample: ["EMEA"]
responsibilitystring[]OptionalExample: ["BAU"]
functionstring[]OptionalExample: ["Trade Processing"]
instrumentstring[]OptionalExample: ["Equities"]
Responses
chevron-right
200

Success

application/json
post
/v2/admin/user/{uid}/update

hashtag
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"
    }    
}'

hashtag
📘 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.

hashtag
🚧 Required Permissions

Calling this endpoint requires the ACCESS_USER_PROVISIONING_API and ACCESS_ADMIN_API privileges. See Bot Permissionsarrow-up-right for a list of roles and associated privileges.

hashtag
❗️ 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 updated

Was this helpful?