REST API

Developer Documentation
Developer Certification
Developer Days
Developer Newsletter

REST API

Our REST API lets you build tools and applications on top of Symphony's secure messaging platform.

REST API

REST API

v20.12

v20.3
(1.57)
v20.4
(1.58)
v20.5
(1.59)
v20.6
(1.60)
v20.7
(1.61)
v20.9
(1.63)
v20.10
(20.10)
v20.12stable
(20.12)
v20.13beta
(20.13)

HomeGuideRecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

API Reference

discard

Only admins can see thisEnable it for everyone

Introduction

Introduction

Bot Authentication

Bot Authentication
post
RSA Session Authenticate
post
RSA Key Manager Authenticate
post
Session Authenticate
post
Key Manager Authenticate
post
Session Logout
post
Key Manager Logout

Extension App Authentication

post
Authenticate Extension App with an RSA
post
Application Authenticate
get
Pod Certificate

On Behalf Of

OBO-Enabled Endpoints
post
RSA App Authentication
post
RSA User Authentication by User ID
post
RSA User Authentication by User Name
post
App Authenticate
post
User Authenticate by User ID
post
User Authenticate by User Name

Basics

get
Health Check v3
get
Health Check Extended v3
get
Session User v2
get
Agent Info v1
post
Echo

Messages

get
Messages
post
Create Message v4
post
Blast Message
get
Attachment
post
Import Message
post
Suppress Message
post
Message Search
get
Message Search
get
Message Status
get
Attachment Types
get
Get Message v1
get
List Attachments
get
List Message Receipts
get
Message Metadata

Datafeed

Introduction to datafeed
post
Create Messages/Events Stream
get
Read Messages/Events Stream

Datafeed 2.0

Introduction to datafeed
post
Create Datafeed v5
post
Read Datafeed v5
get
List Datafeed v5
delete
Delete Datafeed v5

Streams

post
Create IM or MIM
post
Create IM or MIM non-inclusive
Room Attributes
post
Create Room v3
post
Update Room v3
get
Room Info v3
post
De/Re-activate Room
get
Room Members v2
post
Add Member
post
Remove Member
post
Share
post
Promote Owner
post
Demote Owner
post
Search Rooms v3
post
List User Streams
get
Stream Info v2
post
List Streams for Enterprise v2
get
Stream Members

Signals

get
List Signals
get
Get Signal
post
Create Signal
post
Update Signal
post
Delete Signal
post
Subscribe Signal
post
Unsubscribe Signal
get
Subscribers
Signal Object

Connections

get
Get Connection
get
List Connections
post
Create Connection
post
Accept Connection
post
Reject Connection
post
Remove Connection

Users

get
Users Lookup v3
post
Search Users
post
Follow User
post
Unfollow User
get
List User Followers
get
List Users Followed

Presence

get
Get Presence
get
Get All Presence
get
Get User Presence
post
External Presence Interest
post
Set Presence
post
Create Presence Feed
get
Read Presence Feed
post
Delete Presence Feed
post
Set Other User's Presence - Admin V3

Admin Application Management

post
Create Application
post
Create Application with an RSA Public Key
post
Update Application
post
Update Application with an RSA Public Key
post
Delete Application
get
Get Application

Admin User Management

User Attributes Object
Password Object
Roles Object
UserKeyRequest Object
get
Get User v2
get
List Users v2
post
Create User v2
post
Update User v2
get
User Avatar
post
Update User Avatar
get
User Status
post
Update User Status
get
List Features
get
User Features
post
Update User Features
post
Find Users
get
List Roles
post
Add Role
post
Remove Role
get
List Audit Trail v1
put
Suspend User Account v1

URI Protocols

post
Create Protocol
get
List Protocols v2
delete
Delete Protocol

Application Entitlements

get
List App Entitlements
post
Update App Entitlements
get
User Apps
post
Update User Apps

Disclaimers

get
Disclaimer
get
List Disclaimers
get
List Disclaimer Users
get
User Disclaimer
post
Update User Disclaimer
delete
Unassign User Disclaimer

Delegates

get
User Delegates
post
Update User Delegates

Information Barrier Groups

get
List IB Groups
get
List IB Group Members
post
Add IB Group Members
post
Remove IB Group Members
get
List Policies

User Groups

Group Types
User Groups
get
List User Groups
get
Get a User Group
post
Create a User Group
put
Update a User Group
Group Assignments
get
List Assignments
get
List Group Assignments
put
Update a Group
Group Memberships
get
List Memberships
get
List Group Memberships
put
Add Group Memberships
put
Update a User Membership

Security

get
Public (Signing) Certificate
get
List Company Certificates
post
Create Company Certificate
post
Delete Company Certificate
get
Company Certificate Details
get
List Verified Certificates
get
List Trusted Certificates
post
List Certificate Types
post
Update Company Certificate

Malware Scanner

Malware Scanner APIs
get
File Malware Scanner State
put
Update File Malware Scanner State
Customer Malware Scanner APIs
get
Malware Scanner Health
put
File Malware Scanner

DLP Dictionary and Policy Management

Overview
Dictionary Management endpoints
post
Create Dictionary
get
All Dictionaries
get
Specific Dictionary
put
Update Dictionary
post
Upload Dictionary Content
get
Download Dictionary Content
delete
Delete Dictionary
V2 Policy Management endpoints
post
V2 Create Policy
get
V2 All Policies
get
V2 Get Policy
put
V2 Update Policy
post
V2 Enable Policy
post
V2 Disable Policy
delete
V2 Delete Policy
V2 Violations endpoints
get
V2 Signal Violations
get
V2 Message Violations
get
V2 Stream Violations
V3 Policy Management endpoints
V3 Policy structure for Create/Update
post
V3 Create Policy
get
V3 All Policies
get
V3 Get Policy
post
V3 Update Policy
post
V3 Enable Policy
post
V3 Disable Policy
post
V3 Delete Policy
V3 Violations Endpoints
V3 Violations - Sample Responses
V3 Violations - Special Scenarios of Attachments
get
V3 Message Violations
get
V3 Signal Violations
get
V3 Stream Violations
get
V3 Violation Attachment Download

Deprecated

get
Get Message IDs by Timestamp
get
Health Check v2