From 973f74a50bd0335d842b968cfada995f87235243 Mon Sep 17 00:00:00 2001 From: jameshanna-symphony Date: Fri, 2 Oct 2026 09:30:00 +0100 Subject: [PATCH 01/10] BE-9865 add /v5/users/organisations --- users/users-api-public.yaml | 71 +++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/users/users-api-public.yaml b/users/users-api-public.yaml index 4e2a290..17fe4a6 100644 --- a/users/users-api-public.yaml +++ b/users/users-api-public.yaml @@ -133,6 +133,40 @@ paths: $ref: '#/components/responses/ServerError' '501': $ref: '#/components/responses/NotImplemented' + /v5/users/organisations: + get: + tags: + - Users + summary: Retrieve authenticated user's personal chat organization structures + description: Retrieves directories, workspaces, and blast distribution lists for the authenticated user. + operationId: getUserOrganisations + parameters: + - name: sessionToken + in: header + required: true + schema: + type: string + description: Session authentication token. + - name: appId + in: query + required: false + description: Application ID to retrieve organizational structure for, defaults to symphonyPrime. + schema: + type: string + default: symphonyPrime + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/UserOrganisationsResponse' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '500': + $ref: '#/components/responses/ServerError' components: responses: @@ -388,3 +422,40 @@ components: type: array items: $ref: '#/components/schemas/Sort' + UserOrganisationsResponse: + type: object + description: Aggregated personal organization structures for the authenticated user. + properties: + directories: + type: array + description: Custom directories/folders of conversation streams. + items: + $ref: '#/components/schemas/OrganisationStructure' + workspaces: + type: array + description: Multi-chat workspaces. + items: + $ref: '#/components/schemas/OrganisationStructure' + blastLists: + type: array + description: Blast distribution lists. + items: + $ref: '#/components/schemas/OrganisationStructure' + OrganisationStructure: + type: object + required: + - id + - name + - streamIds + properties: + id: + type: string + description: Unique identifier of the structure. + name: + type: string + description: Name of the structure. + streamIds: + type: array + description: Conversation stream IDs contained in this structure. + items: + type: string From 778c5350ff3ec772721efc91ced357540bf6ae2b Mon Sep 17 00:00:00 2001 From: jameshanna-symphony Date: Fri, 2 Oct 2026 09:45:46 +0100 Subject: [PATCH 02/10] Update users-api-public.yaml --- users/users-api-public.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/users/users-api-public.yaml b/users/users-api-public.yaml index 17fe4a6..cb92b91 100644 --- a/users/users-api-public.yaml +++ b/users/users-api-public.yaml @@ -136,7 +136,7 @@ paths: /v5/users/organisations: get: tags: - - Users + - UserOrganisations summary: Retrieve authenticated user's personal chat organization structures description: Retrieves directories, workspaces, and blast distribution lists for the authenticated user. operationId: getUserOrganisations From ac3d6e1b0b78df9fdb245ac3b6720c84affa0f61 Mon Sep 17 00:00:00 2001 From: jameshanna-symphony Date: Fri, 2 Oct 2026 10:07:21 +0100 Subject: [PATCH 03/10] Update users-api-public.yaml --- users/users-api-public.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/users/users-api-public.yaml b/users/users-api-public.yaml index cb92b91..134a13b 100644 --- a/users/users-api-public.yaml +++ b/users/users-api-public.yaml @@ -133,7 +133,7 @@ paths: $ref: '#/components/responses/ServerError' '501': $ref: '#/components/responses/NotImplemented' - /v5/users/organisations: + /v5/users/current/organisations: get: tags: - UserOrganisations From 5cac7a81044404f16a3730c18357817626df46bf Mon Sep 17 00:00:00 2001 From: jameshanna-symphony Date: Mon, 5 Oct 2026 16:39:15 +0100 Subject: [PATCH 04/10] Update users-api-public.yaml --- users/users-api-public.yaml | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/users/users-api-public.yaml b/users/users-api-public.yaml index 134a13b..c77841f 100644 --- a/users/users-api-public.yaml +++ b/users/users-api-public.yaml @@ -440,7 +440,7 @@ components: type: array description: Blast distribution lists. items: - $ref: '#/components/schemas/OrganisationStructure' + $ref: '#/components/schemas/BlastList' OrganisationStructure: type: object required: @@ -459,3 +459,33 @@ components: description: Conversation stream IDs contained in this structure. items: type: string + BlastList: + type: object + required: + - id + - name + - recipients + properties: + id: + type: string + description: Unique identifier of the blast distribution list. + name: + type: string + description: Name of the blast distribution list. + recipients: + type: array + description: Recipients of the blast list (users and streams). + items: + $ref: '#/components/schemas/BlastListRecipient' + BlastListRecipient: + type: object + required: + - id + - type + properties: + id: + type: string + description: Identifier of the recipient (user id or stream id). + type: + type: string + description: Recipient type, e.g. "user" or "stream". From 36c61fe29d1d378475a646339a5899f2d5400311 Mon Sep 17 00:00:00 2001 From: jameshanna-symphony Date: Thu, 8 Oct 2026 14:46:54 +0100 Subject: [PATCH 05/10] Update users-api-public.yaml --- users/users-api-public.yaml | 51 +++++++++++++++++++++---------------- 1 file changed, 29 insertions(+), 22 deletions(-) diff --git a/users/users-api-public.yaml b/users/users-api-public.yaml index c77841f..0f11615 100644 --- a/users/users-api-public.yaml +++ b/users/users-api-public.yaml @@ -12,6 +12,8 @@ servers: tags: - name: App Users description: App users and entitlements API + - name: ClientData + description: Client data API paths: /v1/groups/sdl/{groupId}: get: @@ -133,13 +135,13 @@ paths: $ref: '#/components/responses/ServerError' '501': $ref: '#/components/responses/NotImplemented' - /v5/users/current/organisations: + /v5/users/clientdata: get: tags: - - UserOrganisations - summary: Retrieve authenticated user's personal chat organization structures - description: Retrieves directories, workspaces, and blast distribution lists for the authenticated user. - operationId: getUserOrganisations + - ClientData + summary: Retrieve authenticated user's client data + description: Retrieves folders, workspaces, and distribution lists for the authenticated user. + operationId: getClientData parameters: - name: sessionToken in: header @@ -150,7 +152,7 @@ paths: - name: appId in: query required: false - description: Application ID to retrieve organizational structure for, defaults to symphonyPrime. + description: Application ID to retrieve client data for, defaults to symphonyPrime. schema: type: string default: symphonyPrime @@ -160,7 +162,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UserOrganisationsResponse' + $ref: '#/components/schemas/ClientDataResponse' '401': $ref: '#/components/responses/Unauthorized' '403': @@ -422,13 +424,13 @@ components: type: array items: $ref: '#/components/schemas/Sort' - UserOrganisationsResponse: + ClientDataResponse: type: object - description: Aggregated personal organization structures for the authenticated user. + description: Aggregated client data for the authenticated user. properties: - directories: + folders: type: array - description: Custom directories/folders of conversation streams. + description: Custom folders of conversation streams. items: $ref: '#/components/schemas/OrganisationStructure' workspaces: @@ -436,11 +438,11 @@ components: description: Multi-chat workspaces. items: $ref: '#/components/schemas/OrganisationStructure' - blastLists: + distributionLists: type: array - description: Blast distribution lists. + description: Distribution lists. items: - $ref: '#/components/schemas/BlastList' + $ref: '#/components/schemas/DistributionLists' OrganisationStructure: type: object required: @@ -459,7 +461,7 @@ components: description: Conversation stream IDs contained in this structure. items: type: string - BlastList: + DistributionLists: type: object required: - id @@ -468,16 +470,16 @@ components: properties: id: type: string - description: Unique identifier of the blast distribution list. + description: Unique identifier of the distribution list. name: type: string - description: Name of the blast distribution list. + description: Name of the distribution list. recipients: type: array - description: Recipients of the blast list (users and streams). + description: Recipients of the distribution list (users and streams). items: - $ref: '#/components/schemas/BlastListRecipient' - BlastListRecipient: + $ref: '#/components/schemas/DistributionListRecipient' + DistributionListRecipient: type: object required: - id @@ -485,7 +487,12 @@ components: properties: id: type: string - description: Identifier of the recipient (user id or stream id). + description: Identifier of the recipient (user id, stream id, or folder id). type: type: string - description: Recipient type, e.g. "user" or "stream". + description: Recipient type, e.g. "user", "stream", or "folder". + streamIds: + type: array + items: + type: string + description: List of stream IDs contained in the folder (populated when type is "folder"). From 13dc4bdfa3a6f7deca0f063cb7695995e5d96476 Mon Sep 17 00:00:00 2001 From: jameshanna-symphony Date: Thu, 8 Oct 2026 15:42:35 +0100 Subject: [PATCH 06/10] Update users-api-public.yaml --- users/users-api-public.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/users/users-api-public.yaml b/users/users-api-public.yaml index 0f11615..fe0073d 100644 --- a/users/users-api-public.yaml +++ b/users/users-api-public.yaml @@ -432,18 +432,18 @@ components: type: array description: Custom folders of conversation streams. items: - $ref: '#/components/schemas/OrganisationStructure' + $ref: '#/components/schemas/ClientDataStructure' workspaces: type: array description: Multi-chat workspaces. items: - $ref: '#/components/schemas/OrganisationStructure' + $ref: '#/components/schemas/ClientDataStructure' distributionLists: type: array description: Distribution lists. items: $ref: '#/components/schemas/DistributionLists' - OrganisationStructure: + ClientDataStructure: type: object required: - id From 4888d5313d681a1d62d913fda4230f595964d3c4 Mon Sep 17 00:00:00 2001 From: jameshanna-symphony Date: Tue, 13 Oct 2026 16:44:33 +0100 Subject: [PATCH 07/10] Update users-api-public.yaml --- users/users-api-public.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/users/users-api-public.yaml b/users/users-api-public.yaml index fe0073d..f679abe 100644 --- a/users/users-api-public.yaml +++ b/users/users-api-public.yaml @@ -491,6 +491,9 @@ components: type: type: string description: Recipient type, e.g. "user", "stream", or "folder". + name: + type: string + description: Display name of the recipient (populated with prettyName when type is "user"). streamIds: type: array items: From cd03cd9d6d3f09d34a3bcc614e0ea773e39396e6 Mon Sep 17 00:00:00 2001 From: jameshanna-symphony Date: Thu, 15 Oct 2026 15:20:07 +0100 Subject: [PATCH 08/10] Update users-api-public.yaml --- users/users-api-public.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/users/users-api-public.yaml b/users/users-api-public.yaml index f679abe..eee63d9 100644 --- a/users/users-api-public.yaml +++ b/users/users-api-public.yaml @@ -135,7 +135,7 @@ paths: $ref: '#/components/responses/ServerError' '501': $ref: '#/components/responses/NotImplemented' - /v5/users/clientdata: + /v5/users/current/clientdata: get: tags: - ClientData @@ -167,6 +167,8 @@ paths: $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' + '404': + description: Client data not found '500': $ref: '#/components/responses/ServerError' From 955f2c2b686b08de60094ee641cdec5dfad86a59 Mon Sep 17 00:00:00 2001 From: jameshanna-symphony Date: Tue, 20 Oct 2026 16:10:31 +0100 Subject: [PATCH 09/10] Update users-api-public.yaml --- users/users-api-public.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/users/users-api-public.yaml b/users/users-api-public.yaml index 1adb37e..67f1050 100644 --- a/users/users-api-public.yaml +++ b/users/users-api-public.yaml @@ -139,7 +139,7 @@ paths: $ref: '#/components/responses/ServerError' '501': $ref: '#/components/responses/NotImplemented' - /v5/users/clientdata: + /v5/users/current/clientdata: get: tags: - ClientData @@ -171,6 +171,8 @@ paths: $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' + '404': + description: Client data not found '500': $ref: '#/components/responses/ServerError' /v5/users: From 6974c4c2c9c346889cbfd5660e44180e43c2af9f Mon Sep 17 00:00:00 2001 From: jameshanna-symphony Date: Tue, 20 Oct 2026 16:14:20 +0100 Subject: [PATCH 10/10] Update users-api-public.yaml --- users/users-api-public.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/users/users-api-public.yaml b/users/users-api-public.yaml index 67f1050..5af13c9 100644 --- a/users/users-api-public.yaml +++ b/users/users-api-public.yaml @@ -3,7 +3,7 @@ info: title: SBE Users API description: |- Users related API - version: 5.3.0 + version: 5.4.0 externalDocs: description: Overall Symphony public API url: https://rest-api.symphony.com/