API Endpoints for Apps
Get Started with OBO
OBO or On-Behalf-Of authentication allows an extension application to be able to call REST API endpoints to perform operations on behalf of an application end-user.
Such operations include:
List the streams of a given user
Initiate connection requests to and determine connection status with other users
Get the presence state of other connected users
Initiate IMs and MIMs with other users
Send messages and attachments
Set the context user's own presence
📘 More information on OBOFor more information, please refer to OBO Authentication.
API endpoints enabled for OBO
The following table describes which of our REST API endpoints are OBO-enabled, and for each the application permission that must be granted to the app.
GET /pod/v1/admin/system/protocols/list
SEND_MESSAGES
Deprecated documentation. For more information, refer to:
GET /pod/v1/sessioninfo
GET_BASIC_USER_INFO
Deprecated documentation. For more information, refer to: Session User
GET /pod/v1/streams/{streamId}/info
SEND_MESSAGES
Deprecated documentation. For more information, refer to: Stream Info
GET /pod/v1/user
GET_BASIC_CONTACT_INFO
Deprecated documentation. For more information, refer to: Users Lookup
GET /pod/v1/user/presence
GET_PRESENCE
Deprecated documentation. For more information, refer to: Get Presence
GET /pod/v1/user/{userId}/presence
GET_PRESENCE
Deprecated documentation. For more information, refer to: Get User Presence
GET /pod/v2/user
GET_BASIC_CONTACT_INFO SEND_MESSAGES
Deprecated documentation. For more information, refer to: Users Lookup
GET /pod/v2/user/{userId}/presence
GET_PRESENCE
Deprecated documentation. For more information, refer to: Get User Presence
POST /pod/v2/room/{roomId}/membership/list
MANAGE_ROOMS LIST_USER_STREAMS
Since SBE 20.16 Room Members
The following table describes the use of permissions:
GET_BASIC_CONTACT_INFO
An app can get basic contact info.
GET_BASIC_USER_INFO
An app can get basic contact info.
SEND_MESSAGES
An app can send messages on behalf of a user. Creates IM for users.
SUPPRESS_MESSAGES
An app can suppress a user's messages on behalf of that user.
CREATE_USER_STREAM
An app can create streams on behalf of a user.
MANAGE_ROOMS
An app can manage streams on behalf of a user.
MANAGE_SIGNALS
An app can list, create, edit, and delete signals on behalf of a user.
LIST_USER_STREAMS
An app can get a list of user streams on behalf of users.
GET_USER_CONNECTIONS
An app can get an appinfo
of all user connections on behalf of users.
REQUEST_USER_CONNECTIONS
An app can send connection requests on behalf of users.
GET_PRESENCE
An app can get a user presence on behalf of users.
SET_PRESENCE
An app can set presence on behalf of users.
MANAGE_USER_FOLLOWING
An app can make a list of users follow or unfollow a considered user, identified by his uid.
🚧 All OBO endpoints respect any existing entitlements or state for the user in session.
For instance, if a user is not already connected to another user, an app cannot send a message to the second user on behalf of the first. Another example is that if a user does not have the "Can Send Files" entitlement in Symphony, an app cannot send a message containing an attachment on behalf of the user.
Last updated