FINOS website screenshot

FINOS

The Fintech Open Source Foundation (FINOS) is a Linux Foundation project dedicated to open source innovation in the financial services industry. It fosters collaboration between banks, fintech companies, and technology firms on standards and projects spanning desktop interoperability (FDC3), financial product modeling (Common Domain Model), cloud compliance (Common Cloud Controls), business and technology modeling (Morphir), and messaging APIs (Symphony API Spec), among others.

5 APIs 0 Features
Financial ServicesFintechLinux FoundationOpen Source

APIs

FDC3

FDC3 is an open standard for financial desktop interoperability, defining how applications launch, share context, and resolve intents across the financial desktop. The standard ...

Common Domain Model

The Common Domain Model (CDM) is a standardized, machine-readable, and machine-executable model that represents financial products, trades in those products, and the lifecycle e...

Common Cloud Controls

FINOS Common Cloud Controls is an open standard project that describes consistent controls for compliant public cloud deployments in the financial services sector.

Morphir

Morphir is a universal language for business and technology that captures business logic in a portable, technology-agnostic intermediate representation that can be compiled to m...

Symphony API Spec

The Symphony API Spec project hosted at FINOS publishes the OpenAPI definitions for the Symphony platform, including the Pod API, Agent API, and Authenticator API used to send m...

Collections

Agent API

OPEN

Pod API

OPEN

Pricing Plans

Finos Plans Pricing

5 plans

PLANS

Rate Limits

Finos Rate Limits

3 limits

RATE LIMITS

FinOps

Finos Finops

FINOPS

Resources

🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
👥
GitHubOrg
GitHubOrg
🔗
Landscape
Landscape
🔗
Community
Community

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Pod API
  version: 20.17.1
items:
- info:
    name: Security
    type: folder
  items:
  - info:
      name: List all trusted certs
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/companycert/list'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: skip
        value: ''
        type: query
        description: Pagination start
      - name: limit
        value: ''
        type: query
        description: Row limit
    docs: List all trusted certs
  - info:
      name: Create a company trusted or untrusted certificate. Different from V1 in that we reject expired certificates.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v2/companycert/create'
      headers:
      - name: sessionToken
        value: ''
    docs: Create a company trusted or untrusted certificate. Different from V1 in that we reject expired certificates.
  - info:
      name: Delete a company certificate
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/companycert/delete'
      headers:
      - name: sessionToken
        value: ''
    docs: Delete a company certificate
  - info:
      name: Get the details of a company certificate
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/companycert/:fingerPrint/get'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: fingerPrint
        value: ''
        type: path
        description: Certificate fingerPrint (ID)
    docs: Get the details of a company certificate
  - info:
      name: Update a company certificate
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/companycert/:fingerPrint/update'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: fingerPrint
        value: ''
        type: path
        description: Certificate fingerPrint (ID)
    docs: Update a company certificate
  - info:
      name: 'Return a list of all certificates which were verified to the cert whose

        fingerprint is passed.

        '
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/companycert/:fingerPrint/issuedBy'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: fingerPrint
        value: ''
        type: path
        description: Certificate fingerPrint (ID)
    docs: 'Return a list of all certificates which were verified to the cert whose

      fingerprint is passed.

      '
  - info:
      name: List all trusted certs
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/companycert/podmanaged/list'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: skip
        value: ''
        type: query
        description: Pagination start
      - name: limit
        value: ''
        type: query
        description: Row limit
    docs: List all trusted certs
  - info:
      name: List all certs of the given types
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/companycert/type/list'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: skip
        value: ''
        type: query
        description: Pagination start
      - name: limit
        value: ''
        type: query
        description: Row limit
    docs: List all certs of the given types
- info:
    name: Pod
    type: folder
  items:
  - info:
      name: 'Retrieve the pod certificate that can be use to validate signed JWT tokens generated from the pod

        '
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/podcert'
    docs: 'Retrieve the pod certificate that can be use to validate signed JWT tokens generated from the pod

      '
  - info:
      name: Get supported attachment types for the pod
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/files/allowedTypes'
      headers:
      - name: sessionToken
        value: ''
    docs: Get supported attachment types for the pod
  - info:
      name: Lists available languages for the pod.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/languages'
    docs: Lists available languages for the pod.
