Index | BlackBerry Workspaces SDK |
Name | Path | Version | Description |
---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
addActiveDirectoryGroupsV30Adds Active Directory groups to the organization.ignores existing groups |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/groups/add | ||
Request Body: | AddActiveDirectoryGroups | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addDistributionListV30Adds a new organizational distribution list and include members in it. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/distributionLists/add | ||
Request Body: | AddOrganizationDistributionList | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addMembersToDistributionListV30Adds members to a named distribution list. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/distributionLists/{name}/members/add | ||
Request Body: | Members | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
name: String - name of distribution list.
|
|||
|
addOrganizationBlacklistingV30Adds an organization denied for entities to blacklist. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/policy/blacklist/add | ||
Request Body: | AddOrganizationBlacklisting | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addOrganizationWatermarkV30Adds an organizational watermark. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/watermarks/add | ||
Request Body: | AddOrganizationWatermark | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addSystemAccountV30Adds a new system account. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/systemaccount/add | ||
Request Body: | AddOrganizationSystemAccountsIdp | ||
Response Headers: | N/A | ||
Response Body: | AddOrganizationSystemAccountsIdpResponse | ||
|
addTagFieldV30Adds an organizational tag. The tag is added to the organization associated with the user making the request. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/tags/add | ||
Request Body: | TagField | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
addUsersV30Adds users to an organization. The users will be added to the organization of the current user (making the request). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/users/add | ||
Request Body: | Users | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
bulkDeleteDistributionListV30Deletes a set of distribution lists. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/distributionLists/delete | ||
Request Body: | DeleteOrganizationsDistributionLists | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
changeActiveDirectorySettingsStatusV30Enables or disables active directory. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/settings/changeStatus | ||
Request Body: | ChangeActiveDirectorySettingsStatus | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
copyMembershipV30Copies membership( of several users ) to another existing user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/users/memberships/copy | ||
Request Body: | CopyMembership | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
createUemDirectoryRefV30Adds a new organizational distribution list and include members in it. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/uemDirectoryRef/{dirConnId} | ||
Request Body: | AddOrganizationDistributionList | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
dirConnId: String.
|
|||
|
deleteActiveDirectoryGroupsV30Deletes active directory groups that exist in the organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/groups/delete | ||
Request Body: | DeleteActiveDirectoryGroupList | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteActiveDirectorySettingsV30Deletes active directory setting. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/settings/delete | ||
Request Body: | DeleteActiveDirectorySettings | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteDistributionListV30Deletes a distribution list. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/distributionLists/{name}/delete | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
name: String - name of list to delete.
|
|||
|
deleteIdpSettingsV30Deletes IDP settings for organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/idp/settings/delete | ||
Request Body: | DeleteIdpSettings | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteOrganizationWatermarkV30Deletes a watermark for an organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/watermarks/delete | ||
Request Body: | DeleteOrganizationWatermark | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteSystemAccountV30Removes a system account. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/systemaccount/delete | ||
Request Body: | DeleteOrganizationSystemAccountIdp | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteTagFieldsV30Deletes organization tags. This is a bulk processing method, for a number of tags. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/tags/delete | ||
Request Body: | DeleteTags | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteUsersV30Removes users from an organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/users/delete | ||
Request Body: | RemoveUsers | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
distributionListMembersV30Gets a list of members of a named distribution list. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizations/distributionLists/{name} | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | Members | ||
Path parameters:
name: String - name of distribution list.
|
|||
|
editActiveDirectoryGroupV30Edits Active Directory groups that exist in the organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/groups/edit | ||
Request Body: | EditActiveDirectoryGroup | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editActiveDirectorySettingsV30Edits the Active Directory connection settings of the organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/settings/edit | ||
Request Body: | EditActiveDirectorySettings | ||
Response Headers: | N/A | ||
Response Body: | EditActiveDirectorySettingsResponse | ||
|
editConversionPolicyV30Edits exchange policy for organization of current user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/conversion/policy/edit | ||
Request Body: | OrganizationConversionPolicy | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editExchangePolicyV30Edits exchange policy for organization of current user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/documents/policies/edit | ||
Request Body: | OrganizationExchangePolicy | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editExternalTransactionStatusV30Edits external transactions status. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/external/transactions/edit | ||
Request Body: | EditExternalTransactionStatusInput | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editIdpSettingsV30Edits or adds an IDP settings for organization. if no settings already exist for an idp it will create a new settings, otherwise it will update the existing settings omitting a value from the request or setting it to null will not change this value in the settings (i.e "androidRefreshTokenTTL" : null) setting a value specifically to be null within the internal json will change this value in the settings to null (i.e "androidRefreshTokenTTL" : {value: null}) |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/idp/settings/edit | ||
Request Body: | EditIdpSettings | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editOrganizationPolicyV30Edits an organizational policy. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/policy/edit | ||
Request Body: | EditOrganizationPolicy | ||
Response Headers: | N/A | ||
Response Body: | OrganizationPolicy | ||
|
editOrganizationWatermarkV30Edits an organizational watermark. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/watermarks/edit | ||
Request Body: | EditOrganizationWatermark | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editStoragePolicyV30Edits storage policy for organization of current user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/storage/policy/edit | ||
Request Body: | OrganizationStoragePolicy | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editSystemAccountV30Edits system accounts. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/systemaccount/edit | ||
Request Body: | EditOrganizationSystemAccountsIdp | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editTagV30Edits an organization tag. The tag name can be changed. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/tags/edit | ||
Request Body: | EditTag | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editWorkspacesPolicyV30Edits workspace policy for organization of current user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/rooms/policies/edit | ||
Request Body: | OrganizationWorkspacesPolicy | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
exportGroupLogByIdsToJsonV30Exports the groups log to JSON. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/logs/groups/ids/create | ||
Request Body: | GroupsLogByIds | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
exportGroupLogByRoomsToCsvV30Exports the room groups log to CSV. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/logs/groups/rooms/csv/create | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
from: String - - the start date for the logs requested.
pageNumber: String - - the current page number for the operation in a pagination context. pageSize: String - - the number of logs to include per page. roomIds: Set to: String - - the end date for the logs requested. |
|||
|
exportGroupLogByRoomsToJsonV30Exports the room groups log to JSON. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/logs/groups/rooms/create | ||
Request Body: | GroupsLogByRooms | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
exportGroupLogToJsonV30Exports the distribution lists entries in group log to JSON. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/logs/groups/create | ||
Request Body: | BaseLog | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
exportGroupLogV30Exports the distribution lists entries in group log. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/logs/groups/csv/create | ||
Request Body: | BaseLog | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
exportInternalDomainsReportCsvV30Exports internal domains report |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/reports/internalDomains/csv/create | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
exportLicensingReportCSVV30 |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/reports/licensing/csv/export | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
exportOrganizationRoleLogToJsonV30Exports the organization role log to JSON. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/logs/roles/create | ||
Request Body: | BaseLog | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
exportOrganizationRoleLogV30Exports the organization role log. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/logs/roles/csv/create | ||
Request Body: | BaseLog | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
exportRoomsReportCsvByMailV30 |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/reports/rooms/csv/exportByMail | ||
Request Body: | RoomsReportRequestByMail | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
gemsServerUrlV30Returns the Gems server url as defined in the properties. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizations/gems/url | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ConnectorConfiguration | ||
|
getAllTagsV30Gets a list of all tags for an organization. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizations/tags | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
Query parameters:
workspaceId: String - - the id of the workspace for which tags are being retrieved.
|
|||
|
getAuthenticationPoliciesV30Gets authentication policies for organization of current user.This api is not robust and should be deprecated , it returns in the json policy settings sutiable only for username password in the future it will not allow adding other idps policy. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizations/rules/authentication/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | AuthenticationPolicy | ||
|
getBYOKAllRegionsV30Get possible values of Regions Enum |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizations/byok/regions | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
getConversionPolicyV30Gets conversion policy for organization of current user. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizations/conversion/policy/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | OrganizationConversionPolicy | ||
|
getDefaultNotificationEmailV30Gets the default notification email. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizations/notification/email/default | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | DefaultNotificationEmail | ||
|
getExchangePolicyV30Gets exchange policy for organization of current user. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizations/documents/policies/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | OrganizationExchangePolicy | ||
|
getExternalTransactionStatusV30Gets external transactions status. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/external/transactions/status | ||
Request Body: | ExternalTransactionInput | ||
Response Headers: | N/A | ||
Response Body: | ExternalTransactionStatus | ||
|
getLogoV30Get logo |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizationswhitelabel/{orgId} | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
orgId: String.
|
|||
|
getOrganizationActiveBYOKV30Get organization active BYOK |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizations/byok/active | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | OrganizationActiveBYOK | ||
|
getOrganizationLicenseExpirationTimeV30 |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/license/expirationtime | ||
Request Body: | OrgLicenseExpirationTimeRequest | ||
Response Headers: | N/A | ||
Response Body: | OrgLicenseExpirationTimeResponse | ||
|
getOrganizationLicenseSubscriptionInfoV30 |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/license/subscriptionInfo | ||
Request Body: | OrgLicenseSubscriptionInfoRequest | ||
Response Headers: | N/A | ||
Response Body: | OrgLicenseSubscriptionInfoResponse | ||
|
getProtectAnywherePolicyV30Gets protect anywhere policy for an organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/protectAnywhere/policy/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | OrganizationProtectAnywherePolicy | ||
|
getStoragePolicyV30Gets storage policy for organization of current user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/storage/policy/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | OrganizationStoragePolicyResponse | ||
|
getTagValuesListV30Returns a list of all the tags from workspaces the current user is permitted to view. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/tags/values/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ListTagTree | ||
Query parameters:
workspaceTypes: Set
|
|||
|
getUserAuthenticationLoggingInitialDateV30 |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/reports/audit/userAuthentication/logging/startDate/list | ||
Request Body: | OrgLicenseSubscriptionInfoRequest | ||
Response Headers: | N/A | ||
Response Body: | UserAuthenticationLoggingInitialDateResponse | ||
|
getUserReportV30Creates a Report about a specific users. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/reports/users/create | ||
Request Body: | UsersReportRequest | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
getWorkspacesPolicyV30Lists workspace policy for the organization of the current user. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizations/rooms/policies/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | OrganizationWorkspacesPolicy | ||
|
isActiveDirectorySettingsEnabledV30Lists whether active directory is configured. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/isEnabled | ||
Request Body: | IsActiveDirectorySettingsEnabled | ||
Response Headers: | N/A | ||
Response Body: | IsActiveDirectoryConfiguredResult | ||
|
listActiveDirectoryGroupsV30Lists the Active Directory groups of the organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/groups/list | ||
Request Body: | ListActiveDirectoryGroups | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listActiveDirectorySettingsV30Lists the Active Directory connection settings of the organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/settings/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listDistrbutionListsV30Returns a list of all distribution lists for an organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/distributionLists/list | ||
Request Body: | ListDistributionlists | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listDistributionListsByNameV30Gets a list of members of a named distribution list. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/distributionLists/listByName | ||
Request Body: | ListDistributionListsByName | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listDomainsV30Lists domains with roles. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/domains/list | ||
Request Body: | ListDomains | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listExternalConnectorsV30List the existing connectors in an organization for a user. If the connectors are define with impersonation and the user doesn't have WatchDox permissions to the any of the workspaces in the connector we will evaluate the list of permitted domains to find out if the user can see a certain connector. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/connectors/list | ||
Request Body: | ListExternalConnectors | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listIdpSettingsV30Lists IDP settings for organization.It will list any existing settings for this organization and will always list the current configuration for the IDP on the current organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/idp/settings/list | ||
Request Body: | ListIdpSettings | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listInternalDomainsForOrganizationResponseJsonV30Lists internal domains for organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/internalDomains/list | ||
Request Body: | ListInternalDomainsForOrganizationRequest | ||
Response Headers: | N/A | ||
Response Body: | ListInternalDomainsForOrganizationResponse | ||
|
listOrganizationBlacklistingV30Lists an organization blacklist. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/policy/blacklist/list | ||
Request Body: | ListOrganizationBlacklisting | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listOrganizationPolicyV30Lists organizational policy. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/policy/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | OrganizationPolicy | ||
|
listOrganizationPolicyV30Lists organizational policy. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/policy/document/list | ||
Request Body: | ListOrganizationPolicy | ||
Response Headers: | N/A | ||
Response Body: | OrganizationPolicy | ||
|
listOrganizationWatermarkV30Lists all watermarks for an organization at specific positions. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/watermarks/list | ||
Request Body: | ListOrganizationWatermarks | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listPagingTagsV30Lists organization tags, in a page-formatted list. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/tags/list | ||
Request Body: | ListTags | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listPendingNumberPermissionRequestsV30Lists number of pending existing file permission requests and workspace permission requests for an admin. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/permissions/requests/listPending | ||
Request Body: | ListPendingNumberPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ListPendingNumberPermissionRequestsResult | ||
|
listSystemAccountV30Lists system accounts for an organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/systemaccount/list | ||
Request Body: | ListOrganizationSystemAccountsIdp | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
removeMembersFromDistributionListV30Removes members from a distribution list. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/distributionLists/{name}/members/remove | ||
Request Body: | Members | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
name: String - distribution list name.
|
|||
|
removeOrganizationBlacklistingV30Removes organization denied for entities from blacklist. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/policy/blacklist/remove | ||
Request Body: | RemoveOrganizationBlacklisting | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
renameDistributionListV30Renames the distribution list. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/distributionLists/{name}/rename | ||
Request Body: | RenameDistributionList | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
name: String - the distribution list's current name (or the old name).
|
|||
|
resetPasswordV30Resets the passwords for a list of users. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/rules/authentication/resetPassword | ||
Request Body: | UsersForPasswordReset | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
revokeBYOKV30revoke organization from being BYOK |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /organizationsbyok/revoke | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
searchActiveDirectoryGroupsV30Searches Active Directory groups in the Active Directory server. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/groups/search | ||
Request Body: | ListActiveDirectoryGroupsSuggestions | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
searchExistingActiveDirectoryGroupsV30Searches Active Directory groups that exist in the organization. Either listing all of them or just by groups that are requested |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/groups/searchExisting | ||
Request Body: | ListExistingActiveDirectoryGroupsSuggestions | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
sendSupportEmailV30 |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/support/email/send | ||
Request Body: | SendSupportEmail | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
setAuthenticationPoliciesV30Sets authentication policies for organization of current user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/rules/authentication/edit | ||
Request Body: | AuthenticationPolicy | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
setInternalDomainsForOrganizationResponseJsonV30Sets internal domains for the organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/internalDomains/set | ||
Request Body: | ListInternalDomainsForOrganizationResponse | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
setProtectAnywherePolicyV30Sets protect anywhere policy for an organization. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/protectAnywhere/policy/set | ||
Request Body: | OrganizationProtectAnywherePolicy | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
validateUsersNotAdminsInWorkspacesV30Validates which users are non-admins in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/users/delete/validateAdmins | ||
Request Body: | ValidateUsersNotAdminsInWorkspacesRequest | ||
Response Headers: | N/A | ||
Response Body: | ValidateUsersNotAdminsInWorkspacesResponse | ||
|
verifyActiveDirectorySettingsV30Verifies Active Directory settings. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /organizations/activeDirectory/settings/verify | ||
Request Body: | VerifyActiveDirectorySettings | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|