Pod API
This document refers to Symphony API calls that do not need\nencryption or decryption of content.\n\n- sessionToken can be obtained by calling the\nauthenticationAPI on the symphony back end and the key manager\nrespectively. Refer to the methods described in authenticatorAPI.yaml.\n- Actions are defined to be atomic, ie will succeed in their entirety\nor fail and have changed nothing.\n- If it returns a 40X status then it will have made no change to the\nsystem even if ome subset of the request would have succeeded.\n- If this contract cannot be met for any reason then this is an error\nand the response code will be 50X.\n
Version: 1.40.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
get /v1/admin/app/entitlement/listpost /v1/admin/app/entitlement/listget /v1/admin/user/{uid}/app/entitlement/listpost /v1/admin/user/{uid}/app/entitlement/listpost /v1/connection/acceptpost /v1/connection/createget /v1/connection/listpost /v1/connection/rejectget /v1/connection/user/{userId}/infoget /v1/admin/disclaimer/{did}get /v1/admin/disclaimer/{did}/usersget /v1/admin/disclaimer/listpost /v1/admin/group/{gid}/membership/addget /v1/admin/group/{gid}/membership/listpost /v1/admin/group/{gid}/membership/removeget /v1/admin/group/listget /v1/admin/policy/listpost /v1/admin/messagesuppression/{id}/suppressget /v1/presenceget /v1/user/{uid}/presencepost /v1/room/{id}/membership/addpost /v1/room/{id}/membership/demoteOwnerget /v1/room/{id}/membership/listpost /v1/room/{id}/membership/promoteOwnerpost /v1/room/{id}/membership/removepost /v1/companycert/createpost /v1/companycert/deleteget /v1/companycert/{fingerPrint}/getget /v1/companycert/{fingerPrint}/issuedBypost /v1/companycert/{fingerPrint}/updateget /v1/companycert/listget /v1/companycert/podmanaged/listpost /v1/companycert/type/listget /v1/sessioninfopost /v1/admin/im/createpost /v1/im/createpost /v1/room/createget /v1/room/{id}/infopost /v1/room/{id}/setActivepost /v1/room/{id}/updatepost /v2/room/createget /v2/room/{id}/infopost /v2/room/{id}/updatepost /v2/room/searchget /v1/admin/system/features/listpost /v1/admin/user/createget /v1/admin/user/listget /v1/admin/user/{uid}/avatarpost /v1/admin/user/{uid}/avatar/updateget /v1/admin/user/{uid}/delegatespost /v1/admin/user/{uid}/delegates/updateget /v1/admin/user/{uid}/disclaimerpost /v1/admin/user/{uid}/disclaimer/updateget /v1/admin/user/{uid}/featurespost /v1/admin/user/{uid}/features/updateget /v1/admin/user/{uid}get /v1/admin/user/{uid}/statuspost /v1/admin/user/{uid}/status/updatepost /v1/admin/user/{uid}/updateget /v1/userget /v1/user/name/{userName}/getget /v2/user
Up
get /v1/admin/app/entitlement/list
Get the list of application entitlements for the company (v1AdminAppEntitlementListGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/app/entitlement/list
Update the application entitlements for the company (v1AdminAppEntitlementListPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/user/{uid}/app/entitlement/list
Get the list of application entitlements for this user (v1AdminUserUidAppEntitlementListGet)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/user/{uid}/app/entitlement/list
Update the application entitlements for this user (v1AdminUserUidAppEntitlementListPost)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/connection/accept
Accept the connection request for the requesting user (v1ConnectionAcceptPost)
Request body
connectionRequest (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/connection/create
Sends an invitation to connect with another user (v1ConnectionCreatePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
connectionRequest (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/connection/list
List of requesting user's connection (v1ConnectionListGet)
This retrieves all connections of the requesting user. (i.e. both connections in which the requesting user is the sender and those\nin which the requesting user is the inivtee) By default, if you haven't specified the connection status to filter on, this call will only\nreturn results for both \"pending_incoming\" and \"pending_outgoing\". You can optionally filter by userIds to further restrict the results of\na specific connection status. If the users are in the same private pod, the users have an implicit connection status of \"accepted\". Those\nusers will not be returned in the response if you don't specify the connection status as \"accepted\" (default is \"pending\")\nand the explicit userIds in the request.\n
Query parameters
status (optional)
Query Parameter — Filter the connection list based on the connection status.\nThe connection status can only be pending_incoming, pending_outgoing, accepted, rejected, or all (all of the above)\n
userIds (optional)
Query Parameter — The userIds parameter should be specified as a comma delimited list of user ids and can be used to restrict the results of a specific connection.\nNote that this is particularly important if the caller intends to retrieve results for implicit connection (user within the same pod).\nImplicit connections will not be included in the response if userId is not provided.\n
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/connection/reject
Reject the connection request for the requesting user. (v1ConnectionRejectPost)
Reject the connection between the requesting user and request sender. If both users are in the same private pod,\nan error will be returned because both users have an implicit connection which cannot be rejected.\n
Request body
connectionRequest (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/connection/user/{userId}/info
The status of the connection invitation to another user. (v1ConnectionUserUserIdInfoGet)
Path parameters
userId (required)
Path Parameter — user Id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/disclaimer/{did}
Get a disclaimer by disclaimer id (v1AdminDisclaimerDidGet)
Path parameters
did (required)
Path Parameter — The ID of the entity
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/disclaimer/{did}/users
List all users assigned to this disclaimer (v1AdminDisclaimerDidUsersGet)
Path parameters
did (required)
Path Parameter — The ID of the entity
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/disclaimer/list
List all disclaimers for the company (pod) (v1AdminDisclaimerListGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/group/{gid}/membership/add
Add members to an Information Barrier group. (v1AdminGroupGidMembershipAddPost)
Path parameters
gid (required)
Path Parameter — URL-Safe encoded Group ID
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
users (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/group/{gid}/membership/list
Get the list of userids in this Information Barrier Group (v1AdminGroupGidMembershipListGet)
Path parameters
gid (required)
Path Parameter — URL-Safe encoded Group ID
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/group/{gid}/membership/remove
Remove members from an Information Barrier group (v1AdminGroupGidMembershipRemovePost)
Path parameters
gid (required)
Path Parameter — URL-Safe encoded Group ID
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
users (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/group/list
Get a list of all Information Barrier Groups (v1AdminGroupListGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/policy/list
Get all Information Policies (v1AdminPolicyListGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/messagesuppression/{id}/suppress
Suppress a message (v1AdminMessagesuppressionIdSuppressPost)
Path parameters
id (required)
Path Parameter — URL-Safe encoded Message ID
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Get presence information about all company (pod) users. (v1PresenceGet)
The returned data is taken from the in-memory cache for performance\nreasons which means inactive users may be omitted from the response.\n\nAll non-inactive users WILL be returned and some inactive users MAY\nbe included. Any omitted user IS inactive.\n
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/user/{uid}/presence
Get presence information about a particular user. (v1UserUidPresenceGet)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/room/{id}/membership/add
Adds new member to an existing room. (v1RoomIdMembershipAddPost)
Path parameters
id (required)
Path Parameter — Room streamId
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/room/{id}/membership/demoteOwner
Demotes room owner. (v1RoomIdMembershipDemoteOwnerPost)
Path parameters
id (required)
Path Parameter — Room streamId
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/room/{id}/membership/list
Lists the members of an existing room. (v1RoomIdMembershipListGet)
Path parameters
id (required)
Path Parameter — Room streamId
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/room/{id}/membership/promoteOwner
Promotes user to owner. (v1RoomIdMembershipPromoteOwnerPost)
Path parameters
id (required)
Path Parameter — Room streamId
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/room/{id}/membership/remove
Removes member from an existing room. (v1RoomIdMembershipRemovePost)
Path parameters
id (required)
Path Parameter — Room streamId
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/companycert/create
Create a company trusted or untrusted certificate (v1CompanycertCreatePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
cert (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/companycert/delete
Delete a company certificate (v1CompanycertDeletePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
fingerPrint (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/companycert/{fingerPrint}/get
Get the details of a company certificate (v1CompanycertFingerPrintGetGet)
Path parameters
fingerPrint (required)
Path Parameter — Certificate fingerPrint (ID)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/companycert/{fingerPrint}/issuedBy
Return a list of all certificates which were verified to the cert whose\nfingerprint is passed.\n (v1CompanycertFingerPrintIssuedByGet)
Path parameters
fingerPrint (required)
Path Parameter — Certificate fingerPrint (ID)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/companycert/{fingerPrint}/update
Update a company certificate (v1CompanycertFingerPrintUpdatePost)
Path parameters
fingerPrint (required)
Path Parameter — Certificate fingerPrint (ID)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
certAttributes (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/companycert/list
List all trusted certs (v1CompanycertListGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
skip (optional)
Query Parameter — Pagination start
limit (optional)
Query Parameter — Row limit
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/companycert/podmanaged/list
List all trusted certs (v1CompanycertPodmanagedListGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
skip (optional)
Query Parameter — Pagination start
limit (optional)
Query Parameter — Row limit
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/companycert/type/list
List all certs of the given types (v1CompanycertTypeListPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
typeIdList (required)
Body Parameter — Certificate type list
Query parameters
skip (optional)
Query Parameter — Pagination start
limit (optional)
Query Parameter — Row limit
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Get information about the current user's session. (v1SessioninfoGet)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/im/create
Create a new single or multi party instant message conversation (v1AdminImCreatePost)
At least two user IDs must be provided or\nan error response will be sent.\n\nThe caller is not included in the members of the\ncreated chat.\n\nDuplicate users will be included in the membership of the chat but\nthe duplication will be silently ignored.\n\nIf there is an existing IM conversation with the same set of participants then\nthe id of that existing stream will be returned.\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
uidList (required)
Body Parameter — List of (integer) User IDs of participants
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Create a new single or multi party instant message conversation between the caller and specified users. (v1ImCreatePost)
At least one user ID must be provided or\nan error response will be sent.\n\nThe caller is implicitly included in the members of the\ncreated chat.\n\nDuplicate users will be included in the membership of the chat but\nthe duplication will be silently ignored.\n\nIf there is an existing IM conversation with the same set of participants then\nthe id of that existing stream will be returned.\n\nThis method was incorrectly specified to take a query parameter in\nversion 1.0 of this specification but now expects a JSON array of\nuser IDs in the body of the request.\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
uidList (required)
Body Parameter — List of (integer) User IDs of participants
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Create a new chatroom. (v1RoomCreatePost)
Create a new chatroom.\n\nIf no attributes are specified, the room is created as a private chatroom.\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/room/{id}/info
Get information about a partcular chatroom. (v1RoomIdInfoGet)
Path parameters
id (required)
Path Parameter — Room streamId
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/room/{id}/setActive
Deactivate or reactivate a chatroom. At creation, a new chatroom is active. (v1RoomIdSetActivePost)
Path parameters
id (required)
Path Parameter — Room streamId
Query parameters
active (required)
Query Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/room/{id}/update
Update the attributes of an existing chatroom. (v1RoomIdUpdatePost)
Path parameters
id (required)
Path Parameter — Room streamId
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Create a new chatroom. (v2RoomCreatePost)
Create a new chatroom.\n\nIf no attributes are specified, the room is created as a private chatroom.\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v2/room/{id}/info
Get information about a partcular chatroom. (v2RoomIdInfoGet)
Path parameters
id (required)
Path Parameter — Room streamId
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v2/room/{id}/update
Update the attributes of an existing chatroom. (v2RoomIdUpdatePost)
Path parameters
id (required)
Path Parameter — Room streamId
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Search rooms according to the specified criteria. (v2RoomSearchPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
query (required)
Body Parameter — The search query object.
Query parameters
skip (optional)
Query Parameter — No. of results to skip.\n
limit (optional)
Query Parameter — Max no. of results to return. If no value is provided, 50 is the default.\n
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/system/features/list
Get the full set of Symphony features available for this pod (v1AdminSystemFeaturesListGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The list of valid feature entitlement names.
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/user/create
Create a new user (v1AdminUserCreatePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/user/list
Retreive a list of all users in the company (pod) (v1AdminUserListGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/user/{uid}/avatar
Get the URL of the avatar of a particular user (v1AdminUserUidAvatarGet)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/user/{uid}/avatar/update
Update the avatar of a particular user (v1AdminUserUidAvatarUpdatePost)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/user/{uid}/delegates
Get the delegates assigned to a user (v1AdminUserUidDelegatesGet)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The userid's of the delegates of this user.
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/user/{uid}/delegates/update
Update the delegates assigned to a user (v1AdminUserUidDelegatesUpdatePost)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Sucesss.
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/user/{uid}/disclaimer
Get the disclaimer assigned to a user (v1AdminUserUidDisclaimerGet)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
204
No content. User doesn't have an assigned disclaimer
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/user/{uid}/disclaimer/update
Assign a disclaimer to a user (v1AdminUserUidDisclaimerUpdatePost)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/user/{uid}/features
Get the list of Symphony feature entitlements enabled for a particular user (v1AdminUserUidFeaturesGet)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/user/{uid}/features/update
Update the list of Symphony feature entitlements for a particular user (v1AdminUserUidFeaturesUpdatePost)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/user/{uid}
Retreive user details for a particular user (v1AdminUserUidGet)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/admin/user/{uid}/status
Get the status, active or inactive, for a particular user (v1AdminUserUidStatusGet)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/user/{uid}/status/update
Update the status of a particular user (v1AdminUserUidStatusUpdatePost)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
post /v1/admin/user/{uid}/update
Update an existing user (v1AdminUserUidUpdatePost)
Path parameters
uid (required)
Path Parameter — User ID as a decimal integer\n
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
payload (required)
Body Parameter —
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success
400
Client error, see response body for further details.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Get user information by email address. (v1UserGet)
Query parameters
email (required)
Query Parameter — Email address
local (optional)
Query Parameter — If true then a local DB search will be performed and only local pod users will be\nreturned. If absent or false then a directory search will be performed and users\nfrom other pods who are visible to the calling user will also be returned.\n
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
204
No user found.
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Up
get /v1/user/name/{userName}/get
Get user information by user (login) name. (v1UserNameUserNameGetGet)
Searches for a user in the local pod with the given user name.\n
Path parameters
userName (required)
Path Parameter — User login name
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
204
No user found.
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
Get user information (v2UserGet)
Query parameters
uid (optional)
Query Parameter — User ID as a decimal integer
email (optional)
Query Parameter — Email address
username (optional)
Query Parameter — login user name
local (optional)
Query Parameter — If true then a local DB search will be performed and only local pod users will be\nreturned. If absent or false then a directory search will be performed and users\nfrom other pods who are visible to the calling user will also be returned.\nNote: for username search, the local flag must be true\n
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
204
No user found.
400
Client error.
401
Unauthorized: Session tokens invalid.
403
Forbidden: Caller lacks necessary entitlement.
500
Server error, see response body for further details.
[ Jump to Methods ]
Table of Contents
AvatarAvatarListAvatarUpdateBulkActionResultCertInfoCertInfoItemCompanyCertCompanyCertAttributesCompanyCertDetailCompanyCertInfoCompanyCertInfoListCompanyCertInfoList_innerCompanyCertStatusCompanyCertTypeCompanyCertTypeListDelegateActionDisclaimerDisclaimerListErrorFacetedMatchCountFeatureFeatureListGroupGroupListImmutableRoomAttributesIntegerListMemberInfoMembershipListMessageSuppressionResponseNameValuePairPasswordPodAppEntitlementPodAppEntitlementListPolicyPolicyListPresencePresenceListProductProductListRoomAttributesRoomCreateRoomDetailRoomSearchCriteriaRoomSearchResultsRoomSystemInfoRoomTagSessionInfoStreamStringIdStringListSuccessResponseUserUserAppEntitlementUserAppEntitlementListUserAttributesUserConnectionUserConnectionListUserConnectionRequestUserCreateUserDetailUserIdUserIdListUserPresenceUserStatusUserSystemInfoUserV2V2RoomAttributesV2RoomDetail
size
String The Avatar Size
url
String Url of the image
image
String Base64 encoded image. Original image must be less than 2MB.
overallResult
String
SUCCESS
FAIL
results
array[String]
name
String
attributes
array[NameValuePair]
pem
String An X509 certificate in PEM format
attributes
CompanyCertAttributes
name
String Friendly name assigned by administrator
type
CompanyCertType
status
CompanyCertStatus
companyCertAttributes
CompanyCertAttributes
companyCertInfo
CompanyCertInfo
certInfo
CertInfo
fingerPrint
String Unique identifier
issuerFingerPrint
String Unique identifier of issuer cert if known
lastSeen
Long Date when we last saw this certificate presented
updatedAt
Long Date when this cert was last updated by administrator
updatedBy
Long User ID of administrator who last updated this cert
commonName
String The Symphony account name which this certificate authenticates
expiryDate
Long Expiry date of this cert
companyCertAttributes
CompanyCertAttributes
companyCertInfo
CompanyCertInfo
type
String
TRUSTED
KNOWN
REVOKED
DISABLED
type
String
USERSIGNING
USER
OPERATIONSSIGNING
OPERATIONSUSER
userId
Long
action
String
ADD
REMOVE
id
String
name
String
content
String
frequencyInHours
Integer
isDefault
Boolean
isActive
Boolean
createdDate
Long
modifiedDate
Long
format
String
TEXT
XML
code
Integer
message
String
facet
String The matched query.
count
Integer The result count.
entitlment
String
enabled
Boolean Whether this entitlement is enabled for the user.
id
String
name
String
active
Boolean
memberCount
Integer
policies
array[String]
createdDate
Long
modifiedDate
Long
public
Boolean If true, this is a public chatroom. IF false, a private chatroom.
readOnly
Boolean If true, only stream owners can send messages.
copyProtected
Boolean If true, clients disable the clipboard copy for content in this stream.
id
Long
owner
Boolean
joinDate
Long
messageId
String
suppressed
Boolean
suppressionDate
Long The date when this message was suppressed.
hSalt
String Pod password salt used for PBKDF2 derivation.
hPassword
String Pod password derived with PBKDF2.
khSalt
String Key Manager password salt used for PBKDF2 derivation.
khPassword
String Key Manager password derived with PBKDF2.
appId
String Unique ID for the Application
appName
String Name for this Application
enable
Boolean
listed
Boolean if true, this application will be listed in the appstore for everyone. Otherwise, this application will be hidden in the appstore.
install
Boolean if true, the entitlement is set to automatic for the company. Otherwise, it is set to manual.
id
String
policyType
String
BLOCK
ALLOW
active
Boolean
memberCount
Integer
groups
array[String]
createdDate
Long
modifiedDate
Long
category
String
UNDEFINED
AVAILABLE
BUSY
DO_NOT_DISTURB
ON_THE_PHONE
BE_RIGHT_BACK
AWAY
OFFLINE
appId
String App ID for the Product
name
String Product Name
sku
String Product SKU
subscribed
Boolean indicate whether the product is subscribed or not
type
String Product Type (default or premium)
name
String Room name.
description
String Room description.
membersCanInvite
Boolean If true, any chatroom participant can add new participants. If false, only owners can add new participants.
discoverable
Boolean If true, this chatroom (name, description and messages) can be searched and listed by non-participants. If false, only participants can search this room.
roomAttributes
RoomAttributes
immutableRoomAttributes
ImmutableRoomAttributes
roomAttributes
RoomAttributes
roomSystemInfo
RoomSystemInfo
immutableRoomAttributes
ImmutableRoomAttributes
query
String The search query. Matches the room name and description.
labels
array[String] A list of room tag labels whose values will be queried.
active
Boolean Restrict the search to active/inactive rooms. If unspecified, search all rooms.
private
Boolean Restrict the search to private rooms. If unspecified, search all rooms.
owner
UserId Restrict the search to rooms owned by the specified user ID.
creator
UserId Restrict the search to rooms created by the specified user ID.
member
UserId Restrict the search to rooms having the specified user ID as member.
count
Long The total number of rooms matched by the search.
skip
Integer The number of skipped results.
limit
Integer The number of returned results.
query
RoomSearchCriteria The search query that produced this result.
rooms
array[V2RoomDetail] A list of rooms matched by the query.
facetedMatchCount
array[FacetedMatchCount] Detailed counts of matched rooms per search criterion.
id
String
creationDate
Long The datetime when the stream was originally created. Milliseconds since Jan 1 1970.
createdByUserId
Long
active
Boolean If false, no messages can be sent in this stream, and membership is locked.
key
String A unique label of the Tag.
value
String The value of this Tag's label.
format
String
TEXT
XML
message
String
id
Long
emailAddress
String
appId
String Unique ID for the Application
appName
String Name for this Application
listed
Boolean if true, this application will be listed in the appstore for this user. Otherwise, this application will be hidden in the appstore.
install
Boolean if true, it indicate this application is installed for this user. Otherwise, this user does not have this application installed.
products
ProductList
emailAddress
String
firstName
String
lastName
String
userName
String
displayName
String
department
String
division
String
title
String
workPhoneNumber
String
mobilePhoneNumber
String
smsNumber
String
accountType
String
NORMAL
SYSTEM
location
String
jobFunction
String
assetClasses
array[String]
industries
array[String]
userId
Long user id
status
String Connection status between the requesting user and the request sender
pending_incoming
pending_outgoing
accepted
rejected
firstRequestedAt
Long unix timestamp when the first request was made
updatedAt
Long unix timestamp on the last updated date
requestCounter
Integer number of requests made
userAttributes
UserAttributes
password
Password
roles
array[String]
userAttributes
UserAttributes
userSystemInfo
UserSystemInfo
features
IntegerList
apps
IntegerList
groups
IntegerList
roles
StringList
disclaimers
IntegerList
avatar
Avatar
uid
Long
category
String
UNDEFINED
AVAILABLE
BUSY
DO_NOT_DISTURB
ON_THE_PHONE
BE_RIGHT_BACK
AWAY
OFFLINE
status
String
ENABLED
DISABLED
id
Long
status
String
ENABLED
DISABLED
createdDate
Long
createdBy
String
lastUpdatedDate
Long
lastLoginDate
Long
lastPasswordReset
Long
id
Long
emailAddress
String
firstName
String
lastName
String
displayName
String
title
String
company
String
username
String
location
String
avatars
AvatarList avatar urls for both original size and small size
name
String Room name.
keywords
array[RoomTag] Keywords for search to use to find this room
description
String Room description.
membersCanInvite
Boolean If true, any chatroom participant can add new participants. If false, only owners can add new participants.
discoverable
Boolean If true, this chatroom (name, description and messages) can be searched and listed by non-participants. If false, only participants can search this room.
public
Boolean If true, this is a public chatroom. IF false, a private chatroom.
readOnly
Boolean If true, only stream owners can send messages.
copyProtected
Boolean If true, clients disable the clipboard copy for content in this stream.
roomAttributes
V2RoomAttributes
roomSystemInfo
RoomSystemInfo