- info:
    name: Connection
    type: folder
  items:
  - info:
      name: List of requesting user's connection
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/connection/list'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: status
        value: ''
        type: query
        description: 'Filter the connection list based on the connection status.

          The connection status can only be pending_incoming, pending_outgoing, accepted, rejected, or all (all of the above)

          '
      - name: userIds
        value: ''
        type: query
        description: 'The userIds parameter should be specified as a comma delimited list of user ids and can be used to restrict
          the results of a specific connection.

          Note that this is particularly important if the caller intends to retrieve results for implicit connection (user
          within the same pod).

          Implicit connections will not be included in the response if userId is not provided.

          '
    docs: 'This retrieves all connections of the requesting user. (i.e. both connections in which the requesting user is the
      sender and those

      in which the requesting user is the inivtee) By default, if you haven''t specified the connection status to filter on,
      this call will only

      return results for both "pending_incoming" and "pending_outgoing". You can optionally filter by userIds to further restrict
      the results of

      a specific connection status. If the users are in the same private pod, the users have an im'
  - info:
      name: Sends an invitation to connect with another user
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/connection/create'
      headers:
      - name: sessionToken
        value: ''
    docs: Sends an invitation to connect with another user
  - info:
      name: Accept the connection request for the requesting user
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/connection/accept'
      headers:
      - name: sessionToken
        value: ''
    docs: Accept the connection request for the requesting user
  - info:
      name: Reject the connection request for the requesting user.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/connection/reject'
      headers:
      - name: sessionToken
        value: ''
    docs: 'Reject the connection between the requesting user and request sender. If both users are in the same private pod,

      an error will be returned because both users have an implicit connection which cannot be rejected.

      '
  - info:
      name: The status of the connection invitation to another user.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/connection/user/:userId/info'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: userId
        value: ''
        type: path
        description: user Id
    docs: The status of the connection invitation to another user.
  - info:
      name: Removes a connection with a user.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/connection/user/:uid/remove'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: uid
        value: ''
        type: path
        description: 'User ID as a decimal integer

          '
    docs: Removes a connection with a user.
