# 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 with other users * Send messages and attachments * Set the context user's own presence > #### 📘 More information on OBO > > For more information, please refer to [OBO Authentication](https://docs.developers.symphony.com/building-extension-applications-on-symphony/app-authentication/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.
OBO-enabled endpointPermissionEndpoint documentation
GET /pod/v1/connection/listGET_USER_CONNECTIONS/pages/mIozaSn9HaKKBMF72SbQ
GET /pod/v1/admin/system/protocols/listSEND_MESSAGES

Deprecated documentation. For more information, refer to:

/pages/rrW0dxqJ0XALRyQUEI3b

GET /pod/v1/connection/user/{userId}/infoGET_USER_CONNECTIONS/pages/1skpI0wNR2ouSnWJcJoU
GET /pod/v1/files/allowedTypesSEND_MESSAGES/pages/lVq6rByF9MGbEhL1GGmi
GET /pod/v1/presence/feed/{feedId}/readGET_PRESENCE/pages/U7OxQkFF5VQletQPFMes
GET /pod/v1/sessioninfoGET_BASIC_USER_INFODeprecated documentation. For more information, refer to:
/pages/yYK763uCdGWxeyw0cKYQ
GET /pod/v1/streams/{streamId}/infoSEND_MESSAGESDeprecated documentation. For more information, refer to:
/pages/f1lkRncUJmnoka8J69gC
GET /pod/v1/userGET_BASIC_CONTACT_INFODeprecated documentation. For more information, refer to:
/pages/eKBGHqOjwe6iaz62HWEA
GET /pod/v1/user/presenceGET_PRESENCEDeprecated documentation. For more information, refer to:
/pages/L8Abr3Wf0n6N23pxk9vI
GET /pod/v1/user/{userId}/presenceGET_PRESENCEDeprecated documentation. For more information, refer to:
/pages/PoFcOW1wge8cBui4jD19
GET /pod/v2/sessioninfoGET_BASIC_USER_INFO/pages/yYK763uCdGWxeyw0cKYQ
GET /pod/v2/userGET_BASIC_CONTACT_INFO SEND_MESSAGESDeprecated documentation. For more information, refer to:
/pages/eKBGHqOjwe6iaz62HWEA
GET /pod/v2/user/presenceGET_PRESENCE/pages/L8Abr3Wf0n6N23pxk9vI
GET /pod/v2/user/{userId}/presenceGET_PRESENCEDeprecated documentation. For more information, refer to:
/pages/PoFcOW1wge8cBui4jD19
GET /pod/v3/room/{roomId}/infoMANAGE_ROOMS/pages/lB8KolMLiQkIQOJNSxBQ
GET /pod/v3/user/{userId}/presenceGET_PRESENCE/pages/PoFcOW1wge8cBui4jD19
GET /pod/v3/usersGET_BASIC_CONTACT_INFO/pages/eKBGHqOjwe6iaz62HWEA
POST /v1/user/{uid}/followMANAGE_USER_FOLLOWING/pages/7IPrcdfnQWmuEHqyA19I
POST /v1/user/{uid}/unfollowMANAGE_USER_FOLLOWING/pages/i9GnDKrzeGPGHMPJqOvs
GET /agent/v1/signals/{signalId}/getMANAGE_SIGNALS/pages/wd0koxucO0LwcL5LbNKm
GET /agent/v1/signals/{signalId}/subscribersMANAGE_SIGNALS/pages/ACeKPqEUkOa8WiLZHqRL
GET /agent/v1/signals/listMANAGE_SIGNALS/pages/H9BvxfGCH7GIRUnuc7HY
POST /agent/v1/signals/createMANAGE_SIGNALS/pages/bDLu6q1eZJCk0CgfoHza
POST /agent/v1/signals/{signalId}/updateMANAGE_SIGNALS/pages/0D9fLyAUb20gPeupPnpd
POST /agent/v1/signals/{signalId}/deleteMANAGE_SIGNALS/pages/HP0Z4uMWBwUbn8TTi2cT
POST /agent/v1/signals/{signalId}/subscribeMANAGE_SIGNALS/pages/AC5L5WAKnTLTNtajzJ1G
POST /agent/v1/signals/{signalId}/unsubscribeMANAGE_SIGNALS/pages/gdJs5kQkbHSb5i7sfsAf
POST /agent/v3/stream/{streamId}/shareSEND_MESSAGES/pages/SU7Ch6IObT1Z0cLmDiMh
POST /agent/v4/stream/{streamId}/message/createSEND_MESSAGES/pages/ehGwBvwaMIEWzlStKYOx
POST /agent/v4/message/blastSEND_MESSAGES/pages/UHXORS6Dz7xn35s62W5L
POST /agent/v4/stream/{:sid}/message/{:mid}/updateSEND_MESSAGES/pages/vucA2sPJHQ9PMcFGrqbU
POST /v1/admin/messagesuppression/{messageId}/suppressSUPPRESS_MESSAGES/pages/uRcJWMyZEK8dyh7FIwhO
POST /pod/v1/connection/createREQUEST_USER_CONNECTIONS/pages/FbG9fRDvI4qT8YOLkcN9
POST /pod/v1/im/createSEND_MESSAGES/pages/q9CAqiK7ruQK9t16OuyH
POST /pod/v1/presence/feed/createGET_PRESENCE/pages/xDWny0kWxp7DnrXu7OMk
POST /pod/v1/presence/feed/{feedId}/deleteGET_PRESENCE/pages/vombKpIS3y8MXmk11DJX
POST /pod/v2/room/{roomId}/membership/listMANAGE_ROOMS
LIST_USER_STREAMS		Since SBE 20.16
/pages/7ILYTDxOcojZDuIR9H6T
POST /pod/v1/room/{roomId}/membership/addMANAGE_ROOMS/pages/QC1Rsg9M3CyEPEbVTJtM
POST /pod/v1/room/{roomId}/membership/demoteOwnerMANAGE_ROOMS/pages/S86t6XTphY6Jg7byPXeU
"POST" /pod/v1/room/{roomId}/membership/promoteOwnerMANAGE_ROOMS/pages/2Kss9VcbVjVwnplgwMxh
POST /pod/v1/room/{roomId}/membership/removeMANAGE_ROOMS/pages/nYnj8ov8uEvfC6WUSsOm
POST /pod/v1/room/{roomId}/setActiveMANAGE_ROOMS/pages/xpY7Pl9GOoeGsprbEfu5
POST /pod/v1/streams/listLIST_USER_STREAMS/pages/E1u41UHYesTLGJSg3jRz
POST /pod/v2/user/presenceSET_PRESENCE/pages/PiOGmxBF6g96fY6B9r4K
POST /pod/v1/user/presence/registerGET_PRESENCE/pages/tuIPEwbfPA0dFdw4VkqR
POST /pod/v1/user/searchGET_BASIC_CONTACT_INFO/pages/pBbBmSNvNOqlRJtTaaKa
POST /pod/v2/user/presenceSET_PRESENCE/pages/PiOGmxBF6g96fY6B9r4K
POST /pod/v3/room/createMANAGE_ROOMS CREATE_USER_STREAM/pages/yCsXZPy2jssQzEh8R4ew
POST /pod/v3/room/searchMANAGE_ROOMS/pages/WcJCaaZLaDd0de0bT5pK
POST /pod/v3/room/{roomId}/updateMANAGE_ROOMS/pages/MRgt7FVE43dWvZAxgGhG
POST /pod/v3/user/presenceSET_PRESENCE/pages/afTlLFjj3ICA2an5Dkdw
### The following table describes the use of permissions:
PermissionUsage
GET_BASIC_CONTACT_INFOAn app can get basic contact info.
GET_BASIC_USER_INFOAn app can get basic contact info.
SEND_MESSAGESAn app can send messages on behalf of a user. Creates IM for users.
SUPPRESS_MESSAGESAn app can suppress a user's messages on behalf of that user.
CREATE_USER_STREAMAn app can create streams on behalf of a user.
MANAGE_ROOMSAn app can manage streams on behalf of a user.
MANAGE_SIGNALSAn app can list, create, edit, and delete signals on behalf of a user.
LIST_USER_STREAMSAn app can get a list of user streams on behalf of users.
GET_USER_CONNECTIONSAn app can get an appinfo of all user connections on behalf of users.
REQUEST_USER_CONNECTIONSAn app can send connection requests on behalf of users.
GET_PRESENCEAn app can get a user presence on behalf of users.
SET_PRESENCEAn app can set presence on behalf of users.
MANAGE_USER_FOLLOWINGAn 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. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://rest-api.symphony.com/main/apps-on-behalf-of-obo/obo-enabled-endpoints.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.