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 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. See Service User Account Endpoints.

For more information about End-User and Service User accounts and their roles, see the Symphony Administration Guide.

End-User Account Attributes V1

This object is used with older endpoints. See End-User Account Attributes V2 for the latest available version of this object.

The following attributes apply to the Create User and Update User v2 endpoints.

Note that the column "Required at Creation" concerns only the Create User v2 endpoint.
Note that firstName and lastName have a 64-character limit. All other End-User attributes have a 256-character limit.

userAttributes Object

Required at Creation

Possible Values

accountType

No

NORMAL
(assigned by default when you create a user)

emailAddress

Yes

Must be unique.

firstName

Yes

lastName

Yes

userName

Yes

The username must be unique and must not match any existing usernames or app IDs.

displayName

Yes

companyName

Yes

The user's company name.

department

No

division

No

title

No

workPhoneNumber

No

mobilePhoneNumber

No

location

No

jobFunction

No

Analyst, Other
Business Development Executive
Corporate Access
Developer
Director
Economist
Portfolio Manager
Project Manager
Research Analyst
Sales
Strategist
Trader

assetClasses

No

Currencies
Commodities
Equities
Fixed Income

industries

No

Basic Materials
Conglomerates
Consumer Cyclicals
Consumer Non-Cyclicals
Energy & Utilities
Financials
Healthcare
Real Estate
Services
Technology
Transportation

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 Creation

Possible Values

accountType

No

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

Yes

The user's email address.
Must be unique.

firstName

Yes

The user's first name. Required for NORMAL users.

lastName

Yes

The user's last name. Required for NORMAL users.

userName

Yes

Must be unique.

displayName

Yes

The user's display name.

companyName

No

The user's company name.

If not specified, it is set with the default company name.

department

No

The user's department.

division

No

The user's division

title

No

The user's title.

workPhoneNumber

No

The user's work phone number.

mobilePhoneNumber

No

The user's mobile number.

twoFactorAuthPhone

No

The user's two factor authentication mobile phone number.

smsNumber

No

The user's SMS number.

location

No

The user's location.

recommendedLanguage

No

The recommended language.

jobFunction

No

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

No

The user's asset classes.
Possible values:

Currencies
Commodities
Equities
Fixed Income

industries

No

The user's industries.
Possible values:

Basic Materials
Conglomerates
Consumer Cyclicals
Consumer Non-Cyclicals
Energy & Utilities
Financials
Healthcare
Real Estate
Services
Technology
Transportation

marketCoverage

No

Possible values:

EMEA
NA
APAC
LATAM

responsibility

No

Possible values:

BAU
Escalation

function

No

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

No

Possible values:

Securities
Fixed Income
Equities

currentKey

No

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

No

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

Yes

SYSTEM

userName

Yes

Must be unique.

emailAddress

Yes

The user's email address.

displayName

Yes

The user's display name.

companyName

No

The user's company name.

If not specified, it is set with the default company name.

department

No

The user's department.

division

No

The user's division

workPhoneNumber

No

The user's work phone number.

mobilePhoneNumber

No

The user's mobile number.

twoFactorAuthPhone

No

The user's two factor authentication mobile phone number.

location

No

The user's location.

recommendedLanguage

No

The recommended language.

jobFunction

No

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

No

The user's asset classes.
Possible values:

Currencies
Commodities
Equities
Fixed Income

industries

No

The user's industries. Possible values:

Basic Materials
Conglomerates
Consumer Cyclicals
Consumer Non-Cyclicals
Energy & Utilities
Financials
Healthcare
Real Estate
Services
Technology
Transportation

marketCoverage

No

Possible values:

EMEA
NA
APAC
LATAM

responsibility

No

Possible values:

BAU
Escalation

function

No

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

No

Possible values:

Securities
Fixed Income
Equities

currentKey

No

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

No

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.