- info:
    name: Streams
    type: folder
  items:
  - info:
      name: Create a new single or multi party instant message conversation between the caller and specified users.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/im/create'
      headers:
      - name: sessionToken
        value: ''
    docs: 'At least one user ID must be provided or

      an error response will be sent.


      The caller is implicitly included in the members of the

      created chat.


      Duplicate users will be included in the membership of the chat but

      the duplication will be silently ignored.


      If there is an existing IM conversation with the same set of participants then

      the id of that existing stream will be returned.


      This method was incorrectly specified to take a query parameter in

      version 1.0 of this specification but now expects'
  - info:
      name: Update the attributes of an existing IM.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/im/:id/update'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: IM streamID
    docs: Update the attributes of an existing IM.
  - info:
      name: Get information about a partcular IM.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/im/:id/info'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: IM streamId
    docs: Get information about a partcular IM.
  - info:
      name: Create a new chatroom.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v3/room/create'
      headers:
      - name: sessionToken
        value: ''
    docs: 'Create a new chatroom.


      If no  attributes are specified, the room is created as a private chatroom.

      '
  - info:
      name: Search rooms according to the specified criteria.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v3/room/search'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: skip
        value: ''
        type: query
        description: 'No. of results to skip.

          '
      - name: limit
        value: ''
        type: query
        description: 'Max no. of results to return. If no value is provided, 50 is the default. Must be a positive

          integer and must not exceed 100

          '
      - name: includeNonDiscoverable
        value: ''
        type: query
        description: Whether the non discoverable rooms should be returned. false by default. Parameter introduced in sbe-25.5.0
    docs: Search rooms according to the specified criteria.
  - info:
      name: Get information about a partcular chatroom.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v3/room/:id/info'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
    docs: Get information about a partcular chatroom.
  - info:
      name: Deactivate or reactivate a chatroom. At creation, a new chatroom is active.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/room/:id/setActive'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
      - name: active
        value: ''
        type: query
    docs: Deactivate or reactivate a chatroom. At creation, a new chatroom is active.
  - info:
      name: Update the attributes of an existing chatroom.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v3/room/:id/update'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
    docs: Update the attributes of an existing chatroom.
  - info:
      name: 'Retrieve a list of all streams of which the requesting user is a member,

        sorted by creation date (ascending).

        '
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/streams/list'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: skip
        value: ''
        type: query
        description: 'No. of results to skip.

          '
      - name: limit
        value: ''
        type: query
        description: 'Max no. of results to return. If no value is provided, 50 is the default.

          '
    docs: 'Retrieve a list of all streams of which the requesting user is a member,

      sorted by creation date (ascending).

      '
  - info:
      name: 'Retrieve a list of all streams of which this user is a member,

        sorted by creation date (ascending). Since SBE 20.16.

        '
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/admin/user/:uid/streams/list'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: uid
        value: ''
        type: path
        description: 'User ID as a decimal integer

          '
      - name: skip
        value: ''
        type: query
        description: 'No. of results to skip.

          '
      - name: limit
        value: ''
        type: query
        description: 'Max no. of results to return. If no value is provided, 50 is the default.

          '
    docs: 'Retrieve a list of all streams of which this user is a member,

      sorted by creation date (ascending). Since SBE 20.16.

      '
  - info:
      name: Get information about a partcular stream.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/streams/:sid/info'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: sid
        value: ''
        type: path
        description: Stream Id
    docs: Get information about a partcular stream.
  - info:
      name: Get attachments in a particular stream.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/streams/:sid/attachments'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: sid
        value: ''
        type: path
        description: Stream Id
      - name: since
        value: ''
        type: query
        description: 'Timestamp of first required attachment.

          This is a long integer value representing milliseconds since Jan 1 1970

          '
      - name: to
        value: ''
        type: query
        description: 'Timestamp of last required attachment.

          This is a long integer value representing milliseconds since Jan 1 1970

          '
      - name: limit
        value: ''
        type: query
        description: Maximum number of attachments to return. Default is 50. Must be a positive integer and must not exceed
          100.
      - name: sortDir
        value: ''
        type: query
        description: 'Attachment date sort direction : ASC or DESC (default to ASC)

          '
    docs: Get attachments in a particular stream.
  - info:
      name: Create a new single or multi party instant message conversation
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/admin/im/create'
      headers:
      - name: sessionToken
        value: ''
    docs: 'At least two user IDs must be provided or

      an error response will be sent.


      The caller is not included in the members of the

      created chat.


      Duplicate users will be included in the membership of the chat but

      the duplication will be silently ignored.


      If there is an existing IM conversation with the same set of participants then

      the id of that existing stream will be returned.

      '
  - info:
      name: Deactivate or reactivate a chatroom via AC Portal.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/admin/room/:id/setActive'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
      - name: active
        value: ''
        type: query
    docs: Deactivate or reactivate a chatroom via AC Portal.
  - info:
      name: 'Retrieve all the streams across the enterprise where the membership of the stream has been modified between a
        given time range

        '
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v2/admin/streams/list'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: skip
        value: ''
        type: query
        description: 'Number of items to skip. Default is 0.

          '
      - name: limit
        value: ''
        type: query
        description: 'Maximum number of items to return. Default is 50.  This value cannot exceed 100.

          '
    docs: 'Retrieve all the streams across the enterprise where the membership of the stream has been modified between a given
      time range

      '
  - info:
      name: List the current members of an existing stream.  The stream can be of type IM, MIM, or ROOM
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/admin/stream/:id/membership/list'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: stream Id
      - name: skip
        value: ''
        type: query
        description: Number of items to skip. Default is 0.
      - name: limit
        value: ''
        type: query
        description: Maximum number of items to return. Default is 100 and not to exceed 1000.
    docs: List the current members of an existing stream.  The stream can be of type IM, MIM, or ROOM
