naftiko: 1.0.0-alpha2 info: label: Agent API description: This document refers to Symphony API calls to send and receive messages and content. They need the on-premise Agent installed to perform decryption/encryption of content. - sessionToken and keyManagerToken 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 sent no message to any stream even if a request to some subset of the requeste tags: - Finos - API created: '2026-05-06' modified: '2026-05-06' capability: consumes: - type: http namespace: finos baseUri: youragentURL.symphony.com/agent description: Agent API HTTP API. resources: - name: v3-health path: /v3/health operations: - name: v3health method: GET description: Checks health status outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-health-extended path: /v3/health/extended operations: - name: v3extendedhealth method: GET description: Checks health status of services and users outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v4-message-import path: /v4/message/import operations: - name: post-v4-message-import method: POST description: Import messages from other systems into Symphony. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v4-message-blast path: /v4/message/blast operations: - name: post-v4-message-blast method: POST description: Post a message to multiple existing streams. inputParameters: - name: sessionToken in: header type: string required: true description: Authorization token used to make delegated calls. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-message-id path: /v1/message/{id} operations: - name: get-v1-message-id method: GET description: Get a message by ID inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: id in: path type: string required: true description: Message ID as a URL-safe string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-message-search path: /v1/message/search operations: - name: get-v1-message-search method: GET description: Search messages inputParameters: - name: query in: query type: string required: true description: The search query. See above for the query syntax. - name: skip in: query type: integer description: No. of results to skip. - name: limit in: query type: integer description: Max no. of results to return. If no value is provided, 50 is the default. - name: scope in: query type: string description: Describes where content should be searched for that query. It can exclusively apply to Symphony content or to one Connector. - name: sortDir in: query type: string description: 'Messages sort direction : ASC or DESC (default to DESC)' - name: tier in: query type: string description: 'Target search tier : hot, warm or all (default to hot)' - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: post-v1-message-search method: POST description: Search messages inputParameters: - name: skip in: query type: integer description: No. of results to skip. - name: limit in: query type: integer description: Max no. of results to return. If no value is provided, 50 is the default. - name: scope in: query type: string description: Describes where content should be searched for that query. It can exclusively apply to Symphony content or to one Connector. - name: sortDir in: query type: string description: 'Messages sort direction : ASC or DESC (default to DESC)' - name: tier in: query type: string description: 'Target search tier : hot, warm or all (default to hot)' - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-stream-sid-attachment path: /v1/stream/{sid}/attachment operations: - name: get-v1-stream-sid-attachment method: GET description: Download an attachment. inputParameters: - name: sid in: path type: string required: true description: Stream ID - name: fileId in: query type: string required: true description: The attachment ID (Base64-encoded) - name: messageId in: query type: string required: true description: The ID of the message containing the attachment - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v4-stream-sid-message path: /v4/stream/{sid}/message operations: - name: get-v4-stream-sid-message method: GET description: Get messages from an existing stream. inputParameters: - name: sid in: path type: string required: true description: Stream ID - name: since in: query type: integer required: true description: Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 - name: until in: query type: integer description: Timestamp of last required message. This is a long integer value representing milliseconds since Jan 1 1970 - name: skip in: query type: integer description: No. of messages to skip. - name: limit in: query type: integer description: Max No. of messages to return. If no value is provided, 50 is the default. The maximum supported value is 500. - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v4-stream-sid-message-create path: /v4/stream/{sid}/message/create operations: - name: post-v4-stream-sid-message-create method: POST description: Post a message to one existing stream. inputParameters: - name: sid in: path type: string required: true description: Stream ID - name: sessionToken in: header type: string required: true description: Authorization token used to make delegated calls. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v4-stream-sid-message-mid-update path: /v4/stream/{sid}/message/{mid}/update operations: - name: post-v4-stream-sid-message-mid-update method: POST description: Update an existing message. inputParameters: - name: sid in: path type: string required: true description: Stream ID - name: mid in: path type: string required: true description: ID of the message to be updated - name: sessionToken in: header type: string required: true description: Authorization token used to make delegated calls. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-stream-sid-share path: /v3/stream/{sid}/share operations: - name: post-v3-stream-sid-share method: POST description: PROVISIONAL - Share a piece of content into Symphony inputParameters: - name: sid in: path type: string required: true description: Stream ID - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-util-echo path: /v1/util/echo operations: - name: post-v1-util-echo method: POST description: Test endpoint, returns input. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-signals-list path: /v1/signals/list operations: - name: get-v1-signals-list method: GET description: List signals for the requesting user. This includes signals that the user has created and public signals to which they subscribed. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: skip in: query type: integer description: No. of signals to skip. - name: limit in: query type: integer description: Max no. of signals to return. If no value is provided, 50 is the default. The maximum supported value is 500. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-signals-id-get path: /v1/signals/{id}/get operations: - name: get-v1-signals-id-get method: GET description: Get details of the requested signal. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: id in: path type: string required: true description: The ID of the signal to display. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-signals-create path: /v1/signals/create operations: - name: post-v1-signals-create method: POST description: Create a signal. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-signals-id-update path: /v1/signals/{id}/update operations: - name: post-v1-signals-id-update method: POST description: Update a signal. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: id in: path type: string required: true description: The id of the signal. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-signals-id-delete path: /v1/signals/{id}/delete operations: - name: post-v1-signals-id-delete method: POST description: Delete a signal. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: id in: path type: string required: true description: The id of the signal. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-signals-id-subscribe path: /v1/signals/{id}/subscribe operations: - name: post-v1-signals-id-subscribe method: POST description: Subscribe to a Signal. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: id in: path type: string required: true description: The id of the signal. - name: pushed in: query type: boolean description: Prevent the user to unsubscribe (only for bulk subscription) outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-signals-id-unsubscribe path: /v1/signals/{id}/unsubscribe operations: - name: post-v1-signals-id-unsubscribe method: POST description: Unsubscribe to a Signal. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: id in: path type: string required: true description: The id of the signal. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-signals-id-subscribers path: /v1/signals/{id}/subscribers operations: - name: get-v1-signals-id-subscribers method: GET description: Get the subscribers of a signal inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: id in: path type: string required: true description: The id of the signal. - name: skip in: query type: integer description: No. of results to skip. - name: limit in: query type: integer description: Max No. of subscribers to return. If no value is provided, 100 is the default. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-info path: /v1/info operations: - name: get-v1-info method: GET description: Get information about the Agent outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-policies path: /v1/dlp/policies operations: - name: get-v1-dlp-policies method: GET description: Get all policies inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: page in: query type: integer description: Optional parameter to specify which page to return (default is 0) - name: limit in: query type: integer description: Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: post-v1-dlp-policies method: POST description: Creates a policy inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-policies-policyid path: /v1/dlp/policies/{policyId} operations: - name: get-v1-dlp-policies-policyid method: GET description: Get a policy inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: policyId in: path type: string required: true description: Unique dictionary identifier. - name: policyVersion in: query type: string description: Optional parameter, if set to be valid policy version number, will return policy with specified policyVersion. Otherwise, return the latest policy. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: put-v1-dlp-policies-policyid method: PUT description: Updates a policy. Cannot be used for creation. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: policyId in: path type: string required: true description: Unique dictionary identifier. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: delete-v1-dlp-policies-policyid method: DELETE description: Delete a policy inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: policyId in: path type: string required: true description: Unique dictionary identifier. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-policies-policyid-enable path: /v1/dlp/policies/{policyId}/enable operations: - name: post-v1-dlp-policies-policyid-enable method: POST description: Enables a policy. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: policyId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-policies-policyid-disable path: /v1/dlp/policies/{policyId}/disable operations: - name: post-v1-dlp-policies-policyid-disable method: POST description: Disables a policy. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: policyId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-dictionaries path: /v1/dlp/dictionaries operations: - name: get-v1-dlp-dictionaries method: GET description: Get all dictionary metadatas inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: page in: query type: integer description: Optional parameter to specify which page to return (default is 0) - name: limit in: query type: integer description: Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: post-v1-dlp-dictionaries method: POST description: Create a dictionary inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-dictionaries-dictid path: /v1/dlp/dictionaries/{dictId} operations: - name: get-v1-dlp-dictionaries-dictid method: GET description: Get dictionary metadata inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: dictId in: path type: string required: true description: Unique dictionary identifier - name: dictVersion in: query type: string description: If set to be valid dictionary version number, will return dictionary metadata with specified version. Otherwise, return the latest dictionary metadata. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: put-v1-dlp-dictionaries-dictid method: PUT description: Updates a dictionary inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: dictId in: path type: string required: true description: Unique dictionary identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: delete-v1-dlp-dictionaries-dictid method: DELETE description: Delete a dictionary inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: dictId in: path type: string required: true description: Unique dictionary identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-dictionaries-dictid-data-download path: /v1/dlp/dictionaries/{dictId}/data/download operations: - name: get-v1-dlp-dictionaries-dictid-data-download method: GET description: Downloads Base 64 encoded dictionary content. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: dictId in: path type: string required: true description: Unique dictionary identifier - name: dictVersion in: query type: string description: If set to be valid dictionary version number, will return dictionary with specified version. Otherwise, return the latest dictionary. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-dictionaries-dictid-data-upload path: /v1/dlp/dictionaries/{dictId}/data/upload operations: - name: post-v1-dlp-dictionaries-dictid-data-upload method: POST description: Override dictionary content with provided content. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: dictId in: path type: string required: true description: Unique dictionary identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-violations-message path: /v1/dlp/violations/message operations: - name: get-v1-dlp-violations-message method: GET description: Get violations as a result of policy enforcement on messages. inputParameters: - name: startTime in: query type: integer required: true description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 - name: endTime in: query type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next in: query type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit in: query type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-violations-stream path: /v1/dlp/violations/stream operations: - name: get-v1-dlp-violations-stream method: GET description: Get violations as a result of policy enforcement on streams. inputParameters: - name: startTime in: query type: integer required: true description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 - name: endTime in: query type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next in: query type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit in: query type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-dlp-violations-signal path: /v1/dlp/violations/signal operations: - name: get-v1-dlp-violations-signal method: GET description: Get violations as a result of policy enforcement on signals. inputParameters: - name: startTime in: query type: integer required: true description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 - name: endTime in: query type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next in: query type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit in: query type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-dlp-policies path: /v3/dlp/policies operations: - name: get-v3-dlp-policies method: GET description: Get all policies inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: page in: query type: integer description: Optional parameter to specify which page to return (default is 0) - name: limit in: query type: integer description: Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: post-v3-dlp-policies method: POST description: Creates a policy inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-dlp-policies-policyid path: /v3/dlp/policies/{policyId} operations: - name: get-v3-dlp-policies-policyid method: GET description: Get a policy inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: policyId in: path type: string required: true description: Unique dictionary identifier. - name: policyVersion in: query type: string description: Optional parameter, if set to be valid policy version number, will return policy with specified policyVersion. Otherwise, return the latest policy. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-dlp-policies-policyid-update path: /v3/dlp/policies/{policyId}/update operations: - name: post-v3-dlp-policies-policyid-update method: POST description: Updates a policy. Cannot be used for creation. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: policyId in: path type: string required: true description: Unique dictionary identifier. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-dlp-policies-policyid-delete path: /v3/dlp/policies/{policyId}/delete operations: - name: post-v3-dlp-policies-policyid-delete method: POST description: Delete a policy inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: policyId in: path type: string required: true description: Unique dictionary identifier. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-dlp-policies-policyid-enable path: /v3/dlp/policies/{policyId}/enable operations: - name: post-v3-dlp-policies-policyid-enable method: POST description: Enables a policy. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: policyId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-dlp-policies-policyid-disable path: /v3/dlp/policies/{policyId}/disable operations: - name: post-v3-dlp-policies-policyid-disable method: POST description: Disables a policy. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: policyId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-dlp-violations-message path: /v3/dlp/violations/message operations: - name: get-v3-dlp-violations-message method: GET description: Get violations as a result of policy enforcement on messages. inputParameters: - name: startTime in: query type: integer required: true description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 - name: endTime in: query type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next in: query type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit in: query type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-dlp-violations-stream path: /v3/dlp/violations/stream operations: - name: get-v3-dlp-violations-stream method: GET description: Get violations as a result of policy enforcement on streams. inputParameters: - name: startTime in: query type: integer required: true description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 - name: endTime in: query type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next in: query type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit in: query type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-dlp-violations-signal path: /v3/dlp/violations/signal operations: - name: get-v3-dlp-violations-signal method: GET description: Get violations as a result of policy enforcement on signals. inputParameters: - name: startTime in: query type: integer required: true description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 - name: endTime in: query type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next in: query type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit in: query type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-dlp-violation-attachment path: /v3/dlp/violation/attachment operations: - name: get-v3-dlp-violation-attachment method: GET description: Get attachments that were sent as part of messages that were flagged by the DLP System. inputParameters: - name: fileId in: query type: string required: true description: ID of attachment that will be downloaded. - name: violationId in: query type: string required: true description: ID of violation that corresponds to the flagged message that contains the attachment - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-audittrail-privilegeduser path: /v1/audittrail/privilegeduser operations: - name: get-v1-audittrail-privilegeduser method: GET description: Get a list of actions performed by a privileged account acting as privileged user given a period of time. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: startTimestamp in: query type: integer required: true description: Start timestamp in unix timestamp in millseconds. - name: endTimestamp in: query type: integer description: End timestamp in unix timestamp in millseconds. If not specified, it assumes to be current time. - name: before in: query type: string description: Return results from an opaque “before” cursor value as presented via a response cursor. - name: after in: query type: string description: Return results from an opaque “after” cursor value as presented via a response cursor. - name: limit in: query type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. Some maximums for limit may be enforced for performance reasons. The maximum suppor - name: initiatorId in: query type: integer description: If present, only the initiator with this initiator will be returned. - name: role in: query type: string description: 'If present, only the audit trail initiated by s user with privileged role acting as privileged user will be returned. Privileged eliglible roles: User Provision' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v5-datafeeds path: /v5/datafeeds operations: - name: listdatafeed method: GET description: Returns the list of active datafeeds of the user. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. - name: tag in: query type: string description: A unique identifier to ensure uniqueness of the datafeed. Used to restrict search. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createdatafeed method: POST description: Create a new real time feed of messages and events. inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v5-datafeeds-datafeedid path: /v5/datafeeds/{datafeedId} operations: - name: deletedatafeed method: DELETE description: Delete the specified real time message / event stream ("datafeed"). inputParameters: - name: datafeedId in: path type: string required: true description: ID of the datafeed - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v5-datafeeds-datafeedid-read path: /v5/datafeeds/{datafeedId}/read operations: - name: readdatafeed method: POST description: Read the specified real time message / event stream ("datafeed"). inputParameters: - name: datafeedId in: path type: string required: true description: ID of the datafeed - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v5-events-read path: /v5/events/read operations: - name: readevents method: POST description: Creates and Reads a real time feed of messages and events of your pod (Datahose) inputParameters: - name: sessionToken in: header type: string required: true description: Session authentication token. - name: keyManagerToken in: header type: string description: Key Manager authentication token. outputRawFormat: json outputParameters: - name: result type: object value: $. exposes: - type: rest port: 8080 namespace: finos-rest description: REST adapter for Agent API. resources: - path: /v3/health name: v3health operations: - method: GET name: v3health description: Checks health status call: finos.v3health outputParameters: - type: object mapping: $. - path: /v3/health/extended name: v3extendedhealth operations: - method: GET name: v3extendedhealth description: Checks health status of services and users call: finos.v3extendedhealth outputParameters: - type: object mapping: $. - path: /v4/message/import name: post-v4-message-import operations: - method: POST name: post-v4-message-import description: Import messages from other systems into Symphony. call: finos.post-v4-message-import outputParameters: - type: object mapping: $. - path: /v4/message/blast name: post-v4-message-blast operations: - method: POST name: post-v4-message-blast description: Post a message to multiple existing streams. call: finos.post-v4-message-blast outputParameters: - type: object mapping: $. - path: /v1/message/{id} name: get-v1-message-id operations: - method: GET name: get-v1-message-id description: Get a message by ID call: finos.get-v1-message-id with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/message/search name: get-v1-message-search operations: - method: GET name: get-v1-message-search description: Search messages call: finos.get-v1-message-search outputParameters: - type: object mapping: $. - path: /v1/message/search name: post-v1-message-search operations: - method: POST name: post-v1-message-search description: Search messages call: finos.post-v1-message-search outputParameters: - type: object mapping: $. - path: /v1/stream/{sid}/attachment name: get-v1-stream-sid-attachment operations: - method: GET name: get-v1-stream-sid-attachment description: Download an attachment. call: finos.get-v1-stream-sid-attachment with: sid: rest.sid outputParameters: - type: object mapping: $. - path: /v4/stream/{sid}/message name: get-v4-stream-sid-message operations: - method: GET name: get-v4-stream-sid-message description: Get messages from an existing stream. call: finos.get-v4-stream-sid-message with: sid: rest.sid outputParameters: - type: object mapping: $. - path: /v4/stream/{sid}/message/create name: post-v4-stream-sid-message-create operations: - method: POST name: post-v4-stream-sid-message-create description: Post a message to one existing stream. call: finos.post-v4-stream-sid-message-create with: sid: rest.sid outputParameters: - type: object mapping: $. - path: /v4/stream/{sid}/message/{mid}/update name: post-v4-stream-sid-message-mid-update operations: - method: POST name: post-v4-stream-sid-message-mid-update description: Update an existing message. call: finos.post-v4-stream-sid-message-mid-update with: sid: rest.sid mid: rest.mid outputParameters: - type: object mapping: $. - path: /v3/stream/{sid}/share name: post-v3-stream-sid-share operations: - method: POST name: post-v3-stream-sid-share description: PROVISIONAL - Share a piece of content into Symphony call: finos.post-v3-stream-sid-share with: sid: rest.sid outputParameters: - type: object mapping: $. - path: /v1/util/echo name: post-v1-util-echo operations: - method: POST name: post-v1-util-echo description: Test endpoint, returns input. call: finos.post-v1-util-echo outputParameters: - type: object mapping: $. - path: /v1/signals/list name: get-v1-signals-list operations: - method: GET name: get-v1-signals-list description: List signals for the requesting user. This includes signals that the user has created and public signals to which they subscribed. call: finos.get-v1-signals-list outputParameters: - type: object mapping: $. - path: /v1/signals/{id}/get name: get-v1-signals-id-get operations: - method: GET name: get-v1-signals-id-get description: Get details of the requested signal. call: finos.get-v1-signals-id-get with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/signals/create name: post-v1-signals-create operations: - method: POST name: post-v1-signals-create description: Create a signal. call: finos.post-v1-signals-create outputParameters: - type: object mapping: $. - path: /v1/signals/{id}/update name: post-v1-signals-id-update operations: - method: POST name: post-v1-signals-id-update description: Update a signal. call: finos.post-v1-signals-id-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/signals/{id}/delete name: post-v1-signals-id-delete operations: - method: POST name: post-v1-signals-id-delete description: Delete a signal. call: finos.post-v1-signals-id-delete with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/signals/{id}/subscribe name: post-v1-signals-id-subscribe operations: - method: POST name: post-v1-signals-id-subscribe description: Subscribe to a Signal. call: finos.post-v1-signals-id-subscribe with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/signals/{id}/unsubscribe name: post-v1-signals-id-unsubscribe operations: - method: POST name: post-v1-signals-id-unsubscribe description: Unsubscribe to a Signal. call: finos.post-v1-signals-id-unsubscribe with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/signals/{id}/subscribers name: get-v1-signals-id-subscribers operations: - method: GET name: get-v1-signals-id-subscribers description: Get the subscribers of a signal call: finos.get-v1-signals-id-subscribers with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/info name: get-v1-info operations: - method: GET name: get-v1-info description: Get information about the Agent call: finos.get-v1-info outputParameters: - type: object mapping: $. - path: /v1/dlp/policies name: get-v1-dlp-policies operations: - method: GET name: get-v1-dlp-policies description: Get all policies call: finos.get-v1-dlp-policies outputParameters: - type: object mapping: $. - path: /v1/dlp/policies name: post-v1-dlp-policies operations: - method: POST name: post-v1-dlp-policies description: Creates a policy call: finos.post-v1-dlp-policies outputParameters: - type: object mapping: $. - path: /v1/dlp/policies/{policyId} name: get-v1-dlp-policies-policyid operations: - method: GET name: get-v1-dlp-policies-policyid description: Get a policy call: finos.get-v1-dlp-policies-policyid with: policyId: rest.policyId outputParameters: - type: object mapping: $. - path: /v1/dlp/policies/{policyId} name: put-v1-dlp-policies-policyid operations: - method: PUT name: put-v1-dlp-policies-policyid description: Updates a policy. Cannot be used for creation. call: finos.put-v1-dlp-policies-policyid with: policyId: rest.policyId outputParameters: - type: object mapping: $. - path: /v1/dlp/policies/{policyId} name: delete-v1-dlp-policies-policyid operations: - method: DELETE name: delete-v1-dlp-policies-policyid description: Delete a policy call: finos.delete-v1-dlp-policies-policyid with: policyId: rest.policyId outputParameters: - type: object mapping: $. - path: /v1/dlp/policies/{policyId}/enable name: post-v1-dlp-policies-policyid-enable operations: - method: POST name: post-v1-dlp-policies-policyid-enable description: Enables a policy. call: finos.post-v1-dlp-policies-policyid-enable with: policyId: rest.policyId outputParameters: - type: object mapping: $. - path: /v1/dlp/policies/{policyId}/disable name: post-v1-dlp-policies-policyid-disable operations: - method: POST name: post-v1-dlp-policies-policyid-disable description: Disables a policy. call: finos.post-v1-dlp-policies-policyid-disable with: policyId: rest.policyId outputParameters: - type: object mapping: $. - path: /v1/dlp/dictionaries name: get-v1-dlp-dictionaries operations: - method: GET name: get-v1-dlp-dictionaries description: Get all dictionary metadatas call: finos.get-v1-dlp-dictionaries outputParameters: - type: object mapping: $. - path: /v1/dlp/dictionaries name: post-v1-dlp-dictionaries operations: - method: POST name: post-v1-dlp-dictionaries description: Create a dictionary call: finos.post-v1-dlp-dictionaries outputParameters: - type: object mapping: $. - path: /v1/dlp/dictionaries/{dictId} name: get-v1-dlp-dictionaries-dictid operations: - method: GET name: get-v1-dlp-dictionaries-dictid description: Get dictionary metadata call: finos.get-v1-dlp-dictionaries-dictid with: dictId: rest.dictId outputParameters: - type: object mapping: $. - path: /v1/dlp/dictionaries/{dictId} name: put-v1-dlp-dictionaries-dictid operations: - method: PUT name: put-v1-dlp-dictionaries-dictid description: Updates a dictionary call: finos.put-v1-dlp-dictionaries-dictid with: dictId: rest.dictId outputParameters: - type: object mapping: $. - path: /v1/dlp/dictionaries/{dictId} name: delete-v1-dlp-dictionaries-dictid operations: - method: DELETE name: delete-v1-dlp-dictionaries-dictid description: Delete a dictionary call: finos.delete-v1-dlp-dictionaries-dictid with: dictId: rest.dictId outputParameters: - type: object mapping: $. - path: /v1/dlp/dictionaries/{dictId}/data/download name: get-v1-dlp-dictionaries-dictid-data-download operations: - method: GET name: get-v1-dlp-dictionaries-dictid-data-download description: Downloads Base 64 encoded dictionary content. call: finos.get-v1-dlp-dictionaries-dictid-data-download with: dictId: rest.dictId outputParameters: - type: object mapping: $. - path: /v1/dlp/dictionaries/{dictId}/data/upload name: post-v1-dlp-dictionaries-dictid-data-upload operations: - method: POST name: post-v1-dlp-dictionaries-dictid-data-upload description: Override dictionary content with provided content. call: finos.post-v1-dlp-dictionaries-dictid-data-upload with: dictId: rest.dictId outputParameters: - type: object mapping: $. - path: /v1/dlp/violations/message name: get-v1-dlp-violations-message operations: - method: GET name: get-v1-dlp-violations-message description: Get violations as a result of policy enforcement on messages. call: finos.get-v1-dlp-violations-message outputParameters: - type: object mapping: $. - path: /v1/dlp/violations/stream name: get-v1-dlp-violations-stream operations: - method: GET name: get-v1-dlp-violations-stream description: Get violations as a result of policy enforcement on streams. call: finos.get-v1-dlp-violations-stream outputParameters: - type: object mapping: $. - path: /v1/dlp/violations/signal name: get-v1-dlp-violations-signal operations: - method: GET name: get-v1-dlp-violations-signal description: Get violations as a result of policy enforcement on signals. call: finos.get-v1-dlp-violations-signal outputParameters: - type: object mapping: $. - path: /v3/dlp/policies name: get-v3-dlp-policies operations: - method: GET name: get-v3-dlp-policies description: Get all policies call: finos.get-v3-dlp-policies outputParameters: - type: object mapping: $. - path: /v3/dlp/policies name: post-v3-dlp-policies operations: - method: POST name: post-v3-dlp-policies description: Creates a policy call: finos.post-v3-dlp-policies outputParameters: - type: object mapping: $. - path: /v3/dlp/policies/{policyId} name: get-v3-dlp-policies-policyid operations: - method: GET name: get-v3-dlp-policies-policyid description: Get a policy call: finos.get-v3-dlp-policies-policyid with: policyId: rest.policyId outputParameters: - type: object mapping: $. - path: /v3/dlp/policies/{policyId}/update name: post-v3-dlp-policies-policyid-update operations: - method: POST name: post-v3-dlp-policies-policyid-update description: Updates a policy. Cannot be used for creation. call: finos.post-v3-dlp-policies-policyid-update with: policyId: rest.policyId outputParameters: - type: object mapping: $. - path: /v3/dlp/policies/{policyId}/delete name: post-v3-dlp-policies-policyid-delete operations: - method: POST name: post-v3-dlp-policies-policyid-delete description: Delete a policy call: finos.post-v3-dlp-policies-policyid-delete with: policyId: rest.policyId outputParameters: - type: object mapping: $. - path: /v3/dlp/policies/{policyId}/enable name: post-v3-dlp-policies-policyid-enable operations: - method: POST name: post-v3-dlp-policies-policyid-enable description: Enables a policy. call: finos.post-v3-dlp-policies-policyid-enable with: policyId: rest.policyId outputParameters: - type: object mapping: $. - path: /v3/dlp/policies/{policyId}/disable name: post-v3-dlp-policies-policyid-disable operations: - method: POST name: post-v3-dlp-policies-policyid-disable description: Disables a policy. call: finos.post-v3-dlp-policies-policyid-disable with: policyId: rest.policyId outputParameters: - type: object mapping: $. - path: /v3/dlp/violations/message name: get-v3-dlp-violations-message operations: - method: GET name: get-v3-dlp-violations-message description: Get violations as a result of policy enforcement on messages. call: finos.get-v3-dlp-violations-message outputParameters: - type: object mapping: $. - path: /v3/dlp/violations/stream name: get-v3-dlp-violations-stream operations: - method: GET name: get-v3-dlp-violations-stream description: Get violations as a result of policy enforcement on streams. call: finos.get-v3-dlp-violations-stream outputParameters: - type: object mapping: $. - path: /v3/dlp/violations/signal name: get-v3-dlp-violations-signal operations: - method: GET name: get-v3-dlp-violations-signal description: Get violations as a result of policy enforcement on signals. call: finos.get-v3-dlp-violations-signal outputParameters: - type: object mapping: $. - path: /v3/dlp/violation/attachment name: get-v3-dlp-violation-attachment operations: - method: GET name: get-v3-dlp-violation-attachment description: Get attachments that were sent as part of messages that were flagged by the DLP System. call: finos.get-v3-dlp-violation-attachment outputParameters: - type: object mapping: $. - path: /v1/audittrail/privilegeduser name: get-v1-audittrail-privilegeduser operations: - method: GET name: get-v1-audittrail-privilegeduser description: Get a list of actions performed by a privileged account acting as privileged user given a period of time. call: finos.get-v1-audittrail-privilegeduser outputParameters: - type: object mapping: $. - path: /v5/datafeeds name: listdatafeed operations: - method: GET name: listdatafeed description: Returns the list of active datafeeds of the user. call: finos.listdatafeed outputParameters: - type: object mapping: $. - path: /v5/datafeeds name: createdatafeed operations: - method: POST name: createdatafeed description: Create a new real time feed of messages and events. call: finos.createdatafeed outputParameters: - type: object mapping: $. - path: /v5/datafeeds/{datafeedId} name: deletedatafeed operations: - method: DELETE name: deletedatafeed description: Delete the specified real time message / event stream ("datafeed"). call: finos.deletedatafeed with: datafeedId: rest.datafeedId outputParameters: - type: object mapping: $. - path: /v5/datafeeds/{datafeedId}/read name: readdatafeed operations: - method: POST name: readdatafeed description: Read the specified real time message / event stream ("datafeed"). call: finos.readdatafeed with: datafeedId: rest.datafeedId outputParameters: - type: object mapping: $. - path: /v5/events/read name: readevents operations: - method: POST name: readevents description: Creates and Reads a real time feed of messages and events of your pod (Datahose) call: finos.readevents outputParameters: - type: object mapping: $. - type: mcp port: 9090 namespace: finos-mcp transport: http description: MCP adapter for Agent API for AI agent use. tools: - name: v3health description: Checks health status hints: readOnly: true destructive: false idempotent: true call: finos.v3health outputParameters: - type: object mapping: $. - name: v3extendedhealth description: Checks health status of services and users hints: readOnly: true destructive: false idempotent: true call: finos.v3extendedhealth outputParameters: - type: object mapping: $. - name: post-v4-message-import description: Import messages from other systems into Symphony. hints: readOnly: false destructive: false idempotent: false call: finos.post-v4-message-import outputParameters: - type: object mapping: $. - name: post-v4-message-blast description: Post a message to multiple existing streams. hints: readOnly: false destructive: false idempotent: false call: finos.post-v4-message-blast outputParameters: - type: object mapping: $. - name: get-v1-message-id description: Get a message by ID hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-message-id with: id: tools.id inputParameters: - name: id type: string description: Message ID as a URL-safe string required: true outputParameters: - type: object mapping: $. - name: get-v1-message-search description: Search messages hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-message-search with: query: tools.query skip: tools.skip limit: tools.limit scope: tools.scope sortDir: tools.sortDir tier: tools.tier inputParameters: - name: query type: string description: The search query. See above for the query syntax. required: true - name: skip type: integer description: No. of results to skip. - name: limit type: integer description: Max no. of results to return. If no value is provided, 50 is the default. - name: scope type: string description: Describes where content should be searched for that query. It can exclusively apply to Symphony content or to one Connector. - name: sortDir type: string description: 'Messages sort direction : ASC or DESC (default to DESC)' - name: tier type: string description: 'Target search tier : hot, warm or all (default to hot)' outputParameters: - type: object mapping: $. - name: post-v1-message-search description: Search messages hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-message-search with: skip: tools.skip limit: tools.limit scope: tools.scope sortDir: tools.sortDir tier: tools.tier inputParameters: - name: skip type: integer description: No. of results to skip. - name: limit type: integer description: Max no. of results to return. If no value is provided, 50 is the default. - name: scope type: string description: Describes where content should be searched for that query. It can exclusively apply to Symphony content or to one Connector. - name: sortDir type: string description: 'Messages sort direction : ASC or DESC (default to DESC)' - name: tier type: string description: 'Target search tier : hot, warm or all (default to hot)' outputParameters: - type: object mapping: $. - name: get-v1-stream-sid-attachment description: Download an attachment. hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-stream-sid-attachment with: sid: tools.sid fileId: tools.fileId messageId: tools.messageId inputParameters: - name: sid type: string description: Stream ID required: true - name: fileId type: string description: The attachment ID (Base64-encoded) required: true - name: messageId type: string description: The ID of the message containing the attachment required: true outputParameters: - type: object mapping: $. - name: get-v4-stream-sid-message description: Get messages from an existing stream. hints: readOnly: true destructive: false idempotent: true call: finos.get-v4-stream-sid-message with: sid: tools.sid since: tools.since until: tools.until skip: tools.skip limit: tools.limit inputParameters: - name: sid type: string description: Stream ID required: true - name: since type: integer description: Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 required: true - name: until type: integer description: Timestamp of last required message. This is a long integer value representing milliseconds since Jan 1 1970 - name: skip type: integer description: No. of messages to skip. - name: limit type: integer description: Max No. of messages to return. If no value is provided, 50 is the default. The maximum supported value is 500. outputParameters: - type: object mapping: $. - name: post-v4-stream-sid-message-create description: Post a message to one existing stream. hints: readOnly: false destructive: false idempotent: false call: finos.post-v4-stream-sid-message-create with: sid: tools.sid inputParameters: - name: sid type: string description: Stream ID required: true outputParameters: - type: object mapping: $. - name: post-v4-stream-sid-message-mid-update description: Update an existing message. hints: readOnly: false destructive: false idempotent: false call: finos.post-v4-stream-sid-message-mid-update with: sid: tools.sid mid: tools.mid inputParameters: - name: sid type: string description: Stream ID required: true - name: mid type: string description: ID of the message to be updated required: true outputParameters: - type: object mapping: $. - name: post-v3-stream-sid-share description: PROVISIONAL - Share a piece of content into Symphony hints: readOnly: false destructive: false idempotent: false call: finos.post-v3-stream-sid-share with: sid: tools.sid inputParameters: - name: sid type: string description: Stream ID required: true outputParameters: - type: object mapping: $. - name: post-v1-util-echo description: Test endpoint, returns input. hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-util-echo outputParameters: - type: object mapping: $. - name: get-v1-signals-list description: List signals for the requesting user. This includes signals that the user has created and public signals to which they subscribed. hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-signals-list with: skip: tools.skip limit: tools.limit inputParameters: - name: skip type: integer description: No. of signals to skip. - name: limit type: integer description: Max no. of signals to return. If no value is provided, 50 is the default. The maximum supported value is 500. outputParameters: - type: object mapping: $. - name: get-v1-signals-id-get description: Get details of the requested signal. hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-signals-id-get with: id: tools.id inputParameters: - name: id type: string description: The ID of the signal to display. required: true outputParameters: - type: object mapping: $. - name: post-v1-signals-create description: Create a signal. hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-signals-create outputParameters: - type: object mapping: $. - name: post-v1-signals-id-update description: Update a signal. hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-signals-id-update with: id: tools.id inputParameters: - name: id type: string description: The id of the signal. required: true outputParameters: - type: object mapping: $. - name: post-v1-signals-id-delete description: Delete a signal. hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-signals-id-delete with: id: tools.id inputParameters: - name: id type: string description: The id of the signal. required: true outputParameters: - type: object mapping: $. - name: post-v1-signals-id-subscribe description: Subscribe to a Signal. hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-signals-id-subscribe with: id: tools.id pushed: tools.pushed inputParameters: - name: id type: string description: The id of the signal. required: true - name: pushed type: boolean description: Prevent the user to unsubscribe (only for bulk subscription) outputParameters: - type: object mapping: $. - name: post-v1-signals-id-unsubscribe description: Unsubscribe to a Signal. hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-signals-id-unsubscribe with: id: tools.id inputParameters: - name: id type: string description: The id of the signal. required: true outputParameters: - type: object mapping: $. - name: get-v1-signals-id-subscribers description: Get the subscribers of a signal hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-signals-id-subscribers with: id: tools.id skip: tools.skip limit: tools.limit inputParameters: - name: id type: string description: The id of the signal. required: true - name: skip type: integer description: No. of results to skip. - name: limit type: integer description: Max No. of subscribers to return. If no value is provided, 100 is the default. outputParameters: - type: object mapping: $. - name: get-v1-info description: Get information about the Agent hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-info outputParameters: - type: object mapping: $. - name: get-v1-dlp-policies description: Get all policies hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-dlp-policies with: page: tools.page limit: tools.limit inputParameters: - name: page type: integer description: Optional parameter to specify which page to return (default is 0) - name: limit type: integer description: Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50. outputParameters: - type: object mapping: $. - name: post-v1-dlp-policies description: Creates a policy hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-dlp-policies outputParameters: - type: object mapping: $. - name: get-v1-dlp-policies-policyid description: Get a policy hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-dlp-policies-policyid with: policyId: tools.policyId policyVersion: tools.policyVersion inputParameters: - name: policyId type: string description: Unique dictionary identifier. required: true - name: policyVersion type: string description: Optional parameter, if set to be valid policy version number, will return policy with specified policyVersion. Otherwise, return the latest policy. outputParameters: - type: object mapping: $. - name: put-v1-dlp-policies-policyid description: Updates a policy. Cannot be used for creation. hints: readOnly: false destructive: false idempotent: true call: finos.put-v1-dlp-policies-policyid with: policyId: tools.policyId inputParameters: - name: policyId type: string description: Unique dictionary identifier. required: true outputParameters: - type: object mapping: $. - name: delete-v1-dlp-policies-policyid description: Delete a policy hints: readOnly: false destructive: true idempotent: true call: finos.delete-v1-dlp-policies-policyid with: policyId: tools.policyId inputParameters: - name: policyId type: string description: Unique dictionary identifier. required: true outputParameters: - type: object mapping: $. - name: post-v1-dlp-policies-policyid-enable description: Enables a policy. hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-dlp-policies-policyid-enable with: policyId: tools.policyId inputParameters: - name: policyId type: string description: policyId required: true outputParameters: - type: object mapping: $. - name: post-v1-dlp-policies-policyid-disable description: Disables a policy. hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-dlp-policies-policyid-disable with: policyId: tools.policyId inputParameters: - name: policyId type: string description: policyId required: true outputParameters: - type: object mapping: $. - name: get-v1-dlp-dictionaries description: Get all dictionary metadatas hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-dlp-dictionaries with: page: tools.page limit: tools.limit inputParameters: - name: page type: integer description: Optional parameter to specify which page to return (default is 0) - name: limit type: integer description: Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50. outputParameters: - type: object mapping: $. - name: post-v1-dlp-dictionaries description: Create a dictionary hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-dlp-dictionaries outputParameters: - type: object mapping: $. - name: get-v1-dlp-dictionaries-dictid description: Get dictionary metadata hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-dlp-dictionaries-dictid with: dictId: tools.dictId dictVersion: tools.dictVersion inputParameters: - name: dictId type: string description: Unique dictionary identifier required: true - name: dictVersion type: string description: If set to be valid dictionary version number, will return dictionary metadata with specified version. Otherwise, return the latest dictionary metadata. outputParameters: - type: object mapping: $. - name: put-v1-dlp-dictionaries-dictid description: Updates a dictionary hints: readOnly: false destructive: false idempotent: true call: finos.put-v1-dlp-dictionaries-dictid with: dictId: tools.dictId inputParameters: - name: dictId type: string description: Unique dictionary identifier required: true outputParameters: - type: object mapping: $. - name: delete-v1-dlp-dictionaries-dictid description: Delete a dictionary hints: readOnly: false destructive: true idempotent: true call: finos.delete-v1-dlp-dictionaries-dictid with: dictId: tools.dictId inputParameters: - name: dictId type: string description: Unique dictionary identifier required: true outputParameters: - type: object mapping: $. - name: get-v1-dlp-dictionaries-dictid-data-download description: Downloads Base 64 encoded dictionary content. hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-dlp-dictionaries-dictid-data-download with: dictId: tools.dictId dictVersion: tools.dictVersion inputParameters: - name: dictId type: string description: Unique dictionary identifier required: true - name: dictVersion type: string description: If set to be valid dictionary version number, will return dictionary with specified version. Otherwise, return the latest dictionary. outputParameters: - type: object mapping: $. - name: post-v1-dlp-dictionaries-dictid-data-upload description: Override dictionary content with provided content. hints: readOnly: false destructive: false idempotent: false call: finos.post-v1-dlp-dictionaries-dictid-data-upload with: dictId: tools.dictId inputParameters: - name: dictId type: string description: Unique dictionary identifier required: true outputParameters: - type: object mapping: $. - name: get-v1-dlp-violations-message description: Get violations as a result of policy enforcement on messages. hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-dlp-violations-message with: startTime: tools.startTime endTime: tools.endTime next: tools.next limit: tools.limit inputParameters: - name: startTime type: integer description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 required: true - name: endTime type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. outputParameters: - type: object mapping: $. - name: get-v1-dlp-violations-stream description: Get violations as a result of policy enforcement on streams. hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-dlp-violations-stream with: startTime: tools.startTime endTime: tools.endTime next: tools.next limit: tools.limit inputParameters: - name: startTime type: integer description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 required: true - name: endTime type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. outputParameters: - type: object mapping: $. - name: get-v1-dlp-violations-signal description: Get violations as a result of policy enforcement on signals. hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-dlp-violations-signal with: startTime: tools.startTime endTime: tools.endTime next: tools.next limit: tools.limit inputParameters: - name: startTime type: integer description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 required: true - name: endTime type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. outputParameters: - type: object mapping: $. - name: get-v3-dlp-policies description: Get all policies hints: readOnly: true destructive: false idempotent: true call: finos.get-v3-dlp-policies with: page: tools.page limit: tools.limit inputParameters: - name: page type: integer description: Optional parameter to specify which page to return (default is 0) - name: limit type: integer description: Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50. outputParameters: - type: object mapping: $. - name: post-v3-dlp-policies description: Creates a policy hints: readOnly: false destructive: false idempotent: false call: finos.post-v3-dlp-policies outputParameters: - type: object mapping: $. - name: get-v3-dlp-policies-policyid description: Get a policy hints: readOnly: true destructive: false idempotent: true call: finos.get-v3-dlp-policies-policyid with: policyId: tools.policyId policyVersion: tools.policyVersion inputParameters: - name: policyId type: string description: Unique dictionary identifier. required: true - name: policyVersion type: string description: Optional parameter, if set to be valid policy version number, will return policy with specified policyVersion. Otherwise, return the latest policy. outputParameters: - type: object mapping: $. - name: post-v3-dlp-policies-policyid-update description: Updates a policy. Cannot be used for creation. hints: readOnly: false destructive: false idempotent: false call: finos.post-v3-dlp-policies-policyid-update with: policyId: tools.policyId inputParameters: - name: policyId type: string description: Unique dictionary identifier. required: true outputParameters: - type: object mapping: $. - name: post-v3-dlp-policies-policyid-delete description: Delete a policy hints: readOnly: false destructive: false idempotent: false call: finos.post-v3-dlp-policies-policyid-delete with: policyId: tools.policyId inputParameters: - name: policyId type: string description: Unique dictionary identifier. required: true outputParameters: - type: object mapping: $. - name: post-v3-dlp-policies-policyid-enable description: Enables a policy. hints: readOnly: false destructive: false idempotent: false call: finos.post-v3-dlp-policies-policyid-enable with: policyId: tools.policyId inputParameters: - name: policyId type: string description: policyId required: true outputParameters: - type: object mapping: $. - name: post-v3-dlp-policies-policyid-disable description: Disables a policy. hints: readOnly: false destructive: false idempotent: false call: finos.post-v3-dlp-policies-policyid-disable with: policyId: tools.policyId inputParameters: - name: policyId type: string description: policyId required: true outputParameters: - type: object mapping: $. - name: get-v3-dlp-violations-message description: Get violations as a result of policy enforcement on messages. hints: readOnly: true destructive: false idempotent: true call: finos.get-v3-dlp-violations-message with: startTime: tools.startTime endTime: tools.endTime next: tools.next limit: tools.limit inputParameters: - name: startTime type: integer description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 required: true - name: endTime type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. outputParameters: - type: object mapping: $. - name: get-v3-dlp-violations-stream description: Get violations as a result of policy enforcement on streams. hints: readOnly: true destructive: false idempotent: true call: finos.get-v3-dlp-violations-stream with: startTime: tools.startTime endTime: tools.endTime next: tools.next limit: tools.limit inputParameters: - name: startTime type: integer description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 required: true - name: endTime type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. outputParameters: - type: object mapping: $. - name: get-v3-dlp-violations-signal description: Get violations as a result of policy enforcement on signals. hints: readOnly: true destructive: false idempotent: true call: finos.get-v3-dlp-violations-signal with: startTime: tools.startTime endTime: tools.endTime next: tools.next limit: tools.limit inputParameters: - name: startTime type: integer description: Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970 required: true - name: endTime type: integer description: Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current tim - name: next type: string description: Offset of the next chunk of violations. Value is null for the first request. - name: limit type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500. outputParameters: - type: object mapping: $. - name: get-v3-dlp-violation-attachment description: Get attachments that were sent as part of messages that were flagged by the DLP System. hints: readOnly: true destructive: false idempotent: true call: finos.get-v3-dlp-violation-attachment with: fileId: tools.fileId violationId: tools.violationId inputParameters: - name: fileId type: string description: ID of attachment that will be downloaded. required: true - name: violationId type: string description: ID of violation that corresponds to the flagged message that contains the attachment required: true outputParameters: - type: object mapping: $. - name: get-v1-audittrail-privilegeduser description: Get a list of actions performed by a privileged account acting as privileged user given a period of time. hints: readOnly: true destructive: false idempotent: true call: finos.get-v1-audittrail-privilegeduser with: startTimestamp: tools.startTimestamp endTimestamp: tools.endTimestamp before: tools.before after: tools.after limit: tools.limit initiatorId: tools.initiatorId role: tools.role inputParameters: - name: startTimestamp type: integer description: Start timestamp in unix timestamp in millseconds. required: true - name: endTimestamp type: integer description: End timestamp in unix timestamp in millseconds. If not specified, it assumes to be current time. - name: before type: string description: Return results from an opaque “before” cursor value as presented via a response cursor. - name: after type: string description: Return results from an opaque “after” cursor value as presented via a response cursor. - name: limit type: integer description: Max No. of violations to return. If no value is provided, 50 is the default. Some maximums for limit may be enforced for performance reasons. The maximum suppor - name: initiatorId type: integer description: If present, only the initiator with this initiator will be returned. - name: role type: string description: 'If present, only the audit trail initiated by s user with privileged role acting as privileged user will be returned. Privileged eliglible roles: User Provision' outputParameters: - type: object mapping: $. - name: listdatafeed description: Returns the list of active datafeeds of the user. hints: readOnly: true destructive: false idempotent: true call: finos.listdatafeed with: tag: tools.tag inputParameters: - name: tag type: string description: A unique identifier to ensure uniqueness of the datafeed. Used to restrict search. outputParameters: - type: object mapping: $. - name: createdatafeed description: Create a new real time feed of messages and events. hints: readOnly: false destructive: false idempotent: false call: finos.createdatafeed outputParameters: - type: object mapping: $. - name: deletedatafeed description: Delete the specified real time message / event stream ("datafeed"). hints: readOnly: false destructive: true idempotent: true call: finos.deletedatafeed with: datafeedId: tools.datafeedId inputParameters: - name: datafeedId type: string description: ID of the datafeed required: true outputParameters: - type: object mapping: $. - name: readdatafeed description: Read the specified real time message / event stream ("datafeed"). hints: readOnly: false destructive: false idempotent: false call: finos.readdatafeed with: datafeedId: tools.datafeedId inputParameters: - name: datafeedId type: string description: ID of the datafeed required: true outputParameters: - type: object mapping: $. - name: readevents description: Creates and Reads a real time feed of messages and events of your pod (Datahose) hints: readOnly: false destructive: false idempotent: false call: finos.readevents outputParameters: - type: object mapping: $.