schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
swadl-schema-1.0.json | work-phone-number | User's work phone number. | {} |
swadl-schema-1.0.json | mobile-phone-number | User's mobile phone number. | {} |
swadl-schema-1.0.json | two-factor-auth-number | User's two factor auth number. | {} |
swadl-schema-1.0.json | sms-number | User's sms phone number. | {} |
swadl-schema-1.0.json | business | User's business information. | {} |
swadl-schema-1.0.json | password | User's password. The password object is optional for end-user accounts (NORMAL). For example, if your organization utilizes SSO, you may not want to specify the password. | {"type": "object", "additionalProperties": false, "required": ["hashed-password", "hashed-salt"], "properties": {"hashed-password": {"type": "string", "minLength": 1}, "hashed-salt": {"type": "string", "minLength": 1}, "hashed-km-password": {"type": "string", "minLength": 1}, "hashed-km-salt": {"type": "string", "minLength": 1}}} |
swadl-schema-1.0.json | hashed-password | A base64-encoded string. The hashed password. This is the hashed version of the password the user would use to login. | {"type": "string", "minLength": 1} |
swadl-schema-1.0.json | hashed-salt | A base64-encoded string. The salt used for hashing the hPassword. | {"type": "string", "minLength": 1} |
swadl-schema-1.0.json | hashed-km-password | A base64-encoded string. The hashed password to be used for authenticating to the key manager. | {"type": "string", "minLength": 1} |
swadl-schema-1.0.json | hashed-km-salt | A base64-encoded string. The salt used for hashing the khPassword. | {"type": "string", "minLength": 1} |
swadl-schema-1.0.json | roles | The roles object consists of the following possibilities:
For end-user accounts: INDIVIDUAL, ADMINISTRATOR, SUPER_ADMINISTRATOR, L1_SUPPORT, L2_SUPPORT, COMPLIANCE_OFFICER, SUPER_COMPLIANCE_OFFICER
For service accounts: INDIVIDUAL, USER_PROVISIONING, SCOPE_MANAGEMENT, CONTENT_MANAGEMENT, MALWARE_SCAN_MANAGER, MALWARE_SCAN_STATE_USER, AUDIT_TRAIL_MANAGEMENT | {"x-intellij-html-description": "<html><p>The roles object consists of the following possibilities:<li>For end-user accounts: INDIVIDUAL, ADMINISTRATOR, SUPER_ADMINISTRATOR, L1_SUPPORT, L2_SUPPORT, COMPLIANCE_OFFICER, SUPER_COMPLIANCE_OFFICER</li><li>For service accounts: INDIVIDUAL, USER_PROVISIONING, SCOPE_MANAGEMENT, CONTENT_MANAGEMENT, MALWARE_SCAN_MANAGER, MALWARE_SCAN_STATE_USER, AUDIT_TRAIL_MANAGEMENT</li><br/><a href=\"https://developers.symphony.com/restapi/reference#roles-object\">https://developers.symphony.com/restapi/reference#roles-object</a></p></html>"} |
swadl-schema-1.0.json | entitlements | User entitlements. | {} |
swadl-schema-1.0.json | status | User status: ENABLED or DISABLED. | {"type": "string", "enum": ["ENABLED", "DISABLED"]} |
swadl-schema-1.0.json | email | Email address, must be unique | {} |
swadl-schema-1.0.json | username | User's username. | {} |
swadl-schema-1.0.json | display-name | User's display name. | {} |
swadl-schema-1.0.json | business | User's business information. | {} |
swadl-schema-1.0.json | keys | For SYSTEM users, to set up the RSA keys for authentication. | {"type": "object", "properties": {"current": {}, "previous": {}}} |
swadl-schema-1.0.json | roles | The roles object consists of the following possibilities:
For end-user accounts: INDIVIDUAL, ADMINISTRATOR, SUPER_ADMINISTRATOR, L1_SUPPORT, L2_SUPPORT, COMPLIANCE_OFFICER, SUPER_COMPLIANCE_OFFICER
For service accounts: INDIVIDUAL, USER_PROVISIONING, SCOPE_MANAGEMENT, CONTENT_MANAGEMENT, MALWARE_SCAN_MANAGER, MALWARE_SCAN_STATE_USER, AUDIT_TRAIL_MANAGEMENT | {"x-intellij-html-description": "<html><p>The roles object consists of the following possibilities:<li>For end-user accounts: INDIVIDUAL, ADMINISTRATOR, SUPER_ADMINISTRATOR, L1_SUPPORT, L2_SUPPORT, COMPLIANCE_OFFICER, SUPER_COMPLIANCE_OFFICER</li><li>For service accounts: INDIVIDUAL, USER_PROVISIONING, SCOPE_MANAGEMENT, CONTENT_MANAGEMENT, MALWARE_SCAN_MANAGER, MALWARE_SCAN_STATE_USER, AUDIT_TRAIL_MANAGEMENT</li><br/><a href=\"https://developers.symphony.com/restapi/reference#roles-object\">https://developers.symphony.com/restapi/reference#roles-object</a></p></html>"} |
swadl-schema-1.0.json | entitlements | User entitlements. | {} |
swadl-schema-1.0.json | status | User status: ENABLED or DISABLED. | {"type": "string", "enum": ["ENABLED", "DISABLED"]} |
swadl-schema-1.0.json | action | A string indicating the action to be performed on the user's RSA.
The following actions can be performed on the user's active RSA key:
SAVE
REVOKE.
The following actions can be performed onto the user's rotated RSA key:
REVOKE
EXTEND. | {"type": "string", "enum": ["SAVE", "EXTEND", "REVOKE"]} |
swadl-schema-1.0.json | key | A string containing the user's RSA public key. The key must be 4096 bits. Only PKCS8 format is allowed. | {"type": "string", "minLength": 1} |
swadl-schema-1.0.json | expiration | An ISO 8601 timestamp containing the RSA key expiration date. This value is only set for rotated keys. | {"type": "string", "minLength": 1} |
swadl-schema-1.0.json | entitlements-inner | Feature entitlements to configure for the user. | {"oneOf": [{"type": "object", "properties": {"postReadEnabled": {"type": ["boolean", "string"]}, "postWriteEnabled": {"type": ["boolean", "string"]}, "delegatesEnabled": {"type": ["boolean", "string"]}, "isExternalIMEnabled": {"type": ["boolean", "string"]}, "canShareFilesExternally": {"type": ["boolean", "string"]}, "canCreatePublicRoom": {"type": ["boolean", "string"]}, "canUpdateAvatar": {"type": ["boolean", "string"]}, "isExternalRoomEnabled": {"type": ["boolean", "string"]}, "canCreatePushedSignals": {"type": ["boolean", "string"]}, "canUseCompactMode": {"type": ["boolean", "string"]}, "mustBeRecorded": {"type": ["boolean", "string"]}, "sendFilesEnabled": {"type": ["boolean", "string"]}, "canUseInternalAudio": {"type": ["boolean", "string"]}, "canUseInternalVideo": {"type": ["boolean", "string"]}, "canProjectInternalScreenShare": {"type": ["boolean", "string"]}, "canViewInternalScreenShare": {"type": ["boolean", "string"]}, "canCreateMultiLateralRoom": {"type": ["boolean", "string"]}, "canJoinMultiLateralRoom": {"type": ["boolean", "string"]}, "canUseFirehose": {"type": ["boolean", "string"]}, "canUseInternalAudioMobile": {"type": ["boolean", "string"]}, "canUseInternalVideoMobile": {"type": ["boolean", "string"]}, "canProjectInternalScreenShareMobile": {"type": ["boolean", "string"]}, "canViewInternalScreenShareMobile": {"type": ["boolean", "string"]}, "canManageSignalSubscription": {"type": ["boolean", "string"]}, "canCreateDatahose": {"type": ["boolean", "string"]}, "canIntegrateEmail": {"type": ["boolean", "string"]}, "canReadDatahose": {"type": ["boolean", "string"]}, "canSuppressMessage": {"type": ["boolean", "string"]}, "canSwitchToClient20": {"type": ["boolean", "string"]}, "canUpdateRoomHistoryProperty": {"type": ["boolean", "string"]}, "canUseEncryptAPI": {"type": ["boolean", "string"]}, "enableSwiftSearch": {"type": ["boolean", "string"]}, "sdaDevtoolsEnabled": {"type": ["boolean", "string"]}, "sdaPermissionsFullScreen": {"type": ["boolean", "string"]}, "sdaPermissionsGeoLocation": {"type": ["boolean", "string"]}, "sdaPermissionsMedia": {"type": ["boolean", "string"]}, "sdaPermissionsMidiSysex": {"type": ["boolean", "string"]}, "sdaPermissionsNotifications": {"type": ["boolean", "string"]}, "sdaPermissionsOpenExternalApp": {"type": ["boolean", "string"]}, "sdaPermissionsPointerLock": {"type": ["boolean", "string"]}}}, {"type": "string", "minLength": 1}, {"enum": ["${variables.VARIABLE_NAME}"]}]} |
swadl-schema-1.0.json | postReadEnabled | Allows the user to read wall posts. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | postWriteEnabled | Allows the user to write wall posts. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | delegatesEnabled | Allows the user to have delegates. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | isExternalIMEnabled | Allows the user to chat in external IM/MIMs. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canShareFilesExternally | Allows the user to share files externally. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canCreatePublicRoom | Allows the user to create internal public rooms. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canUpdateAvatar | Allows the user to edit profile picture. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | isExternalRoomEnabled | Allows the user to chat in private external rooms. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canCreatePushedSignals | Allows the user to create push signals. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canUseCompactMode | Enables Lite Mode. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | mustBeRecorded | Must be recorded in meetings. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | sendFilesEnabled | Allows the user to send files internally. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canUseInternalAudio | Allows the user to use audio in internal Meetings. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canUseInternalVideo | Allows the user to use video in internal Meetings. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canProjectInternalScreenShare | Allows the user to share screens in internal Meetings. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canViewInternalScreenShare | Allows the user to view shared screens in internal Meetings. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canCreateMultiLateralRoom | Allows the user to create multi-lateral room. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canJoinMultiLateralRoom | Allows the user to join multi-lateral room. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canUseFirehose | Allows the user to use Firehose. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canUseInternalAudioMobile | Allows the user to use audio in internal meetings on mobile. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canUseInternalVideoMobile | Allows the user to use video in internal meetings on mobile. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canProjectInternalScreenShareMobile | Allows the user to share screens in internal meetings on mobile. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canViewInternalScreenShareMobile | Allows the user to view shared screens in internal meetings on mobile. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canManageSignalSubscription | Allows the user to manage signal subscriptions. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canCreateDatahose | Can create datahose feeds. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canIntegrateEmail | Can integrate email service. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canReadDatahose | Can read from datahose feeds. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canSuppressMessage | Can suppress own messages. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canSwitchToClient20 | Can switch to Client 2.0 experience. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canUpdateRoomHistoryProperty | Can Toggle Room's Share History Property. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | canUseEncryptAPI | Allow user to use Agent Encrypt endpoints. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | enableSwiftSearch | Can Use Swift Search. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | sdaDevtoolsEnabled | Enable Developer Tools for SDA. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | sdaPermissionsFullScreen | Enable Full screen access on SDA. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | sdaPermissionsGeoLocation | Enable location access on SDA. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | sdaPermissionsMedia | Enable Media access on SDA. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | sdaPermissionsMidiSysex | Enable access to MIDI Sysex on SDA. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | sdaPermissionsNotifications | Allow notifications on SDA. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | sdaPermissionsOpenExternalApp | Allow Opening External Apps from SDA. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | sdaPermissionsPointerLock | Enable Pointer Lock on SDA. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | roles-inner | The roles object consists of the following possibilities:
For end-user accounts: INDIVIDUAL, ADMINISTRATOR, SUPER_ADMINISTRATOR, L1_SUPPORT, L2_SUPPORT, COMPLIANCE_OFFICER, SUPER_COMPLIANCE_OFFICER
For service accounts: INDIVIDUAL, USER_PROVISIONING, SCOPE_MANAGEMENT, CONTENT_MANAGEMENT, MALWARE_SCAN_MANAGER, MALWARE_SCAN_STATE_USER, AUDIT_TRAIL_MANAGEMENT | {"x-intellij-html-description": "<html><p>The roles object consists of the following possibilities:<li>For end-user accounts: INDIVIDUAL, ADMINISTRATOR, SUPER_ADMINISTRATOR, L1_SUPPORT, L2_SUPPORT, COMPLIANCE_OFFICER, SUPER_COMPLIANCE_OFFICER</li><li>For service accounts: INDIVIDUAL, USER_PROVISIONING, SCOPE_MANAGEMENT, CONTENT_MANAGEMENT, MALWARE_SCAN_MANAGER, MALWARE_SCAN_STATE_USER, AUDIT_TRAIL_MANAGEMENT</li><br/><a href=\"https://developers.symphony.com/restapi/reference#roles-object\">https://developers.symphony.com/restapi/reference#roles-object</a></p></html>", "oneOf": [{"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["INDIVIDUAL", "ADMINISTRATOR", "SUPER_ADMINISTRATOR", "L1_SUPPORT", "L2_SUPPORT", "COMPLIANCE_OFFICER", "SUPER_COMPLIANCE_OFFICER", "USER_PROVISIONING", "SCOPE_MANAGEMENT", "CONTENT_MANAGEMENT", "MALWARE_SCAN_MANAGER", "MALWARE_SCAN_STATE_USER", "AUDIT_TRAIL_MANAGEMENT", "AGENT", "CONTENT_EXPORT_SERVICE", "SYMPHONY_ADMIN", "KEY_MANAGER", "EF_POLICY_MANAGEMENT", "CEP_VISIBILITY_GROUP_MANAGEMENT"]}}, {"type": "string", "minLength": 1, "pattern": "^\\$\\{.*\\}$"}, {"enum": ["${variables.VARIABLE_NAME}"]}]} |
swadl-schema-1.0.json | user-ids | Users to add or remove roles from. | {"oneOf": [{"type": "array", "uniqueItems": true, "minItems": 1, "items": {"type": ["string", "integer"], "minLength": 1}}, {"type": "string", "minLength": 1, "pattern": "^\\$\\{.*\\}$"}, {"enum": ["${variables.VARIABLE_NAME}"]}]} |
swadl-schema-1.0.json | emails | List of email addresses. Note that for this activity, you can use either the user-ids, the emails or the usernames, but only one at a time, you cannot mix and match them. | {"oneOf": [{"type": "array", "items": {}, "minLength": 1}, {"type": "string", "minLength": 1, "pattern": "^\\$\\{.*\\}$"}, {"enum": ["${variables.VARIABLE_NAME}"]}]} |
swadl-schema-1.0.json | usernames | List of usernames. If username is specified, local must be set to true. Note that for this activity, you can use either the user-ids, the emails or the usernames, but only one at a time, you cannot mix and match them. | {"oneOf": [{"type": "array", "items": {}, "minLength": 1}, {"type": "string", "minLength": 1, "pattern": "^\\$\\{.*\\}$"}, {"enum": ["${variables.VARIABLE_NAME}"]}]} |
swadl-schema-1.0.json | local | If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned. | {"type": ["boolean", "string"], "default": false} |
swadl-schema-1.0.json | active | If true, it searches for active users only. If false, it searches for inactive users only. If not set, it searches for all users regardless of their status. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | obo | Defines whether the activity will be executed on behalf of a user and the user on whose behalf the call will be made | {} |
swadl-schema-1.0.json | obo | Defines whether the activity will be executed on behalf of a user and the user on whose behalf the call will be made | {} |
swadl-schema-1.0.json | obo | Defines whether the activity will be executed on behalf of a user and the user on whose behalf the call will be made | {} |
swadl-schema-1.0.json | obo | Defines whether the activity will be executed on behalf of a user and the user on whose behalf the call will be made | {} |
swadl-schema-1.0.json | stream-id | Id of the stream for which to return members. | {} |
swadl-schema-1.0.json | stream-id | Id of the stream for which to return members. | {} |
swadl-schema-1.0.json | types | A list of stream types that will be returned. Options are IM (1-1 instant messages), MIM (multiparty instant messages), ROOM (rooms), POST (the user's wall). For more information, see the streamTypes section below.
If not specified, all types of streams are returned. | {"oneOf": [{"type": "array", "items": {"type": "string", "enum": ["IM", "MIM", "ROOM", "POST"]}}, {"type": "string", "minLength": 1, "pattern": "^\\$\\{.*\\}$"}, {"enum": ["${variables.VARIABLE_NAME}"]}]} |
swadl-schema-1.0.json | include-inactive-streams | Whether to include inactive conversations. A chatroom is inactive if it has been deactivated by an owner or admin. An IM or MIM is inactive if one of the participating users has been deactivated by an admin. If not specified, only active streams are returned. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | obo | Defines whether the activity will be executed on behalf of a user and the user on whose behalf the call will be made | {} |
swadl-schema-1.0.json | message-id | The message identifier. | {} |
swadl-schema-1.0.json | types | A list of stream types that will be returned (IM, MIM, ROOM). If not specified, streams of all types are returned. | {"oneOf": [{"type": "array", "items": {"type": "string", "enum": ["IM", "MIM", "ROOM"]}}, {"type": "string", "minLength": 1, "pattern": "^\\$\\{.*\\}$"}, {"enum": ["${variables.VARIABLE_NAME}"]}]} |
swadl-schema-1.0.json | scope | The scope of the stream: INTERNAL (restricted to members of the calling user's company) or EXTERNAL (including members of the calling user's company, as well as another firm). If not specified, returns streams of either scope. | {"type": "string", "enum": ["INTERNAL", "EXTERNAL"]} |
swadl-schema-1.0.json | origin | The origin of the room: INTERNAL (created by a user of the calling user's company) or EXTERNAL (created by a user of another company). If not specified, returns streams of either origin. Only applies to chatrooms with External scope. | {"type": "string", "enum": ["INTERNAL", "EXTERNAL"]} |
swadl-schema-1.0.json | privacy | The privacy setting of the room: PRIVATE (members must be added) or PUBLIC (anyone can join). If not specified, returns both private and public rooms. Only applies to chatrooms with internal scope. | {"type": "string", "enum": ["PRIVATE", "PUBLIC"]} |
swadl-schema-1.0.json | status | The status of the room: ACTIVE or INACTIVE. If not specified, both active and inactive streams are returned. | {"type": "string", "enum": ["ACTIVE", "INACTIVE"]} |
swadl-schema-1.0.json | start-date | Restricts result set to rooms that have been modified since this date (ISO 8601). When specified along with end-date, enables the developer to specify rooms modified within a given time range. | {"type": "string"} |
swadl-schema-1.0.json | end-date | Restricts result set to rooms that have been modified prior to this date (ISO 8601). When specified along with start-date, enables the developer to specify rooms modified within a given time range. | {"type": "string"} |
swadl-schema-1.0.json | query | The query which is searched for in room name, description, and optionally keywords. Case-insensitive. | {"type": "string", "minLength": 1} |
swadl-schema-1.0.json | labels | A list of room keywords whose values will be queried. | {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string", "minLength": 1, "pattern": "^\\$\\{.*\\}$"}, {"enum": ["${variables.VARIABLE_NAME}"]}]} |
swadl-schema-1.0.json | active | If true, it restricts the search to active rooms. If false, it restricts the search to inactive rooms. If not specified, it includes both active and inactive rooms. Note that for inactive rooms, only rooms where the calling user is a member will be in the search scope; read the box “Room Search Scope” for further details. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | private | If true, it includes only private rooms in the search results. If false, only public rooms are returned. If not specified, both public and private rooms are returned. Note that for inactive rooms, only discoverable rooms and rooms where the calling user is a member will be in the search scope; read the box “Room Search Scope” for further details. | {"type": ["boolean", "string"]} |
swadl-schema-1.0.json | creator-id | If provided, restrict the search to rooms created by the specified user. | {"type": ["string", "number"], "minLength": 1} |
swadl-schema-1.0.json | owner-id | If provided, restrict the search to rooms owned by the specified user. | {"type": ["string", "number"], "minLength": 1} |
swadl-schema-1.0.json | member-id | If provided, restrict the search to rooms where the specified user is a member. | {"type": ["string", "number"], "minLength": 1} |
swadl-schema-1.0.json | sort-order | Sort algorithm to be used. Supports two values: BASIC (legacy algorithm) and RELEVANCE (enhanced algorithm). | {"type": "string", "enum": ["BASIC", "RELEVANCE"]} |
swadl-schema-1.0.json | obo | Defines whether the activity will be executed on behalf of a user and the user on whose behalf the call will be made | {} |
swadl-schema-1.0.json | stream-id | Stream identifier. | {} |
swadl-schema-1.0.json | since | Date, in ISO 8601 format, of the earliest possible data of the first message returned. | {"anyOf": [{"enum": ["${variables.VARIABLE_NAME}"]}, {"type": "string", "minLength": 1}], "default": "2021-08-31T15:50:00Z"} |
swadl-schema-1.0.json | user-ids | List of user ids that this activity results will be restricted to their connections. | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.