- info:
    name: Presence
    type: folder
  items:
  - info:
      name: Create Presence status feed.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/presence/feed/create'
      headers:
      - name: sessionToken
        value: ''
    docs: 'Create a new stream capturing presence status changes ("presence feed").

      When read from, the feed will return the current presence status of company (pod) users

      if it has changed since the last read.


      Returns the ID of the presence feed to be used in subsequent read operations.

      '
  - info:
      name: Read a presence status feed.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/presence/feed/:feedId/read'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: feedId
        value: ''
        type: path
        description: Presence feed ID.
    docs: 'Returns the current presence status of company (pod) users

      if it has changed since the last read. Returns up to 500 records at a time.

      '
  - info:
      name: Delete a presence status feed.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/presence/feed/:feedId/delete'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: feedId
        value: ''
        type: path
        description: Presence feed ID.
    docs: 'Returns the ID of the deleted feed.

      '
  - info:
      name: Register interest in a user's presence status
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/user/presence/register'
      headers:
      - name: sessionToken
        value: ''
    docs: Register interest in a user's presence status
  - info:
      name: Get presence information about the requesting user.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/user/presence'
      headers:
      - name: sessionToken
        value: ''
    docs: Get presence information about the requesting user.
  - info:
      name: Set the presence of the requesting user.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v2/user/presence'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: soft
        value: ''
        type: query
        description: 'If true, the user''s current status is taken into consideration. If the user is currently OFFLINE,

          the user''s presence will still be OFFLINE, but the new presence will take effect when the

          user comes online. If the user is currently online, the user''s activity state will be

          applied to the presence if applicable. (e.g. if you are setting their presence to AVAILABLE,

          but the user is currently idle, their status will be represented as AWAY)

          '
    docs: Set the presence of the requesting user.
  - info:
      name: Get presence information about a particular user.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v3/user/:uid/presence'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: uid
        value: ''
        type: path
        description: 'User ID as a decimal integer

          '
      - name: local
        value: ''
        type: query
        description: 'If true, a local query will be performed and the presence will be

          set to OFFLINE for users who are not local to the calling user''s

          pod. If false or absent, then the presence of all local users and

          the presence of all external users to whom the calling user is

          connected will be queried.


          For external users, a "presence interest" should be registered through

          /v1/user/presence/register before querying for presence.

          '
    docs: Get presence information about a particular user.
  - info:
      name: Get presence information about all company (pod) users.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/users/presence'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: lastUserId
        value: ''
        type: query
        description: Last user ID retrieved. Used for paging; if provided, results will skip users with IDs less than this
          parameter.
      - name: limit
        value: ''
        type: query
        description: Max number of records to return. If no value is provided, 1000 is the default. The maximum supported
          value is 5000.
    docs: 'The returned data is taken from the in-memory cache for performance

      reasons which means inactive users may be omitted from the response.


      All non-inactive users WILL be returned and some inactive users MAY

      be included. Any omitted user IS inactive.


      Returned records are sorted by user ID, ascending.


      This method is expensive. It pulls ALL records from the cache, sorts them and then only uses a subset.

      For large numbers of users, this can be very inefficient both due to sorting

      and due to the cac'
  - info:
      name: Set presence information for a particular user.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v3/user/presence'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: soft
        value: ''
        type: query
        description: 'If true, the user''s current status is taken into consideration. If the user is currently OFFLINE,

          the user''s presence will still be OFFLINE, but the new presence will take effect when the

          user comes online. If the user is currently online, the user''s activity state will be

          applied to the presence if applicable. (e.g. if you are setting their presence to AVAILABLE,

          but the user is currently idle, their status will be represented as AWAY)

          '
    docs: Set presence information for a particular user.
- info:
    name: Room Membership
    type: folder
  items:
  - info:
      name: Adds new member to an existing room.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/room/:id/membership/add'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
    docs: Adds new member to an existing room.
  - info:
      name: Removes member from an existing room.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/room/:id/membership/remove'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
    docs: Removes member from an existing room.
  - info:
      name: Promotes user to owner.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/room/:id/membership/promoteOwner'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
    docs: Promotes user to owner.
  - info:
      name: Demotes room owner.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/room/:id/membership/demoteOwner'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
    docs: Demotes room owner.
  - info:
      name: Lists current members of an existing room.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/room/:id/membership/list'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
    docs: Lists current members of an existing room.
  - info:
      name: Lists current and previous members of an existing room.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/admin/room/:id/membership/list'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
      - name: includePastMembers
        value: ''
        type: query
        description: If true, the membership list will include past members of the stream. If false, the listing will only
          incude current members. Default false.
    docs: Lists current and previous members of an existing room.
  - info:
      name: Add a member to an existing room.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/admin/room/:id/membership/add'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
    docs: Add a member to an existing room.
  - info:
      name: Remove a member from a room.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/admin/room/:id/membership/remove'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Room streamId
    docs: Remove a member from a room.
