User Attributes Object

User accounts can be initialized as either an End-User or Service User:
  • End-User accounts are assigned to employees.
  • Service User accounts are used by applications such as the LDAP sync or any application or bot built using the Symphony APIs.
Do not assign Service User accounts to an employee. Calling certain endpoints requires a Service User configured with the correct role or roles. For more information about End-User and Service User accounts and their roles, see the Symphony Administration Guide.

End-User Account Attributes V2

firstName and lastName have a 64-character limit. All other End-User attributes have a 256-character limit.
The following attributes apply to the Create User V2 and Update User v2 endpoints. Note that the column "Required at Creation" concerns only the Create User v2 endpoint.
userAttributes Object
Required at Creationn
Possible Values
accountType
Possible values: NORMAL (end-user), SYSTEM (service user). If not specified, NORMAL will be used. When you create a SYSTEM account, the following properties are not required: firstName, lastName.
emailAddress
The user's email address. Must be unique.
firstName
The user's first name. Required for NORMAL users.
lastName
The user's last name. Required for NORMAL users.
userName
Must be unique.
displayName
The user's display name.
companyName
The user's company name.
If not specified, it is set with the default company name.
department
The user's department.
division
The user's division.
title
The user's title.
workPhoneNumber
The user's work phone number.
mobilePhoneNumber
The user's mobile number.
twoFactorAuthPhone
The user's two factor authentication mobile phone number.
smsNumber
The user's SMS number.
location
The user's location.
recommendedLanguage
The recommended language.
jobFunction
The user's job function. Possible values:
Analyst, Other Business Development Executive Corporate Access Developer Director Economist Portfolio Manager Project Manager Research Analyst Sales Strategist Trader
assetClasses
The user's asset classes. Possible values:
Currencies Commodities Equities Fixed Income
industries
The user's industries. Possible values:
Basic Materials Conglomerates Consumer Cyclicals Consumer Non-Cyclicals Energy & Utilities Financials Healthcare Real Estate Services Technology Transportation
marketCoverage
Possible values:
EMEA NA APAC LATAM
responsibility
Possible values:
BAU Escalation
function
Possible values:
Collateral Margin Liquidity Management Regulatory Outreach Confirmation Matching Allocation Settlements Trade Processing Claims Processing Trade Management Post Trade Management Middle Office Pre-Matching
instrument
Possible values:
Securities Fixed Income Equities
currentKey
A UserKeyRequest Object containing the current RSA key information to use for authenticating the user. When updating the user, this can be set (rotated) to a new key, in which case the existing key is stored in the previousKey and can be used for authentication during the current session
previousKey
A UserKeyRequest Object containing the RSA key information from the previous key in a key rotation scenario. The previous key can be used when the currentKey has been updated during the current session. The previousKey is valid for 72 hours.

Service User Account Attributes

`userAttributes` Object
Required
Possible Values
accountType
SYSTEM
userName
Must be unique.
emailAddress
The user's email address.
displayName
The user's display name.
companyName
The user's company name. If not specified, it is set with the default company name.
department
The user's department.
division
The user's division
workPhoneNumber
The user's work phone number.
mobilePhoneNumber
The user's mobile number.
twoFactorAuthPhone
The user's two factor authentication mobile phone number.
location
The user's location.
recommendedLanguage
The recommended language.
jobFunction
The user's job function. Possible values: Analyst, Other Business Development Executive Corporate Access Developer Director Economist Portfolio Manager Project Manager Research Analyst Sales Strategist Trader
assetClasses
The user's asset classes. Possible values: Currencies Commodities Equities Fixed Income
industries
The user's industries. Possible values: Basic Materials Conglomerates Consumer Cyclicals Consumer Non-Cyclicals Energy & Utilities Financials Healthcare Real Estate Services Technology Transportation
marketCoverage
Possible values: EMEA NA APAC LATAM
responsibility
Possible values: BAU Escalation
function
Possible values: Collateral Margin Liquidity Management Regulatory Outreach Confirmation Matching Allocation Settlements Trade Processing Claims Processing Trade Management Post Trade Management Middle Office Pre-Matching
instrument
Possible values: Securities Fixed Income Equities
currentKey
A UserKeyRequest Object containing the current RSA key information to use for authenticating the user. When updating the user, this can be set (rotated) to a new key, in which case the existing key is stored in the previousKey and can be used for authentication during the current session.
previousKey
A UserKeyRequest Object containing the RSA key information from the previous key in a key rotation scenario. The previous key can be used when the currentKey has been updated during the current session. The previousKey is valid for 72 hours.
Last modified 2mo ago