FINOS AppEntitlement API
The AppEntitlement API from FINOS — 2 operation(s) for appentitlement.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/finos-appentitlement-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
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 Specification
openapi: 3.2.0
info:
version: 20.17.1
title: Pod App Entitlement 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: AppEntitlement
paths:
/v1/admin/app/entitlement/list:
get:
summary: Get the list of application entitlements for the company
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
tags:
- AppEntitlement
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PodAppEntitlementList'
example:
- appId: djApp
appName: Dow Jones
enable: true
listed: true
install: 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.
post:
summary: Update the application entitlements for the company
parameters:
- name: sessionToken
description: Session authentication token.
in: header
required: true
schema:
type: string
tags:
- AppEntitlement
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PodAppEntitlementList'
example:
- appId: djApp
appName: Dow Jones
enable: true
listed: true
install: false
- appId: spcapiq
appName: S&P Capital IQ Data
enable: true
listed: true
install: false
- appId: selerity
appName: Selerity Context
enable: false
listed: true
install: 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.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PodAppEntitlementList'
required: true
/v1/admin/user/{uid}/app/entitlement/list:
get:
summary: Get the list of application entitlements for this 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:
- AppEntitlement
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UserAppEntitlementList'
example:
- appId: djApp
appName: Dow Jones
listed: true
install: false
- appId: selerity
appName: Selerity Context
listed: true
install: true
products:
- appId: selerity
name: Standard
subscribed: true
type: default
- appId: selerity
name: Premium
sku: AcDccU53SsY
subscribed: false
type: premium
'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.
post:
summary: Update the application entitlements for this 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:
- AppEntitlement
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UserAppEntitlementList'
example:
- appId: djApp
appName: Dow Jones
listed: true
install: false
- appId: selerity
appName: Selerity Context
listed: true
install: true
products:
- appId: selerity
name: Standard
subscribed: true
type: default
- appId: selerity
name: Premium
sku: AcDccU53SsY
subscribed: false
type: premium
'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/UserAppEntitlementList'
required: true
patch:
summary: Update unique entitlement of an app for this user. Entitlement can be installation, visibility or product
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:
- AppEntitlement
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UserAppEntitlementList'
example:
- appId: djApp
appName: Dow Jones
listed: true
install: false
- appId: selerity
appName: Selerity Context
listed: true
install: true
products:
- appId: selerity
name: Standard
subscribed: true
type: default
- appId: selerity
name: Premium
sku: AcDccU53SsY
subscribed: false
type: premium
'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/UserAppEntitlementsPatchList'
required: true
components:
schemas:
Error:
type: object
properties:
code:
type: integer
format: int32
example: 401
message:
type: string
example: Invalid session
ProductList:
type: array
items:
$ref: '#/components/schemas/Product'
example:
- appId: selerity
name: Standard
subscribed: true
type: default
- appId: selerity
name: Premium
sku: AcDccU53SsY
subscribed: false
type: premium
UserAppEntitlement:
description: Application Entitlements for the user
type: object
required:
- appId
- listed
- install
properties:
appId:
type: string
description: Unique ID for the Application
maxLength: 256
minLength: 1
example: selerity
appName:
type: string
description: Name for this Application
maxLength: 50
minLength: 1
example: Selerity Context
listed:
type: boolean
description: if true, this application will be listed in the appstore for this user. Otherwise, this application will be hidden in the appstore.
example: true
install:
type: boolean
description: if true, it indicate this application is installed for this user. Otherwise, this user does not have this application installed.
example: true
products:
$ref: '#/components/schemas/ProductList'
PodAppEntitlementList:
type: array
items:
$ref: '#/components/schemas/PodAppEntitlement'
example:
- appId: djApp
appName: Dow Jones
enable: true
listed: true
install: false
- appId: selerity
appName: Selerity Context
enable: false
listed: true
install: true
PodAppEntitlement:
description: Application Entitlements for the company
type: object
required:
- appId
- appName
- enable
- listed
- install
properties:
appId:
type: string
description: Unique ID for the Application
maxLength: 256
minLength: 1
example: djApp
appName:
type: string
description: Name for this Application
maxLength: 50
minLength: 1
example: Dow Jones
enable:
type: boolean
example: true
listed:
type: boolean
description: if true, this application will be listed in the appstore for everyone. Otherwise, this application will be hidden in the appstore.
example: true
install:
type: boolean
description: if true, the entitlement is set to automatic for the company. Otherwise, it is set to manual.
example: true
UserAppEntitlementList:
type: array
items:
$ref: '#/components/schemas/UserAppEntitlement'
example:
- appId: djApp
appName: Dow Jones
listed: true
install: false
- appId: selerity
appName: Selerity Context
listed: true
install: true
products:
- appId: selerity
name: Standard
subscribed: true
type: default
- appId: selerity
name: Premium
sku: AcDccU53SsY
subscribed: false
type: premium
UserAppEntitlementsPatchList:
description: Array of app entitlements to patch for a user
type: array
items:
$ref: '#/components/schemas/UserAppEntitlementPatch'
UserAppEntitlementPatch:
description: Application Entitlements to patch for the user
type: object
required:
- appId
properties:
appId:
type: string
description: Unique ID for the Application
maxLength: 256
minLength: 1
example: selerity
listed:
type: string
enum:
- 'TRUE'
- 'FALSE'
- KEEP
- REMOVE
default: KEEP
description: If "TRUE", this application will be listed in the appstore for this user. If "FALSE", this application will be hidden in the appstore. If "KEEP" or not set, the current value is kept. If "REMOVE", it will be removed from user settings and the pod level setting's value will be used.
example: KEEP
install:
type: string
enum:
- 'TRUE'
- 'FALSE'
- KEEP
- REMOVE
default: KEEP
description: If "TRUE", this application will be installed for this user. If "FALSE", this application will not be installed for this user. If "KEEP" or not set, the current value is kept. If "REMOVE", it will be removed from user settings and the pod level setting's value will be used.
example: true
product:
$ref: '#/components/schemas/Product'
Product:
description: Application Product
type: object
required:
- name
- type
- subscribed
properties:
appId:
type: string
description: App ID for the Product
maxLength: 256
minLength: 1
example: selerity
name:
type: string
minLength: 1
maxLength: 50
description: Product Name
example: Premium
sku:
type: string
minLength: 1
maxLength: 100
description: Product SKU
example: AcDccU53SsY
subscribed:
type: boolean
description: indicate whether the product is subscribed or not
example: false
type:
type: string
description: Product Type (default or premium)
example: premium