- info:
    name: Session
    type: folder
  items:
  - info:
      name: Get information about the current user's session.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/sessioninfo'
      headers:
      - name: sessionToken
        value: ''
    docs: Get information about the current user's session.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Get user information
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v2/user'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: uid
        value: ''
        type: query
        description: User ID as a decimal integer
      - name: email
        value: ''
        type: query
        description: Email address
      - name: username
        value: ''
        type: query
        description: login user name
      - name: local
        value: ''
        type: query
        description: 'If true then a local DB search will be performed and only local pod users will be

          returned. If absent or false then a directory search will be performed and users

          from other pods who are visible to the calling user will also be returned.

          Note: for username search, the local flag must be true

          '
    docs: Get user information
  - info:
      name: 'Search users by emails or ids.

        Only one of the search lists should be informed at a time.

        Search lists may containt up to 100 elements.

        '
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v3/users'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: uid
        value: ''
        type: query
        description: User IDs as a list of decimal integers separated by comma
      - name: email
        value: ''
        type: query
        description: List of email addresses separated by comma
      - name: username
        value: ''
        type: query
        description: List of username separated by comma
      - name: local
        value: ''
        type: query
        description: 'If true then a local DB search will be performed and only local pod users will be

          returned. If absent or false then a directory search will be performed and users

          from other pods who are visible to the calling user will also be returned.

          '
      - name: active
        value: ''
        type: query
        description: 'If not set all user status will be returned,

          if true all active users will be returned,

          if false all inactive users will be returned

          '
    docs: 'Search users by emails or ids.

      Only one of the search lists should be informed at a time.

      Search lists may containt up to 100 elements.

      '
  - info:
      name: 'Ends the session identified by {sid} for the user with the identifier {uid}.

        '
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/users/:uid/sessions/:sid/logout'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: uid
        value: ''
        type: path
        description: The identifier of the user who owns the session to be terminated.
      - name: sid
        value: ''
        type: path
        description: The identifier of the session to be terminated.
    docs: 'Ends the session identified by {sid} for the user with the identifier {uid}.

      '
  - info:
      name: 'Ends all sessions for the user identified by {uid}.

        '
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/users/:uid/sessions/logout'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: uid
        value: ''
        type: path
        description: The identifier of the user whose sessions are to be terminated.
    docs: 'Ends all sessions for the user identified by {uid}.

      '
  - info:
      name: 'Lists all sessions for the user identified by {uid}.

        '
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/users/:uid/sessions'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: uid
        value: ''
        type: path
        description: The identifier of the user whose sessions are to be listed.
    docs: 'Lists all sessions for the user identified by {uid}.

      '
  - info:
      name: Search for users by name or email address
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/user/search'
      headers:
      - name: sessionToken
        value: ''
      params:
      - name: skip
        value: ''
        type: query
        description: number of records to skip
      - name: limit
        value: ''
        type: query
        description: Max number of records to return. If no value is provided, 50 is the default.
      - name: local
        value: ''
        type: query
        description: 'If true then a local DB search will be performed and only local pod users will be

          returned. If absent or false then a directory search will be performed and users

          from other pods who are visible to the calling user will also be returned.

          '
    docs: Search for users by name or email address
- info:
    name: AppEntitlement
    type: folder
  items:
  - info:
      name: Get the list of application entitlements for the company
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/admin/app/entitlement/list'
      headers:
      - name: sessionToken
        value: ''
    docs: Get the list of application entitlements for the company
  - info:
      name: Update the application entitlements for the company
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/admin/app/entitlement/list'
      headers:
      - name: sessionToken
        value: ''
    docs: Update the application entitlements for the company
  - info:
      name: Get the list of application entitlem

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finos/refs/heads/main/apis.yml