List User Streams (Admin)
Returns a list of all the streams of which the specified user is a member, sorted by creation date (ascending - oldest to newest).
Released in 20.16.
Retrieve a list of all streams of which this user is a member,
sorted by creation date (ascending). Since SBE 20.16.
post
Path parameters
uidinteger · int64Required
User ID as a decimal integer
Query parameters
skipintegerOptional
No. of results to skip.
limitintegerOptional
Max no. of results to return. If no value is provided, 50 is the default.
Header parameters
sessionTokenstringRequired
Session authentication token.
Body
Stream filtering parameters.
includeInactiveStreamsbooleanOptionalExample:
Whether to include inactive streams in the list of results.
false
Responses
200
OK
application/json
204
Stream not found.
400
Client error, see response body for further details.
application/json
401
Unauthorized: Invalid session token.
application/json
403
Forbidden: Caller lacks necessary entitlement.
application/json
500
Server error, see response body for further details.
application/json
post
POST /pod/v1/admin/user/{uid}/streams/list HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"streamTypes": [
{
"type": "IM"
},
{
"type": "ROOM"
}
],
"includeInactiveStreams": "false"
}
[
{
"id": "text",
"crossPod": true,
"active": true,
"streamType": {
"type": "ROOM"
},
"streamAttributes": {
"members": [
7215545058313,
7215545078461
]
},
"roomAttributes": {
"name": "text"
}
}
]
🚧 Required PermissionsOnly service users with the User Provisioning role can use this endpoint.
📘 Overview of streamsA stream is like a container for messages exchanged between two or more users via a given instant message (IM) or chat room. For more information, refer to Overview of streams.
Last updated
Was this helpful?