openapi: 3.0.1 info: title: Agent Admin User API description: 'This document refers to Symphony API calls to send and receive messages and content. They need the on-premise Agent installed to perform decryption/encryption of content. - sessionToken and keyManagerToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be atomic, ie will succeed in their entirety or fail and have changed nothing. - If it returns a 40X status then it will have sent no message to any stream even if a request to some subset of the requested streams would have succeeded. - If this contract cannot be met for any reason then this is an error and the response code will be 50X. - MessageML is a markup language for messages. See reference here: https://rest-api.symphony.com/docs/messagemlv2 - **Real Time Events**: The following events are returned when reading from a real time messages and events stream ("datafeed"). These events will be returned for datafeeds created with the v5 endpoints. To know more about the endpoints, refer to Create Messages/Events Stream and Read Messages/Events Stream. Unless otherwise specified, all events were added in 1.46. ' version: 25.8.1 servers: - url: youragentURL.symphony.com/agent tags: - name: User paths: /v2/admin/user/list: get: summary: Retrieve a list of all users in the company (pod) consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session Authentication token. in: header required: true type: string - name: skip description: Number of users to skip. Default is 0. Must be a integer equals or bigger than 0. in: query type: integer required: false - name: limit description: Maximum number of users to return. Default is 100. Must be a positive integer and must not exceed 1000. in: query type: integer required: false tags: - User responses: '200': description: Success schema: $ref: '#/definitions/V2UserDetailList' examples: application/json: - userAttributes: emailAddress: nexus.user@email.com userName: nexus.user displayName: nexus.user accountType: SYSTEM userSystemInfo: id: 9826885173290 status: ENABLED suspended: false createdDate: 1499375475000 createdBy: '9826885173255' lastUpdatedDate: 1499375475852 lastLoginDate: 1504899124191 roles: - USER_PROVISIONING - CONTENT_MANAGEMENT - INDIVIDUAL - userAttributes: emailAddress: admin@mail.com firstName: admin lastName: admin userName: admin@mail.com displayName: Admin Admin companyName: Company Name department: Departament division: Division title: Administrator twoFactorAuthPhone: '+15419999999' workPhoneNumber: '+15419999999' mobilePhoneNumber: '+15419999999' accountType: NORMAL assetClasses: - Currencies industries: - Technology userSystemInfo: id: 7696581394433 status: ENABLED suspended: false createdDate: 1438054194000 lastUpdatedDate: 1527532171729 lastLoginDate: 1523912043015 roles: - SUPER_COMPLIANCE_OFFICER - INDIVIDUAL - SUPER_ADMINISTRATOR '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/find: post: summary: Find a user based on attributes consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: skip description: Number of users to skip. Default is 0. Must be a integer equals or bigger than 0. in: query type: integer required: false - name: limit description: Maximum number of users to return. Default is 100. Must be a positive integer and must not exceed 1000. in: query type: integer required: false - name: payload in: body required: true schema: $ref: '#/definitions/UserFilter' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/UserDetailList' examples: application/json: - userAttributes: emailAddress: janedoe@symphony.com firstName: Jane lastName: Doe userName: jane.doe displayName: Jane Doe accountType: NORMAL assetClasses: - Commodities industries: - Financials - Healthcare userSystemInfo: id: 9826885173258 status: ENABLED suspended: true suspensionReason: The user will be OOO due to a mandatory leave suspendedUntil: 1601546400 createdDate: 1499347606000 createdBy: '9826885173252' lastUpdatedDate: 1499348554853 lastLoginDate: 1504839044527 roles: - INDIVIDUAL - userAttributes: emailAddress: nexus.user@email.com userName: nexus.user displayName: nexus.user accountType: SYSTEM userSystemInfo: id: 9826885173290 status: ENABLED suspended: false createdDate: 1499375475000 createdBy: '9826885173255' lastUpdatedDate: 1499375475852 lastLoginDate: 1504899124191 roles: - USER_PROVISIONING - CONTENT_MANAGEMENT - INDIVIDUAL '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/roles/add: post: summary: Add a role to a user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 - name: payload in: body required: true schema: $ref: '#/definitions/StringId' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' examples: application/json: format: TEXT message: Role added '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/roles/remove: post: summary: Remove a role from a user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 - name: payload in: body required: true schema: $ref: '#/definitions/StringId' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' examples: application/json: format: TEXT message: Role removed '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '404': description: 'Not Found: User cannot be found.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: // Not Found. User cannot be found. See response body for fruther details. '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/avatar: get: summary: Get the URL of the avatar of a particular user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 tags: - User responses: '200': description: Success schema: $ref: '#/definitions/AvatarList' examples: application/json: - size: original url: ../avatars/izcQTdRVFOK_qhCrYeQOpIuHKuZuMk3J88Uz_bShzM8.png - size: small url: ../avatars/izcQTdRVFOK_qhCrYeQOpIuHKuZuMk3J88Uz_bShzM8_small.png '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/avatar/update: post: summary: Update the avatar of a particular user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 - name: payload in: body required: true schema: $ref: '#/definitions/AvatarUpdate' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' examples: application/json: format: TEXT message: OK '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/disclaimer: get: summary: Get the disclaimer assigned to a user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 tags: - User responses: '200': description: Success schema: $ref: '#/definitions/Disclaimer' examples: application/json: id: 571d2052e4b042aaf06d2e7a name: Enterprise Disclaimer content: This is a disclaimer for the enterprise. frequencyInHours: 24 isDefault: false isActive: true createdDate: 1461526610846 modifiedDate: 1461526610846 '204': description: No content. User doesn't have an assigned disclaimer '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. delete: summary: Unassign a disclaimer from a user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' examples: application/json: format: TEXT message: OK '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/disclaimer/update: post: summary: Assign a disclaimer to a user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 - name: payload in: body required: true schema: $ref: '#/definitions/StringId' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' examples: application/json: format: TEXT message: OK '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/delegates: get: summary: Get the delegates assigned to a user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 tags: - User responses: '200': description: The userid's of the delegates of this user. schema: $ref: '#/definitions/IntegerList' examples: application/json: - 7215545078461 '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/delegates/update: post: summary: Update the delegates assigned to a user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 - name: payload in: body required: true schema: $ref: '#/definitions/DelegateAction' tags: - User responses: '200': description: Sucesss. schema: $ref: '#/definitions/SuccessResponse' examples: application/json: format: TEXT message: Added delegate [7215545078461] for account [7215545078541] '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/features: get: summary: Get the list of Symphony feature entitlements enabled for a particular user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 tags: - User responses: '200': description: Success schema: $ref: '#/definitions/FeatureList' examples: application/json: - entitlment: canCreatePublicRoom enabled: true - entitlment: isExternalRoomEnabled enabled: false - entitlment: delegatesEnabled enabled: true - entitlment: isExternalIMEnabled enabled: true - entitlment: sendFilesEnabled enabled: true - entitlment: canUpdateAvatar enabled: true '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/features/update: post: summary: Update the list of Symphony feature entitlements for a particular user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 - name: payload in: body required: true schema: $ref: '#/definitions/FeatureList' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' examples: application/json: format: TEXT message: OK '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/user/{uid}/follow: post: summary: Make a list of users start following a specific user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: User ID as a decimal integer of the user to be followed in: path required: true type: integer format: int64 - name: uidList description: List of (integer) User IDs of the followers in: body required: true schema: $ref: '#/definitions/FollowersList' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' examples: application/json: format: TEXT message: User(s) successfully added in the list of followers '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/user/{uid}/unfollow: post: summary: Make a list of users unfollowing a specific user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: User ID as a decimal integer of the user to be unfollowed in: path required: true type: integer format: int64 - name: uidList description: List of (integer) User IDs of the followers in: body required: true schema: $ref: '#/definitions/FollowersList' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' examples: application/json: format: TEXT message: User(s) successfully removed from the list of followers '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/user/{uid}/followers: get: summary: Returns the list of followers for a specific user produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: User ID as a decimal integer of the user we want to get the followers list in: path required: true type: integer format: int64 - name: limit description: This is the maximum number of objects that may be returned. in: query required: false type: integer - name: before description: Returns results from an opaque “before” cursor value as presented via a response cursor. in: query required: false type: string - name: after description: Returns results from an opaque “after” cursor value as presented via a response cursor. in: query required: false type: string tags: - User responses: '200': description: Success schema: $ref: '#/definitions/FollowersListResponse' examples: application/json: count: 5 followers: - 13056700579848 - 13056700580889 - 13056700580890 pagination: cursors: before: 1 after: 4 '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/user/{uid}/following: get: summary: Returns the list of users that a specific user is following produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: User ID as a decimal integer of the user we want to get the following list in: path required: true type: integer format: int64 - name: limit description: This is the maximum number of objects that may be returned. in: query required: false type: integer - name: before description: Returns results from an opaque “before” cursor value as presented via a response cursor. in: query required: false type: string - name: after description: Returns results from an opaque “after” cursor value as presented via a response cursor. in: query required: false type: string tags: - User responses: '200': description: Success schema: $ref: '#/definitions/FollowingListResponse' examples: application/json: count: 3 followers: - 13056700580888 - 13056700580889 pagination: cursors: before: 1 '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/user/manifest/own: post: summary: Update own service account manifest produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: manifest description: Service Account Manifest to put in user account in: body required: true schema: $ref: '#/definitions/ServiceAccountManifest' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. get: summary: Get own service account manifest produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string tags: - User responses: '200': description: Success schema: $ref: '#/definitions/ServiceAccountManifest' '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/status: get: summary: Get the status, active or inactive, for a particular user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 tags: - User responses: '200': description: Success schema: $ref: '#/definitions/UserStatus' examples: application/json: status: ENABLED '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{uid}/status/update: post: summary: Update the status of a particular user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 - name: payload in: body required: true schema: $ref: '#/definitions/UserStatus' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' examples: application/json: message: OK '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/system/roles/list: get: summary: Get a list of all roles available in the company (pod) consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string tags: - User responses: '200': description: Success schema: $ref: '#/definitions/RoleDetailList' examples: application/json: - id: CONTENT_MANAGEMENT name: Content Management userTypes: - SYSTEM - NORMAL optionalActions: - MONITOR_ROOMS - id: COMPLIANCE_OFFICER name: Compliance Officer userTypes: - NORMAL optionalActions: - BAN_AND_UNBAN_ROOM_MEMBER - LOCK_AND_UNLOCK_ROOM - MONITOR_ROOMS - MONITOR_WALL_POSTS '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v2/admin/user/create: post: summary: Create a new V2 User consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: payload in: body required: true schema: $ref: '#/definitions/V2UserCreate' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/V2UserDetail' examples: application/json: userAttributes: emailAddress: johndoe@symphony.com firstName: John lastName: Doe userName: johndoe displayName: John Doe companyName: Company department: Departament division: Division title: Junior Trader twoFactorAuthPhone: '+15419999999' workPhoneNumber: '+15419999999' mobilePhoneNumber: '+15419999999' accountType: NORMAL location: New York jobFunction: Trader assetClasses: - Equities industries: - Healthcare - Technology userSystemInfo: id: 7215545078461 status: ENABLED suspended: true suspensionReason: The user will be OOO due to a mandatory leave suspendedUntil: 1601546400 createdDate: 1461508270000 createdBy: '7215545057281' lastUpdatedDate: 1461508270000 lastLoginDate: 1461508270000 deactivatedDate: 1461508270000 roles: - INDIVIDUAL '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v2/admin/user/{uid}/update: post: summary: Update an existing V2 User consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 - name: payload in: body required: true schema: $ref: '#/definitions/V2UserAttributes' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/V2UserDetail' examples: application/json: userAttributes: emailAddress: johndoe@symphony.com firstName: John lastName: Doe userName: johndoe displayName: John Doe companyName: Company department: Departament division: Division title: Junior Trader twoFactorAuthPhone: '+15419999999' workPhoneNumber: '+15419999999' mobilePhoneNumber: '+15419999999' accountType: NORMAL location: New York jobFunction: Trader assetClasses: - Equities industries: - Healthcare - Technology userSystemInfo: id: 7215545078461 status: ENABLED suspended: true suspensionReason: The user will be OOO due to a mandatory leave suspendedUntil: 1601546400 createdDate: 1461508270000 createdBy: '7215545057281' lastUpdatedDate: 1461508270000 lastLoginDate: 1461508270000 deactivatedDate: 1461508270000 roles: - INDIVIDUAL '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v2/admin/user/{uid}: get: summary: Retrieve V2 User details for a particular user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token. in: header required: true type: string - name: uid description: 'User ID as a decimal integer ' in: path required: true type: integer format: int64 tags: - User responses: '200': description: Success schema: $ref: '#/definitions/V2UserDetail' examples: application/json: userAttributes: emailAddress: johndoe@symphony.com firstName: John lastName: Doe userName: johndoe displayName: John Doe companyName: Company department: Departament division: Division title: Junior Trader twoFactorAuthPhone: '+15419999999' workPhoneNumber: '+15419999999' mobilePhoneNumber: '+15419999999' accountType: NORMAL location: New York jobFunction: Trader assetClasses: - Equities industries: - Healthcare - Technology userSystemInfo: id: 7215545078461 status: ENABLED suspended: true suspensionReason: The user will be OOO due to a mandatory leave suspendedUntil: 1601546400 createdDate: 1461508270000 createdBy: '7215545057281' lastUpdatedDate: 1461508270000 lastLoginDate: 1461508270000 deactivatedDate: 1461508270000 roles: - INDIVIDUAL '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. /v1/admin/user/{userId}/suspension/update: put: summary: Update the status of suspension of a particular user consumes: - application/json produces: - application/json parameters: - name: sessionToken description: Session authentication token in: header required: true type: string - name: userId description: User ID as a decimal integer in: path required: true type: integer format: int64 - name: payload in: body required: true schema: $ref: '#/definitions/UserSuspension' tags: - User responses: '200': description: Success schema: $ref: '#/definitions/SuccessResponse' examples: application/json: format: TEXT message: User suspended with success '400': description: Client error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 400 message: // Client error, see response body for further details. '401': description: 'Unauthorized: Invalid session token.' schema: $ref: '#/definitions/Error' examples: application/json: code: 401 message: Invalid session '403': description: 'Forbidden: Caller lacks necessary entitlement.' schema: $ref: '#/definitions/Error' examples: application/json: code: 403 message: The user lacks the required entitlement to perform this operation '500': description: Server error, see response body for further details. schema: $ref: '#/definitions/Error' examples: application/json: code: 500 message: // Server error, see response body for further details. definitions: UserIdList: type: array items: type: integer format: int64 example: - 7215545058313 - 7215545078461 Password: description: Password. Stored as derived password in both the Pod and the Key Manager using PBKDF2 function. Number of iterations should be 10000 and desired length 256 bits. type: object properties: hSalt: description: Pod password salt used for PBKDF2 derivation. type: string example: hsalt hPassword: description: Pod password derived with PBKDF2. type: string example: hpassword khSalt: description: Key Manager password salt used for PBKDF2 derivation. type: string example: khsalt khPassword: description: Key Manager password derived with PBKDF2. type: string example: khpassword V2UserAttributes: description: V2 User record. type: object properties: emailAddress: type: string example: johndoe@symphony.com firstName: type: string example: John lastName: type: string example: Doe userName: type: string example: johndoe displayName: type: string example: John Doe companyName: type: string example: Company department: type: string example: Department division: type: string example: Division title: type: string example: Trader workPhoneNumber: type: string example: '+15419999999' mobilePhoneNumber: type: string example: '+15419999999' twoFactorAuthPhone: type: string example: '+15419999999' smsNumber: type: string example: '+15419999999' accountType: type: string enum: - NORMAL - SYSTEM - SDL example: NORMAL location: type: string example: New York recommendedLanguage: type: string example: english jobFunction: type: string example: Trader assetClasses: type: array items: type: string example: - Equities industries: type: array items: type: string example: - Healthcare - Technology marketCoverage: type: array items: type: string example: - EMEA responsibility: type: array items: type: string example: - BAU function: type: array items: type: string example: - Trade Processing instrument: type: array items: type: string example: - Equities currentKey: $ref: '#/definitions/V2UserKeyRequest' previousKey: $ref: '#/definitions/V2UserKeyRequest' userMetadata: type: object description: Metadata map of key/values additionalProperties: type: object example: com_symphony_metadataKey1: value com_symphony_metadataKey2: - value1 - value2 AvatarList: type: array items: $ref: '#/definitions/Avatar' example: - size: original url: ../avatars/izcQTdRVFOK_qhCrYeQOpIuHKuZuMk3J88Uz_bShzM8.png - size: small url: ../avatars/izcQTdRVFOK_qhCrYeQOpIuHKuZuMk3J88Uz_bShzM8_small.png V2UserCreate: description: 'V2 User Creation Object. After creation, modify roles, features etc via the specific API calls. ' type: object properties: userAttributes: $ref: '#/definitions/V2UserAttributes' password: $ref: '#/definitions/Password' roles: type: array items: type: string example: - INDIVIDUAL - COMPLIANCE_OFFICER RoleDetailList: type: array items: $ref: '#/definitions/RoleDetail' example: - id: CONTENT_MANAGEMENT name: Content Management userTypes: - SYSTEM - NORMAL optionalActions: - MONITOR_ROOMS - id: COMPLIANCE_OFFICER name: Compliance Officer userTypes: - NORMAL optionalActions: - BAN_AND_UNBAN_ROOM_MEMBER - LOCK_AND_UNLOCK_ROOM - MONITOR_ROOMS - MONITOR_WALL_POSTS UserAttributes: description: User record. type: object properties: emailAddress: type: string example: janedoe@symphony.com firstName: type: string example: Jane lastName: type: string example: Doe userName: type: string example: jane.doe displayName: type: string example: Jane Doe companyName: type: string example: Company department: type: string example: Department division: type: string example: Division title: type: string example: Trader workPhoneNumber: type: string example: '+12349999999' mobilePhoneNumber: type: string example: '+12349999999' smsNumber: type: string example: '+12349999999' accountType: type: string enum: - NORMAL - SYSTEM - SDL example: NORMAL location: type: string example: New York jobFunction: type: string example: Trader assetClasses: type: array items: type: string example: - Commodities industries: type: array items: type: string example: - Financials - Services StringList: type: array items: type: string example: - ftp - mailto - fdsup - skype UserSystemInfo: description: User Status Information. type: object properties: id: type: integer format: int64 example: 7215545078461 status: type: string enum: - ENABLED - DISABLED example: ENABLED suspended: type: boolean description: An optional attribute indicating whether the user is temporarily suspended or not. Since SBE 20.14. x-since: 20.14 example: true suspendedUntil: type: integer format: int64 description: An optional unix timestamp until which the suspension is effective. Since SBE 20.14. x-since: 20.14 example: 1601546400 suspensionReason: type: string description: An optional description of the suspension reason. Since SBE 20.14. x-since: 20.14 example: The user will be OOO due to a mandatory leave createdDate: type: integer format: int64 example: 1461508270000 createdBy: type: string example: '7215545057281' lastUpdatedDate: type: integer format: int64 example: 1461508270000 lastLoginDate: type: integer format: int64 example: 1461508270000 lastPasswordReset: type: integer format: int64 example: 1461508270000 deactivatedDate: type: integer format: int64 example: 1461508270000 Feature: description: Entitlement feature record. type: object properties: entitlment: type: string example: canCreatePublicRoom enabled: type: boolean description: Whether this entitlement is enabled for the user. example: true UserDetail: description: Detailed User record. type: object properties: userAttributes: $ref: '#/definitions/UserAttributes' userSystemInfo: $ref: '#/definitions/UserSystemInfo' features: $ref: '#/definitions/IntegerList' apps: $ref: '#/definitions/IntegerList' groups: $ref: '#/definitions/IntegerList' roles: $ref: '#/definitions/StringList' disclaimers: $ref: '#/definitions/IntegerList' avatar: $ref: '#/definitions/Avatar' Avatar: type: object properties: size: description: The Avatar Size type: string example: original url: description: Url of the image type: string example: ../avatars/izcQTdRVFOK_qhCrYeQOpIuHKuZuMk3J88Uz_bShzM8.png AvatarUpdate: type: object properties: image: description: Base64 encoded image. Original image must be less than 2MB. type: string example: iVBORw0KGgoAAAANSUhEUgAAAJgAAAAoCAMAAAA11sNmAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAX1QTFRFAAAAVVVVZmZmc8bmd3d3jMyMmZmZ+cxA////VVVVZmZmc8bmd3d3jMyM8oCZ+cxA////VVVVZmZmc8bmd3d3jMyM////VVVVZmZmc8bmd3d3jMyMmZmZ8oCZ+cxA////ZmZmjMyM////VVVVd3d3jMyM+cxA////VVVVZmZmc8bmd3d3jMyMmZmZnMyB8oCZ+cxA////ZmZmc8bmd3d3jMyMmZmZ+cxA////d3d3jMyM8oCZ+cxA////VVVVZmZmdm1RjMyM8oCZ+cxA////ZmZmmZmZ+cxA////W1tbZmZmc8bmdpGcd3d3jMyMmZmZ8oCZ////d3d3jMyMmZmZx3iJ+cxA////VVVVZmZmc8bmd3d3jMyMuIOVyqpG////VVVVZmZmbW1td3d3jMyMmZmZ+cxA////VVVVX1xUZmZmb46ac8bmdZ+vd3d3fnNQjMyMkpeGlqaWmJyYmZmZnYlMp5FLsZhJvJ9Iz3qM0K5F78VB8oCZ+cxA////9laq9wAAAGh0Uk5TABAQEBAQEBAQICAgICAgICAwMDAwMDBAQEBAQEBAQEBQUFBgYGBgYHBwcHBwcHBwcHCAgICAgICAj4+Pj4+fn5+fn5+fr6+vr7+/v7+/v7+/v8/Pz8/Pz9/f39/f39/f7+/v7+/v7+/qia/hAAADQ0lEQVRYw+2Xa1fTQBCGV0WJCBIvxEq10YoEVNQoaLxURKNWUHRRqYgaUSC1QkWsNzT7252Z3W1TWpCjX+I5fT/ksrM782T2Tc4JYy211NL/oJ50Ot2TRLD5FdTkma6kgU2uSB1PGtiY5HqZuK0ckWAjiQNLS7CdiQPrIq6xpGHtGnr0eRXA0gnjGlqoVCoA9kTe9rfXQob1r8ntv1mUmjlGYBUJdhJv2u9FlzWVHwohAt9kBuc+Dfk8zxjnWRnn3GHM4lKuAUM5nsMIjNETOQVM4NJstQpCzKxL10TjpdJ4B5zvEtg8Wj+zGEVRtwxjVpLFckIAA8sKAVWECBGCeUJ40BI9qwCDXHBqkxDYKT8WwVWWDDFMh5QOpWtURwk0dwE8toBgV2HoeoQ6T2GL6rJsAZ7OCBAGjgUqIbAvptBgNggo/XVgMJQ3mZmHk1wVGArMCPEajrxpwwZLpJkUO4JgXax7mriiaaay1xyWRQhPjsgmAoQGk9uCVeJg1bo+TafW6enxdI26U1Ia3X6psjrJ+hcjJQpjRwLOPYf2DZ7blp2iEhxz14FxCRZ4IB/BbLlflMjDVQVsqprOKZ3HNrKY0tzg09Wzt4Ho59r3NThlKO6E0iLkDTNUe4EloLAb4FGCIUuebrg2HIB5ihgXEJgNZI4Ci6XbDKxUevvp9bcvH98Xi8WvVTAo6no5yBbgtSt0B6AEAoRGM/PXOuZUd0qDgUeFxnWFfEGaaX8q9eyH0qsP998USTczmUx7/BPkqlSByOs6NrwY8EJpMPxa+E51P5XHTL1VLj0RDlm0B6w+XVPd+kV6fHRieWrbwHMEO6FjDr5TMTCuLYElctjGOo+x9WC4r0hrh9RyGsrWwPhGDiOdk1js4tJy+Qpjh24Ui/t0LIceJ/PkG8GM0P4jGPqogFYILQ2GxtsS2F7CYoeXAKzcCwO7B2rBrPrCcqMRrOadjcHgCy/NZ8VW+VsDY9cAi+14QWDv2tZHLcfzXP2tsWxTvRK2oS9gxLBjHrZsmm3oKZbreVbdqur0arpNtGeCwMoPk/czcuDUAwArn07gf9IwgpUPJhVsqi2hYLOdiQSb7Uugx3qH+zpZSy211FJNvwFNoXAncdBvawAAAABJRU5ErkJggg== RoleDetail: description: Role detailed. type: object properties: id: type: string example: CONTENT_MANAGEMENT name: type: string example: Content Management userTypes: type: array items: type: string example: - NORMAL - SYSTEM optionalActions: type: array items: type: string example: - MONITOR_ROOMS - MONITOR_WALL_POSTS ServiceAccountManifest: type: object properties: manifest: type: string maxLength: 6144 description: Manifest containing commands supported by the service account. Must be valid JSON. required: - manifest FollowersList: type: object properties: followers: $ref: '#/definitions/UserIdList' V2UserDetail: description: V2 Detailed User record. type: object properties: userAttributes: $ref: '#/definitions/V2UserAttributes' userSystemInfo: $ref: '#/definitions/UserSystemInfo' features: $ref: '#/definitions/IntegerList' apps: $ref: '#/definitions/IntegerList' groups: $ref: '#/definitions/IntegerList' roles: $ref: '#/definitions/StringList' disclaimers: $ref: '#/definitions/IntegerList' avatar: $ref: '#/definitions/Avatar' V2UserDetailList: type: array items: $ref: '#/definitions/V2UserDetail' example: - userAttributes: emailAddress: nexus.user@email.com userName: nexus.user displayName: nexus.user accountType: SYSTEM userSystemInfo: id: 9826885173290 status: ENABLED suspended: false createdDate: 1499375475000 createdBy: '9826885173255' lastUpdatedDate: 1499375475852 lastLoginDate: 1504899124191 roles: - USER_PROVISIONING - CONTENT_MANAGEMENT - INDIVIDUAL - userAttributes: emailAddress: admin@mail.com firstName: admin lastName: admin userName: admin@mail.com displayName: Admin Admin companyName: Company Name department: Departament division: Division title: Administrator twoFactorAuthPhone: '+15419999999' workPhoneNumber: '+15419999999' mobilePhoneNumber: '+15419999999' accountType: NORMAL assetClasses: - Currencies industries: - Technology userSystemInfo: id: 7696581394433 status: ENABLED suspended: false createdDate: 1438054194000 lastUpdatedDate: 1527532171729 lastLoginDate: 1523912043015 roles: - SUPER_COMPLIANCE_OFFICER - INDIVIDUAL - SUPER_ADMINISTRATOR FollowingListResponse: type: object properties: count: type: integer format: int64 example: 2 following: type: array items: type: integer format: int64 example: - 13056700579848 - 13056700580889 pagination: $ref: '#/definitions/Pagination' FollowersListResponse: type: object properties: count: type: integer format: int64 example: 2 followers: type: array items: type: integer format: int64 example: - 13056700579848 - 13056700580889 pagination: $ref: '#/definitions/Pagination' Disclaimer: type: object properties: id: type: string example: 571d20dae4b042aaf06d2e7c name: type: string example: New Enterprise Disclaimer content: type: string example: This is a second enterprise disclaimer. frequencyInHours: type: integer format: int32 example: 168 isDefault: type: boolean example: false isActive: type: boolean example: true createdDate: type: integer format: int64 example: 1461526746875 modifiedDate: type: integer format: int64 example: 1461526746875 format: type: string enum: - TEXT - XML example: TEXT V2UserKeyRequest: description: User RSA key information. type: object properties: key: description: User RSA public key. type: string example: '-----BEGIN PUBLIC KEY-----\nMIICIANBgkqhw0BAQ...cCAwEAAQ==\n-----END PUBLIC KEY-----' expirationDate: description: RSA key expiration date. This value is set just for rotated keys. type: integer format: int64 example: 1467562406219 action: description: "Action to be performed on the RSA key.\nThe following actions can be performed onto the user's active RSA key:\n - SAVE\n - REVOKE\nThe following actions can be performed onto the user's rotated RSA key:\n - REVOKE\n - EXTEND\n" type: string example: SAVE StringId: type: object properties: id: type: string example: xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA UserSuspension: type: object properties: suspended: type: boolean example: true suspendedUntil: type: integer format: int64 example: 1601546400 suspensionReason: type: string example: The user will be OOO due to a mandatory leave Pagination: type: object required: - cursors properties: cursors: type: object required: - before properties: before: type: string description: 'This is the opaque url-safe string that points to the start of the page of data that has been returned. ' example: MTAxNTExOTQ1MjAwNzI5NDE= after: type: string description: 'This is the opaque url-safe string that points to the end of the page of data that has been returned. ' example: NDMyNzQyODI3OTQw previous: type: string description: 'API endpoint that will return the previous page of data. If not included, this is the first page of data. ' example: https://tenantapi.d.isym.io/v1/tenantinfo?limit=25&before=MTAxNTExOTQ1MjAwNzI5NDE= next: type: string description: 'API endpoint that will return the next page of data. If not included, this is the last page of data. Due to how pagination works with visibility and privacy, it is possible that a page may be empty but contain a ''next'' paging link. Stop paging when the ''next'' link no longer appears. ' example: https://tenantapi.d.isym.io/v1/tenantinfo?limit=25&after=NDMyNzQyODI3OTQw UserStatus: type: object properties: status: type: string enum: - ENABLED - DISABLED example: ENABLED suspended: type: boolean description: An optional attribute indicating whether the user is temporarily suspended or not. Since SBE 20.14. x-since: 20.14 example: true suspendedUntil: type: integer format: int64 description: An optional unix timestamp until which the suspension is effective. Since SBE 20.14. x-since: 20.14 example: 1601546400 suspensionReason: type: string description: An optional description of the suspension reason. Since SBE 20.14. x-since: 20.14 example: The user will be OOO due to a mandatory leave Error: type: object properties: code: type: integer format: int32 example: 401 message: type: string example: Invalid session FeatureList: type: array items: $ref: '#/definitions/Feature' example: - entitlment: canCreatePublicRoom enabled: true - entitlment: isExternalRoomEnabled enabled: false - entitlment: canUpdateAvatar enabled: true SuccessResponse: type: object properties: format: type: string enum: - TEXT - XML example: TEXT message: type: string example: Success UserDetailList: type: array items: $ref: '#/definitions/UserDetail' example: - userAttributes: emailAddress: janedoe@symphony.com firstName: Jane lastName: Doe userName: jane.doe displayName: Jane Doe accountType: NORMAL assetClasses: - Commodities industries: - Financials - Healthcare userSystemInfo: id: 9826885173258 status: ENABLED suspended: true suspensionReason: The user will be OOO due to a mandatory leave suspendedUntil: 1601546400 createdDate: 1499347606000 createdBy: '9826885173252' lastUpdatedDate: 1499348554853 lastLoginDate: 1504839044527 roles: - INDIVIDUAL - userAttributes: emailAddress: nexus.user@email.com userName: nexus.user displayName: nexus.user accountType: SYSTEM userSystemInfo: id: 9826885173290 status: ENABLED suspended: false createdDate: 1499375475000 createdBy: '9826885173255' lastUpdatedDate: 1499375475852 lastLoginDate: 1504899124191 roles: - USER_PROVISIONING - CONTENT_MANAGEMENT - INDIVIDUAL IntegerList: type: array items: type: integer format: int64 example: - 1461508270000 - 7215545057281 DelegateAction: type: object properties: userId: type: integer format: int64 example: 7215545078461 action: type: string enum: - ADD - REMOVE example: ADD UserFilter: type: object properties: role: type: string description: The user role example: INDIVIDUAL feature: type: string status: type: string enum: - ENABLED - DISABLED