Symphony Messaging REST APIs
  • Symphony Messaging API Reference documentation
  • Endpoints Reference
    • Bots Authentication
      • Session Authenticate
      • Key Manager Authenticate
      • Session Authenticate (Cert)
      • Key Manager Authenticate (Cert)
      • Session Logout
      • Key Manager Logout
    • Apps Authentication
      • Authenticate App
      • Pod Certificate
    • Apps On Behalf Of (OBO)
      • API Endpoints for Apps
      • App Authentication
      • User Authentication by User ID
      • User Authentication by User Name
    • Info - Health Check
      • Health Check
      • Health Check Extended
      • Session User
      • Agent Info
      • Echo
    • Messages
      • Get Messages
      • Create Message
      • Blast Message
      • Attachment
      • Import Message
      • Update Message
      • Suppress Message
      • Message Search
      • Message Search
      • Message Status
      • Attachment Types
      • Get Message
      • List Attachments
      • List Message Receipts
      • Message Metadata
    • Datafeed - Real Time Events
      • Create Datafeed
      • Read Datafeed
      • List Datafeed
      • Delete Datafeed
    • Datahose - Pod Real Time Events
      • Datahose - Read Events
    • Streams - Conversations
      • Related to IMs
        • Create IM
        • Create IM non-inclusive
        • Update IM
        • IM Info
      • Related to Rooms
        • Room Attributes
        • Create Room
        • Update Room
        • Room Info
        • De/Re-activate Room
        • Room Members
        • Add Member
        • Remove Member
        • Promote Owner
        • Demote Owner
        • Search Rooms
      • All streams
        • Share Content
        • List User Streams
        • List User Streams (Admin)
        • Stream Info
        • List Streams for Enterprise
        • Stream Members
    • Signals
      • List Signals
      • Get Signal
      • Create Signal
      • Update Signal
      • Delete Signal
      • Subscribe Signal
      • Unsubscribe Signal
      • Suscribers
      • Signal Object
    • Connections
      • Get Connection
      • List Connection
      • Create Connection
      • Accept Connection
      • Reject Connection
      • Remove Connection
    • Presence
      • Get Presence
      • Get All Presence
      • Get User Presence
      • External Presence Interest
      • Set Presence
      • Set Other User's Presence - Admin
    • Users
      • Users Lookup
      • Search Users
      • Follow User
      • Unfollow User
      • List User Followers
      • List Users Followed
    • User Management
      • User Attributes Object
      • Password Object
      • Roles Object
      • UserKeyRequest Object
      • Get User
      • List Users
      • Create User
      • Update User
      • User Avatar
      • Update User Avatar
      • User Status
      • Update User Status
      • List Features
      • User Features
      • Update User Features
      • Find Users
      • List Roles
      • Add Role
      • Remove Role
      • List Audit Trail
      • Suspend User Account
      • Get Bot Manifest
      • Update Bot Manifest
    • User Sessions
      • List Sessions
      • Logout Session
      • Logout All Sessions
    • Groups - Distribution Lists
      • OAuth2 Authenticate
      • Add a new user to an existing group
      • Insert a new group
      • Retrieve a group
      • Update a group
      • List all groups of specified type
      • Update the group avatar
    • URI Protocols
      • Create Protocol
      • List Protocols
      • Delete Protocol
    • Manage Apps
      • Create App
      • Update App
      • Delete App
      • Get App
    • Apps Entitlements
      • List Apps
      • Update App Entitlements
      • List User Apps
      • Update User Apps
      • Update All User Apps
    • Disclaimers
      • Disclaimer
      • List Disclaimers
      • List Disclaimer Users
      • User Disclaimer
      • Update User Disclaimer
      • Unassign User Disclaimer
    • Delegates
      • User Delegates
      • Update User Delegates
    • Information Barrier Groups
      • List IB Groups
      • List IB Group Members
      • Add IB Group Members
      • Remove IB Group Members
      • List Policies
    • Certificates
      • Public (Signing) Certificate
      • List Company Certificates
      • Create Company Certificate
      • Delete Company Certificate
      • Company Certificate Details
      • List Verified Certificates
      • List Trusted Certificates
      • List Certificate Types
      • Update Company Certificate
    • Malware Scanner
      • Malware Scanner APIs
        • File Malware Scanner State
        • Update File Malware Scanner State
      • Customer Malware Scanner APIs
        • Malware Scanner Health
        • File Malware Scanner
    • DLP Dictionary & Policy Management
      • Overview
      • Dictionary Management endpoints
        • Create Dictionary
        • All Dictionaries
        • Specific Dictionary
        • Update Dictionary
        • Upload Dictionary Content
        • Download Dictionary Content
        • Delete Dictionary
      • V3 Policy Management endpoints
        • V3 Policy structure for Create/Update
        • V3 Create Policy
        • V3 All Policies
        • V3 Get Policy
        • V3 Update Policy
        • V3 Enable Policy
        • V3 Disable Policy
        • V3 Delete Policy
      • V3 Violations endpoints
        • V3 Violations - Sample Responses
        • V3 Violations - Special Scenarios of Attachments
        • V3 Message Violations
        • V3 Signal Violations
        • V3 Stream Violations
        • V3 Violation Attachment Download
    • Audit Trail 2
      • OAuth2 Authenticate
      • Get Audit trails
      • Get distinct values of a list of filters
      • Get Audit Trail Stream
      • Get categories permissions
    • Compliance Barrier Groups
      • Compliance Group Types
      • Compliance User Groups
        • List Compliance User Groups
        • Get a Compliance User Group
        • Create a Compliance User Group
        • Update a Compliance User Group
      • Compliance Group Assignments
        • List Assignments
        • List Compliance Group Assignments
        • Update a Compliance Group
      • Compliance Group Memberships
        • List Memberships
        • List Compliance Group Memberships
        • Add Compliance Group Membership
        • Update a User Membership
  • Deprecated Endpoints
    • DLP Dictionary and Policy management
      • V2 Policy Management endpoints
        • V2 Create Policy
        • V2 All Policies
        • V2 Get Policy
        • V2 Update Policy
        • V2 Enable Policy
        • V2 Disable Policy
        • V2 Delete Policy
      • V2 Violations endpoints
        • V2 Signal Violations
        • V2 Message Violations
        • V2 Stream Violations
    • Create Presence Feed
    • Read Presence Feed
    • Delete Presence Feed
    • Get Message IDs by Timestamp
    • Health Check v2
    • Datafeed 1
      • Create Datafeed 1
      • Read Datafeed 1
Powered by GitBook
On this page
  • End-User Account Attributes V2
  • Service User Account Attributes

Was this helpful?

  1. Endpoints Reference
  2. User Management

User Attributes Object

Last updated 1 year ago

Was this helpful?

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 .

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 and endpoints. Note that the column "Required at Creation" concerns only the 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

previousKey

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

previousKey

A 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

A 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.

A 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.

A 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.

Symphony Administration Guide
Create User V2
Update User v2
Create User v2
UserKeyRequest Object
UserKeyRequest Object
UserKeyRequest Object
UserKeyRequest Object