FINOS User API
The User API from FINOS — 24 operation(s) for user.
The User API from FINOS — 24 operation(s) for user.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/finos-user-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 20.17.1
title: Pod User API
description: 'This document refers to Symphony API calls that do not need
encryption or decryption of content.
- sessionToken can be obtained by calling the
authenticationAPI on the symphony back end and the key manager
respectively. Refer to the methods described in authenticatorAPI.yaml.
- Actions are defined to be atomic, ie will succeed in their entirety
or fail and have changed nothing.
- If it returns a 40X status then it will have made no change to the
system even if ome subset of the request would have succeeded.
- If this contract cannot be met for any reason then this is an error
and the response code will be 50X.
'
servers:
- url: https://yourpodURL.symphony.com/pod
tags:
- name: User
paths:
/v2/admin/user/list:
get:
summary: Retrieve a list of all users in the company (pod)
parameters:
- name: sessionToken
description: Session Authentication token.
in: header
required: true
schema:
type: string
- name: skip
description: Number of users to skip. Default is 0. Must be a integer equals or bigger than 0.
in: query
required: false
schema:
type: integer
- name: limit
description: Maximum number of users to return. Default is 100. Must be a positive integer and must not exceed 1000.
in: query
required: false
schema:
type: integer
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/V2UserDetailList'
example:
- userAttributes:
emailAddress: nexus.user@email.com
userName: nexus.user
displayName: nexus.user
accountType: SYSTEM
userSystemInfo:
id: 9826885173290
status: ENABLED
suspended: false
createdDate: 1499375475000
createdBy: '9826885173255'
lastUpdatedDate: 1499375475852
lastLoginDate: 1504899124191
roles:
- USER_PROVISIONING
- CONTENT_MANAGEMENT
- INDIVIDUAL
- userAttributes:
emailAddress: admin@mail.com
firstName: admin
lastName: admin
userName: admin@mail.com
displayName: Admin Admin
companyName: Company Name
department: Departament
division: Division
title: Administrator
twoFactorAuthPhone: '+15419999999'
workPhoneNumber: '+15419999999'
mobilePhoneNumber: '+15419999999'
accountType: NORMAL
assetClasses:
- Currencies
industries:
- Technology
userSystemInfo:
id: 7696581394433
status: ENABLED
suspended: false
createdDate: 1438054194000
lastUpdatedDate: 1527532171729
lastLoginDate: 1523912043015
roles:
- SUPER_COMPLIANCE_OFFICER
- INDIVIDUAL
- SUPER_ADMINISTRATOR
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
/v1/admin/user/find:
post:
summary: Find a user based on attributes
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: skip
description: Number of users to skip. Default is 0. Must be a integer equals or bigger than 0.
in: query
required: false
schema:
type: integer
- name: limit
description: Maximum number of users to return. Default is 100. Must be a positive integer and must not exceed 1000.
in: query
required: false
schema:
type: integer
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailList'
example:
- userAttributes:
emailAddress: janedoe@symphony.com
firstName: Jane
lastName: Doe
userName: jane.doe
displayName: Jane Doe
accountType: NORMAL
assetClasses:
- Commodities
industries:
- Financials
- Healthcare
userSystemInfo:
id: 9826885173258
status: ENABLED
suspended: true
suspensionReason: The user will be OOO due to a mandatory leave
suspendedUntil: 1601546400
createdDate: 1499347606000
createdBy: '9826885173252'
lastUpdatedDate: 1499348554853
lastLoginDate: 1504839044527
roles:
- INDIVIDUAL
- userAttributes:
emailAddress: nexus.user@email.com
userName: nexus.user
displayName: nexus.user
accountType: SYSTEM
userSystemInfo:
id: 9826885173290
status: ENABLED
suspended: false
createdDate: 1499375475000
createdBy: '9826885173255'
lastUpdatedDate: 1499375475852
lastLoginDate: 1504899124191
roles:
- USER_PROVISIONING
- CONTENT_MANAGEMENT
- INDIVIDUAL
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserFilter'
required: true
/v1/admin/user/{uid}/roles/add:
post:
summary: Add a role to a user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
example:
format: TEXT
message: Role added
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StringId'
required: true
/v1/admin/user/{uid}/roles/remove:
post:
summary: Remove a role from a user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
example:
format: TEXT
message: Role removed
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'404':
description: 'Not Found: User cannot be found.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: // Not Found. User cannot be found. See response body for fruther details.
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StringId'
required: true
/v1/admin/user/{uid}/avatar:
get:
summary: Get the URL of the avatar of a particular user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AvatarList'
example:
- size: original
url: ../avatars/izcQTdRVFOK_qhCrYeQOpIuHKuZuMk3J88Uz_bShzM8.png
- size: small
url: ../avatars/izcQTdRVFOK_qhCrYeQOpIuHKuZuMk3J88Uz_bShzM8_small.png
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
/v1/admin/user/{uid}/avatar/update:
post:
summary: Update the avatar of a particular user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
example:
format: TEXT
message: OK
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AvatarUpdate'
required: true
/v1/admin/user/{uid}/disclaimer:
get:
summary: Get the disclaimer assigned to a user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Disclaimer'
example:
id: 571d2052e4b042aaf06d2e7a
name: Enterprise Disclaimer
content: This is a disclaimer for the enterprise.
frequencyInHours: 24
isDefault: false
isActive: true
createdDate: 1461526610846
modifiedDate: 1461526610846
'204':
description: No content. User doesn't have an assigned disclaimer
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
delete:
summary: Unassign a disclaimer from a user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
example:
format: TEXT
message: OK
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
/v1/admin/user/{uid}/disclaimer/update:
post:
summary: Assign a disclaimer to a user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
example:
format: TEXT
message: OK
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StringId'
required: true
/v1/admin/user/{uid}/delegates:
get:
summary: Get the delegates assigned to a user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: The userid's of the delegates of this user.
content:
application/json:
schema:
$ref: '#/components/schemas/IntegerList'
example:
- 7215545078461
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
/v1/admin/user/{uid}/delegates/update:
post:
summary: Update the delegates assigned to a user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: Sucesss.
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
example:
format: TEXT
message: Added delegate [7215545078461] for account [7215545078541]
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DelegateAction'
required: true
/v1/admin/user/{uid}/features:
get:
summary: Get the list of Symphony feature entitlements enabled for a particular user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureList'
example:
- entitlment: canCreatePublicRoom
enabled: true
- entitlment: isExternalRoomEnabled
enabled: false
- entitlment: delegatesEnabled
enabled: true
- entitlment: isExternalIMEnabled
enabled: true
- entitlment: sendFilesEnabled
enabled: true
- entitlment: canUpdateAvatar
enabled: true
'400':
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: // Client error, see response body for further details.
'401':
description: 'Unauthorized: Invalid session token.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Invalid session
'403':
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: The user lacks the required entitlement to perform this operation
'500':
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: // Server error, see response body for further details.
/v1/admin/user/{uid}/features/update:
post:
summary: Update the list of Symphony feature entitlements for a particular user
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
- name: uid
description: 'User ID as a decimal integer
'
in: path
required: true
schema:
type: integer
format: int64
tags:
- User
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
example:
format: TEXT
message: OK
'400':
description: Client error, see response body for further details.
co
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finos/refs/heads/main/openapi/finos-user-api-openapi.yml