Index BlackBerry Workspaces SDK
BlackBerry Workspaces Resource
Organizations
Functions for managing organizations.
Function Summary
Name Path Version Description

addActiveDirectoryGroupsV30

/organizations/activeDirectory/groups/add

3.0

Adds Active Directory groups to the organization.

addDistributionListV30

/organizations/distributionLists/add

3.0

Adds a new organizational distribution list and include members in it.

addMembersToDistributionListV30

/organizations/distributionLists/{name}/members/add

3.0

Adds members to a named distribution list.

addOrganizationBlacklistingV30

/organizations/policy/blacklist/add

3.0

Adds an organization denied for entities to blacklist.

addOrganizationWatermarkV30

/organizations/watermarks/add

3.0

Adds an organizational watermark.

addSystemAccountV30

/organizations/systemaccount/add

3.0

Adds a new system account.

addTagFieldV30

/organizations/tags/add

3.0

Adds an organizational tag.

addUsersV30

/organizations/users/add

3.0

Adds users to an organization.

bulkDeleteDistributionListV30

/organizations/distributionLists/delete

3.0

Deletes a set of distribution lists.

changeActiveDirectorySettingsStatusV30

/organizations/activeDirectory/settings/changeStatus

3.0

Enables or disables active directory.

copyMembershipV30

/organizations/users/memberships/copy

3.0

Copies membership( of several users ) to another existing user.

createUemDirectoryRefV30

/organizations/uemDirectoryRef/{dirConnId}

3.0

Adds a new organizational distribution list and include members in it.

deleteActiveDirectoryGroupsV30

/organizations/activeDirectory/groups/delete

3.0

Deletes active directory groups that exist in the organization.

deleteActiveDirectorySettingsV30

/organizations/activeDirectory/settings/delete

3.0

Deletes active directory setting.

deleteDistributionListV30

/organizations/distributionLists/{name}/delete

3.0

Deletes a distribution list.

deleteIdpSettingsV30

/organizations/idp/settings/delete

3.0

Deletes IDP settings for organization.

deleteOrganizationWatermarkV30

/organizations/watermarks/delete

3.0

Deletes a watermark for an organization.

deleteSystemAccountV30

/organizations/systemaccount/delete

3.0

Removes a system account.

deleteTagFieldsV30

/organizations/tags/delete

3.0

Deletes organization tags.

deleteUsersV30

/organizations/users/delete

3.0

Removes users from an organization.

distributionListMembersV30

/organizations/distributionLists/{name}

3.0

Gets a list of members of a named distribution list.

editActiveDirectoryGroupV30

/organizations/activeDirectory/groups/edit

3.0

Edits Active Directory groups that exist in the organization.

editActiveDirectorySettingsV30

/organizations/activeDirectory/settings/edit

3.0

Edits the Active Directory connection settings of the organization.

editConversionPolicyV30

/organizations/conversion/policy/edit

3.0

Edits exchange policy for organization of current user.

editExchangePolicyV30

/organizations/documents/policies/edit

3.0

Edits exchange policy for organization of current user.

editExternalTransactionStatusV30

/organizations/external/transactions/edit

3.0

Edits external transactions status.

editIdpSettingsV30

/organizations/idp/settings/edit

3.0

Edits or adds an IDP settings for organization.

editOrganizationPolicyV30

/organizations/policy/edit

3.0

Edits an organizational policy.

editOrganizationWatermarkV30

/organizations/watermarks/edit

3.0

Edits an organizational watermark.

editStoragePolicyV30

/organizations/storage/policy/edit

3.0

Edits storage policy for organization of current user.

editSystemAccountV30

/organizations/systemaccount/edit

3.0

Edits system accounts.

editTagV30

/organizations/tags/edit

3.0

Edits an organization tag.

editWorkspacesPolicyV30

/organizations/rooms/policies/edit

3.0

Edits workspace policy for organization of current user.

exportGroupLogByIdsToCsvV30

/organizations/logs/groups/ids/csv/create

3.0

Exports the groups log to CSV.

exportGroupLogByIdsToJsonV30

/organizations/logs/groups/ids/create

3.0

Exports the groups log to JSON.

exportGroupLogByRoomsToCsvV30

/organizations/logs/groups/rooms/csv/create

3.0

Exports the room groups log to CSV.

exportGroupLogByRoomsToJsonV30

/organizations/logs/groups/rooms/create

3.0

Exports the room groups log to JSON.

exportGroupLogToJsonV30

/organizations/logs/groups/create

3.0

Exports the distribution lists entries in group log to JSON.

exportGroupLogV30

/organizations/logs/groups/csv/create

3.0

Exports the distribution lists entries in group log.

exportInternalDomainsReportCsvV30

/organizations/reports/internalDomains/csv/create

3.0

exportLicensingReportCSVV30

/organizations/reports/licensing/csv/export

3.0

exportOrganizationRoleLogToJsonV30

/organizations/logs/roles/create

3.0

Exports the organization role log to JSON.

exportOrganizationRoleLogV30

/organizations/logs/roles/csv/create

3.0

Exports the organization role log.

exportRoomsReportCsvByMailV30

/organizations/reports/rooms/csv/exportByMail

3.0

gemsServerUrlV30

/organizations/gems/url

3.0

Returns the Gems server url as defined in the properties.

getAllTagsV30

/organizations/tags

3.0

Gets a list of all tags for an organization.

getAuthenticationPoliciesV30

/organizations/rules/authentication/list

3.0

Gets authentication policies for organization of current user.

getBYOKAllRegionsV30

/organizations/byok/regions

3.0

getConversionPolicyV30

/organizations/conversion/policy/list

3.0

Gets conversion policy for organization of current user.

getDefaultNotificationEmailV30

/organizations/notification/email/default

3.0

Gets the default notification email.

getExchangePolicyV30

/organizations/documents/policies/list

3.0

Gets exchange policy for organization of current user.

getExternalTransactionStatusV30

/organizations/external/transactions/status

3.0

Gets external transactions status.

getLogoV30

/organizationswhitelabel/{orgId}

3.0

getOrganizationActiveBYOKV30

/organizations/byok/active

3.0

getOrganizationLicenseExpirationTimeV30

/organizations/license/expirationtime

3.0

getOrganizationLicenseSubscriptionInfoV30

/organizations/license/subscriptionInfo

3.0

getProtectAnywherePolicyV30

/organizations/protectAnywhere/policy/list

3.0

Gets protect anywhere policy for an organization.

getStoragePolicyV30

/organizations/storage/policy/list

3.0

Gets storage policy for organization of current user.

getTagValuesListV30

/organizations/tags/values/list

3.0

Returns a list of all the tags from workspaces the current user is permitted to view.

getUserAuthenticationLoggingInitialDateV30

/organizations/reports/audit/userAuthentication/logging/startDate/list

3.0

getUserReportV30

/organizations/reports/users/create

3.0

Creates a Report about a specific users.

getWorkspacesPolicyV30

/organizations/rooms/policies/list

3.0

Lists workspace policy for the organization of the current user.

isActiveDirectorySettingsEnabledV30

/organizations/activeDirectory/isEnabled

3.0

Lists whether active directory is configured.

listActiveDirectoryGroupsV30

/organizations/activeDirectory/groups/list

3.0

Lists the Active Directory groups of the organization.

listActiveDirectorySettingsV30

/organizations/activeDirectory/settings/list

3.0

Lists the Active Directory connection settings of the organization.

listDistrbutionListsV30

/organizations/distributionLists/list

3.0

Returns a list of all distribution lists for an organization.

listDistributionListsByNameV30

/organizations/distributionLists/listByName

3.0

Gets a list of members of a named distribution list.

listDomainsV30

/organizations/domains/list

3.0

Lists domains with roles.

listExternalConnectorsV30

/organizations/connectors/list

3.0

List the existing connectors in an organization for a user.

listIdpSettingsV30

/organizations/idp/settings/list

3.0

Lists IDP settings for organization.

listInternalDomainsForOrganizationResponseJsonV30

/organizations/internalDomains/list

3.0

Lists internal domains for organization.

listOrganizationBlacklistingV30

/organizations/policy/blacklist/list

3.0

Lists an organization blacklist.

listOrganizationPolicyV30

/organizations/policy/list

3.0

Lists organizational policy.

listOrganizationPolicyV30

/organizations/policy/document/list

3.0

Lists organizational policy.

listOrganizationWatermarkV30

/organizations/watermarks/list

3.0

Lists all watermarks for an organization at specific positions.

listPagingTagsV30

/organizations/tags/list

3.0

Lists organization tags, in a page-formatted list.

listPendingNumberPermissionRequestsV30

/organizations/permissions/requests/listPending

3.0

Lists number of pending existing file permission requests and workspace permission requests for an admin.

listSystemAccountV30

/organizations/systemaccount/list

3.0

Lists system accounts for an organization.

removeMembersFromDistributionListV30

/organizations/distributionLists/{name}/members/remove

3.0

Removes members from a distribution list.

removeOrganizationBlacklistingV30

/organizations/policy/blacklist/remove

3.0

Removes organization denied for entities from blacklist.

renameDistributionListV30

/organizations/distributionLists/{name}/rename

3.0

Renames the distribution list.

resetPasswordV30

/organizations/rules/authentication/resetPassword

3.0

Resets the passwords for a list of users.

revokeBYOKV30

/organizationsbyok/revoke

3.0

searchActiveDirectoryGroupsV30

/organizations/activeDirectory/groups/search

3.0

Searches Active Directory groups in the Active Directory server.

searchExistingActiveDirectoryGroupsV30

/organizations/activeDirectory/groups/searchExisting

3.0

Searches Active Directory groups that exist in the organization.

sendSupportEmailV30

/organizations/support/email/send

3.0

setAuthenticationPoliciesV30

/organizations/rules/authentication/edit

3.0

Sets authentication policies for organization of current user.

setInternalDomainsForOrganizationResponseJsonV30

/organizations/internalDomains/set

3.0

Sets internal domains for the organization.

setProtectAnywherePolicyV30

/organizations/protectAnywhere/policy/set

3.0

Sets protect anywhere policy for an organization.

validateUsersNotAdminsInWorkspacesV30

/organizations/users/delete/validateAdmins

3.0

Validates which users are non-admins in a workspace.

verifyActiveDirectorySettingsV30

/organizations/activeDirectory/settings/verify

3.0

Verifies Active Directory settings.

Function Details

addActiveDirectoryGroupsV30

Adds 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

Request format:

POST /organizations/activeDirectory/groups/add

Authorization: Bearer <ssid>
Content-type: application/json

{
activeDirectoryGroupsToAdd: Set(
{
activeDirectoryGroupGuid: String,
roles: Set(String)
}),
forceAction: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

addDistributionListV30

Adds 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

Request format:

POST /organizations/distributionLists/add

Authorization: Bearer <ssid>
Content-type: application/json

{
members:
{
userMembers: List(String),
distributionListMembers: List(String),
activeDirectoryGroupsMembersGuids: Set(String)
}),
listName: String,
description: String,
forceAction: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

addMembersToDistributionListV30

Adds 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.

Request format:

POST /organizations/distributionLists/{name}/members/add

Authorization: Bearer <ssid>
Content-type: application/json

{
userMembers: List(String),
distributionListMembers: List(String),
activeDirectoryGroupsMembersGuids: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

addOrganizationBlacklistingV30

Adds 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

Request format:

POST /organizations/policy/blacklist/add

Authorization: Bearer <ssid>
Content-type: application/json

{
permittedEntitiesToBlacklist: Set(
{
address: String,
entityType: EntityType
})
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

addOrganizationWatermarkV30

Adds an organizational watermark.

Version: 3.0
Synopsis: POST
Path: /organizations/watermarks/add
Request Body: AddOrganizationWatermark
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/watermarks/add

Authorization: Bearer <ssid>
Content-type: application/json

{
watermarkPosition: WaterMarkPosition,
color: Color,
fontSize: Integer,
transparency: Integer,
line1:
{
contentType: LineContentType,
content: String
},
line2:
{
contentType: LineContentType,
content: String
},
line3:
{
contentType: LineContentType,
content: String
},
line4:
{
contentType: LineContentType,
content: String
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

addSystemAccountV30

Adds a new system account.

Version: 3.0
Synopsis: POST
Path: /organizations/systemaccount/add
Request Body: AddOrganizationSystemAccountsIdp
Response Headers: N/A
Response Body: AddOrganizationSystemAccountsIdpResponse

Request format:

POST /organizations/systemaccount/add

Authorization: Bearer <ssid>
Content-type: application/json

{
publicKey: String,
orgSystemAccounts: Set(String),
domains: Set(String),
description: String,
signingAlgorithm: SigningAlgorithm
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
identityProviderId: Integer,
identityProviderName: String
}

addTagFieldV30

Adds 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

Request format:

POST /organizations/tags/add

Authorization: Bearer <ssid>
Content-type: application/json

{
tagName: String,
tagType: DocumentTagType
}

Response format:

HTTP/1.1 200 OK

String

addUsersV30

Adds 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

Request format:

POST /organizations/users/add

Authorization: Bearer <ssid>
Content-type: application/json

{
users: List(
{
userEmail: String,
userDetails:
{
roles: Set(String),
aliases: Set(String),
userName: String,
permissionTemplateOverride: Boolean
}),
userUuid: String
}),
forceAction: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

bulkDeleteDistributionListV30

Deletes a set of distribution lists.

Version: 3.0
Synopsis: POST
Path: /organizations/distributionLists/delete
Request Body: DeleteOrganizationsDistributionLists
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/distributionLists/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
listNames: Set(String),
forceAction: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

changeActiveDirectorySettingsStatusV30

Enables or disables active directory.

Version: 3.0
Synopsis: POST
Path: /organizations/activeDirectory/settings/changeStatus
Request Body: ChangeActiveDirectorySettingsStatus
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/activeDirectory/settings/changeStatus

Authorization: Bearer <ssid>
Content-type: application/json

{
settingsUUID: String,
changeStatus: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

copyMembershipV30

Copies 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

Request format:

POST /organizations/users/memberships/copy

Authorization: Bearer <ssid>
Content-type: application/json

{
usersFrom: List(String),
userTo: String,
forceAction: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

createUemDirectoryRefV30

Adds 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.

Request format:

POST /organizations/uemDirectoryRef/{dirConnId}

Authorization: Bearer <ssid>
Content-type: application/json

{
members:
{
userMembers: List(String),
distributionListMembers: List(String),
activeDirectoryGroupsMembersGuids: Set(String)
}),
listName: String,
description: String,
forceAction: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteActiveDirectoryGroupsV30

Deletes 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

Request format:

POST /organizations/activeDirectory/groups/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
activeDirectoryGuids: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteActiveDirectorySettingsV30

Deletes active directory setting.

Version: 3.0
Synopsis: POST
Path: /organizations/activeDirectory/settings/delete
Request Body: DeleteActiveDirectorySettings
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/activeDirectory/settings/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
settingsUUID: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteDistributionListV30

Deletes 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.

Request format:

POST /organizations/distributionLists/{name}/delete

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteIdpSettingsV30

Deletes IDP settings for organization.

Version: 3.0
Synopsis: POST
Path: /organizations/idp/settings/delete
Request Body: DeleteIdpSettings
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/idp/settings/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
identityProviderId: Integer,
clientIds: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteOrganizationWatermarkV30

Deletes a watermark for an organization.

Version: 3.0
Synopsis: POST
Path: /organizations/watermarks/delete
Request Body: DeleteOrganizationWatermark
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/watermarks/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
watermarkPositions: Set(WaterMarkPosition )
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteSystemAccountV30

Removes a system account.

Version: 3.0
Synopsis: POST
Path: /organizations/systemaccount/delete
Request Body: DeleteOrganizationSystemAccountIdp
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/systemaccount/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
identityProviderId: Integer
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteTagFieldsV30

Deletes 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

Request format:

POST /organizations/tags/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
tagNames: List(String),
forceAction: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteUsersV30

Removes users from an organization.

Version: 3.0
Synopsis: POST
Path: /organizations/users/delete
Request Body: RemoveUsers
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/users/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
users: List(String),
userUuids: Set(String),
forceAction: Boolean,
targetUser: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

distributionListMembersV30

Gets 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.

Request format:

GET /organizations/distributionLists/{name}

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
userMembers: List(String),
distributionListMembers: List(String),
activeDirectoryGroupsMembersGuids: Set(String)
}

editActiveDirectoryGroupV30

Edits 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

Request format:

POST /organizations/activeDirectory/groups/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
activeDirectoryGroupGuid: String,
roles: Set(String),
forceAction: Boolean,
updateRoles: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

editActiveDirectorySettingsV30

Edits 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

Request format:

POST /organizations/activeDirectory/settings/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
uuid: String,
watchdoxDomainPermittedToActiveDirectory: Set(String),
serverAddresses: Set(String),
baseDN: String,
username: String,
password: String,
port: Integer,
globalCatalog: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
uuid: String
}

editConversionPolicyV30

Edits 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

Request format:

POST /organizations/conversion/policy/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
officeConversionTimeout: Integer,
daysTillDeletePdf: Integer
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

editExchangePolicyV30

Edits 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

Request format:

POST /organizations/documents/policies/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
allowPrintingToPdf: Boolean,
disableCurtain: Boolean,
disablePasscodeLock: Boolean,
allowNonControllableFileTypes: Boolean,
protectImagesInExchangeDocuments: Boolean,
useAutoComplete: Boolean,
enableSimpleSharing: Boolean,
simpleSharingDefault: Boolean,
disableWdSentItems: Boolean,
enableReadConfirmation: Boolean,
readConfirmByDefault: Boolean,
supportedTypes: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

editExternalTransactionStatusV30

Edits external transactions status.

Version: 3.0
Synopsis: POST
Path: /organizations/external/transactions/edit
Request Body: EditExternalTransactionStatusInput
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/external/transactions/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
transactionUUID: String,
resultJson: String,
status: TransactionStatusEnum
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

editIdpSettingsV30

Edits 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

Request format:

POST /organizations/idp/settings/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
identityProviderId: Integer,
defaultRefreshTokenTTL:
{
value: Integer
},
defaultAccessTokenTTL:
{
value: Integer
},
singleUseAccessTokenTTL:
{
value: Integer
},
defaultAutoRenewRefreshToken: Boolean,
clientsSettings: List(
{
clientId: String,
refreshTokenTTL:
{
value: Integer
},
accessTokenTTL:
{
value: Integer
},
autoRenewRefreshToken: Boolean
})
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

editOrganizationPolicyV30

Edits an organizational policy.

Version: 3.0
Synopsis: POST
Path: /organizations/policy/edit
Request Body: EditOrganizationPolicy
Response Headers: N/A
Response Body: OrganizationPolicy

Request format:

POST /organizations/policy/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
isAllowedToShareAnnotationsWithWorkspaceAdmins: Boolean,
isAllowedToShareAnnotationsWithAllWorkspaceGroups: Boolean,
isAllowedToShareAnnotationsWithSelectedGroups: Boolean,
isAllowedToShareAnnotationsWithUsersManually: Boolean,
allowDownloadOriginal: Boolean,
allowDownloadProtected: Boolean,
isAllowedToShareDocumentsWithWorkspaceAdmins: Boolean,
isAllowedToShareDocumentsWithAllWorkspaceGroups: Boolean,
isAllowedToShareDocumentsWithSelectedGroups: Boolean,
isAllowedToShareDocumentsWithUsersManually: Boolean,
allowMobileIos: Boolean,
allowMobileAndroid: Boolean,
allowMobileBlackberry: Boolean,
allowMobileWindowsMobile: Boolean,
deleteFromDisk: Boolean,
defaultChangeGroupsToAllDocs: Boolean,
defaultAddGroupsAsDefaultEntity: Boolean,
allowOpenOriginalsInOtherApps: Boolean,
allowOpenUnsupportedInOtherApps: Boolean,
enableSalesForce: Boolean,
enableWivi: Boolean,
enableOnlineViewerForUnsupportedBrowsers: Boolean,
allowLockingDocuments: Boolean,
useAutoComplete: Boolean,
autoCompleteAllowToAll: Boolean,
autoCompleteDisplayAll: Boolean,
enableSharingWithoutEmailNotification: Boolean,
shareFilesWithNotificationByDefault: Boolean,
isDisableOnBehalfOfForAllOutgoingEmails: Boolean,
sendWeeklyLicensingReport: Boolean,
sendWeeklyInternalDomainLicensingReport: Boolean,
uploadBandwidthLimit: Integer,
downloadBandwidthLimit: Integer,
enableBandwidthLimit: Boolean,
globalDownloadControlled: Boolean,
setEntitiesToDenyInOrg: Boolean,
entitiesToDenyInOrg: Set(
{
address: String,
entityType: EntityType
}),
setEntitiesToApproveInOrg: Boolean,
entitiesToApproveInOrg: Set(
{
address: String,
entityType: EntityType
}),
licenseHoursValid: Integer,
allowTrackingFromMicrosoftOfficeDocuments: Boolean,
blockNonProvisionedUsers: Boolean,
enableWopi: Boolean,
enableComments: Boolean,
commentsDefaultValue: Boolean,
enablePushNotifications: Boolean,
sendDailyActivityEmail: Boolean,
displayCommentContent: Boolean,
allowAdvancedPrinting: Boolean,
customizedNotificationsEmails: Boolean,
disallowChangeToPermissionTemplates: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isAllowedToShareAnnotationsWithWorkspaceAdmins: Boolean,
isAllowedToShareAnnotationsWithAllWorkspaceGroups: Boolean,
isAllowedToShareAnnotationsWithSelectedGroups: Boolean,
isAllowedToShareAnnotationsWithUsersManually: Boolean,
allowDownloadOriginal: Boolean,
allowDownloadProtected: Boolean,
isAllowedToShareDocumentsWithWorkspaceAdmins: Boolean,
isAllowedToShareDocumentsWithAllWorkspaceGroups: Boolean,
isAllowedToShareDocumentsWithSelectedGroups: Boolean,
isAllowedToShareDocumentsWithUsersManually: Boolean,
allowMobileIos: Boolean,
allowMobileAndroid: Boolean,
allowMobileBlackberry: Boolean,
allowMobileWindowsMobile: Boolean,
deleteFromDisk: Boolean,
licenseHoursValid: Integer,
defaultChangeGroupsToAllDocs: Boolean,
defaultAddGroupsAsDefaultEntity: Boolean,
allowOpenOriginalsInOtherApps: Boolean,
allowOpenUnsupportedInOtherApps: Boolean,
enableRmsSealing: Boolean,
uploadBandwidthLimit: Integer,
downloadBandwidthLimit: Integer,
enableBandwidthLimit: Boolean,
globalDownloadControlled: Boolean,
enableCloudStorageWorkspaces: Boolean,
allowTrackingFromMicrosoftOfficeDocuments: Boolean,
blockNonProvisionedUsers: Boolean,
enableSalesForce: Boolean,
enableWivi: Boolean,
enableOnlineViewerForUnsupportedBrowsers: Boolean,
enableWopi: Boolean,
allowLockingDocuments: Boolean,
useAutoComplete: Boolean,
autoCompleteAllowToAll: Boolean,
autoCompleteDisplayAll: Boolean,
wopiDiscoveryUrl: String,
enableSharingWithoutEmailNotification: Boolean,
shareFilesWithNotificationByDefault: Boolean,
isDisableOnBehalfOfForAllOutgoingEmails: Boolean,
enableComments: Boolean,
commentsDefaultValue: Boolean,
sendWeeklyLicensingReport: Boolean,
sendWeeklyInternalDomainLicensingReport: Boolean,
enablePushNotifications: Boolean,
sendMissingSetupNotificationEmails: Boolean,
sendDailyActivityEmail: Boolean,
enableFetchMembers: Boolean,
forcePinWorkspaces: Boolean,
displayCommentContent: Boolean,
allowAdvancedPrinting: Boolean,
customizedNotificationsEmails: Boolean,
disallowChangeToPermissionTemplates: Boolean
}

editOrganizationWatermarkV30

Edits an organizational watermark.

Version: 3.0
Synopsis: POST
Path: /organizations/watermarks/edit
Request Body: EditOrganizationWatermark
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/watermarks/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
watermarkPosition: WaterMarkPosition,
color: Color,
fontSize: Integer,
transparency: Integer,
line1:
{
contentType: LineContentType,
content: String
},
line2:
{
contentType: LineContentType,
content: String
},
line3:
{
contentType: LineContentType,
content: String
},
line4:
{
contentType: LineContentType,
content: String
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

editStoragePolicyV30

Edits 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

Request format:

POST /organizations/storage/policy/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
precentageTotalOrgThreshold: Integer,
sendOrgReportToSuperAdmins: Boolean,
sendOrgReportToAdmins: Boolean,
totalUserThresholdInMB: Integer,
sendUserReportToSuperAdmins: Boolean,
sendUserReportToAdmins: Boolean,
enableSendingUsersReport: Boolean,
daysTillPermanentlyDeleteFromRb: Integer,
inactivityDaysTillDeleteRoom: Integer,
inactivityDaysTillDeleteSdsFile: Integer,
numOfVersionsToKeepFiles: Integer,
changeVersionRetentionSettings: Boolean,
enableGFSVersionRetention: Boolean,
numOfDailyVersionsToKeep: Integer,
numOfWeeklyVersionsToKeep: Integer,
numOfMonthlyVersionsToKeep: Integer
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

editSystemAccountV30

Edits system accounts.

Version: 3.0
Synopsis: POST
Path: /organizations/systemaccount/edit
Request Body: EditOrganizationSystemAccountsIdp
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/systemaccount/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
identityProviderId: Integer,
publicKey: String,
orgSystemAccounts: Set(String),
domains: Set(String),
description: String,
signingAlgorithm: SigningAlgorithm,
updateDomainsAndOrgSystemAccounts: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

editTagV30

Edits 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

Request format:

POST /organizations/tags/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
currentName: String,
newName: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

editWorkspacesPolicyV30

Edits 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

Request format:

POST /organizations/rooms/policies/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
allowPrintingToPdf: Boolean,
disableCurtain: Boolean,
disablePasscodeLock: Boolean,
allowNonControllableFileTypes: Boolean,
protectImagesInWorkspaces: Boolean,
useAutoComplete: Boolean,
supportedTypes: Set(String),
allowEditDescription: Boolean,
logAccessActionsToFiles: Boolean,
enableReadConfirmation: Boolean,
readConfirmByDefault: Boolean,
fileUploadNotifyWorkspaceMembersDefault: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

exportGroupLogByIdsToCsvV30

Exports the groups log to CSV.

Version: 3.0
Synopsis: POST
Path: /organizations/logs/groups/ids/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.
groupIds: Set - - the ID's for the groups.
pageNumber: String - - the current page number for the operation in a pagination context.
pageSize: String - - the number of logs to include per page.
to: String - - the end date for the logs requested.

Request format:

POST /organizations/logs/groups/ids/csv/create

Authorization: Bearer <ssid>
Content-type: application/x-www-form-urlencoded

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

exportGroupLogByIdsToJsonV30

Exports 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 of type GroupLogRecord

Request format:

POST /organizations/logs/groups/ids/create

Authorization: Bearer <ssid>
Content-type: application/json

{
groupIds: Set(Integer),
from: Date,
to: Date,
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(GroupLogRecord )
}

exportGroupLogByRoomsToCsvV30

Exports 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 - - the ID's for the rooms.
to: String - - the end date for the logs requested.

Request format:

POST /organizations/logs/groups/rooms/csv/create

Authorization: Bearer <ssid>
Content-type: application/x-www-form-urlencoded

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

exportGroupLogByRoomsToJsonV30

Exports 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 of type GroupLogRecord

Request format:

POST /organizations/logs/groups/rooms/create

Authorization: Bearer <ssid>
Content-type: application/json

{
roomIds: Set(Integer),
from: Date,
to: Date,
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(GroupLogRecord )
}

exportGroupLogToJsonV30

Exports 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 of type GroupLogRecord

Request format:

POST /organizations/logs/groups/create

Authorization: Bearer <ssid>
Content-type: application/json

{
after: Date,
before: Date,
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(GroupLogRecord )
}

exportGroupLogV30

Exports 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

Request format:

POST /organizations/logs/groups/csv/create

Authorization: Bearer <ssid>
Content-type: application/json

{
after: Date,
before: Date,
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

InputStream

exportInternalDomainsReportCsvV30

Exports 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

Request format:

POST /organizations/reports/internalDomains/csv/create

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

exportLicensingReportCSVV30

Version: 3.0
Synopsis: POST
Path: /organizations/reports/licensing/csv/export
Request Body: N/A
Response Headers: N/A
Response Body: N/A

Request format:

POST /organizations/reports/licensing/csv/export

Authorization: Bearer <ssid>
Content-type: application/x-www-form-urlencoded

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

exportOrganizationRoleLogToJsonV30

Exports 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 of type OrganizationRoleLogRecord

Request format:

POST /organizations/logs/roles/create

Authorization: Bearer <ssid>
Content-type: application/json

{
after: Date,
before: Date,
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(OrganizationRoleLogRecord )
}

exportOrganizationRoleLogV30

Exports 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

Request format:

POST /organizations/logs/roles/csv/create

Authorization: Bearer <ssid>
Content-type: application/json

{
after: Date,
before: Date,
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

InputStream

exportRoomsReportCsvByMailV30

Version: 3.0
Synopsis: POST
Path: /organizations/reports/rooms/csv/exportByMail
Request Body: RoomsReportRequestByMail
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/reports/rooms/csv/exportByMail

Authorization: Bearer <ssid>
Content-type: application/json

{
reportFilter:
{
usersAddresses: Set(String),
roomIds: Set(Integer),
roomGuids: Set(String),
distributionListsNames: Set(String),
groups: Set(
{
roomId: Integer,
roomGuid: String,
groupName: String
}),
activeDirectoryGroupsGuids: Set(String)
}),
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
},
roomsReportOrder: RoomsReportOrder,
orderAscending: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

gemsServerUrlV30

Returns 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

Request format:

GET /organizations/gems/url

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
serverUrl: String,
username: String,
password: String
}

getAllTagsV30

Gets 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 of type TagField

Query parameters:

workspaceId: String - - the id of the workspace for which tags are being retrieved.

Request format:

GET /organizations/tags

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(TagField )
}

getAuthenticationPoliciesV30

Gets 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

Request format:

GET /organizations/rules/authentication/list

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
authenticationMethod: AuthenticationMethod,
secretQuestions: List(String),
passwordMaxLength: Integer,
passwordMinLength: Integer,
passwordMinUpCaseLetters: Integer,
passwordMinLoCaseLetters: Integer,
passwordMinSpecialSymbols: Integer,
passwordMinNumbers: Integer,
passwordBlackList: List(String),
maxPasswordEntryAttempts: Integer,
passwordLifeInDays: Integer,
rememberMeTokenValidityInDays: Integer,
passwordHistoryCount: Integer,
passwordHistoryDays: Integer,
editIdpTTLSettings:
{
defaultRefreshTokenTTL:
{
value: Integer
},
defaultAccessTokenTTL:
{
value: Integer
},
singleUseAccessTokenTTL:
{
value: Integer
},
defaultAutoRenewRefreshToken: Boolean,
clientsSettings: List(
{
clientId: String,
refreshTokenTTL:
{
value: Integer
},
accessTokenTTL:
{
value: Integer
},
autoRenewRefreshToken: Boolean
})
})
}

getBYOKAllRegionsV30

Get 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

Request format:

GET /organizations/byok/regions

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(KMSRegion )
}

getConversionPolicyV30

Gets 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

Request format:

GET /organizations/conversion/policy/list

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
officeConversionTimeout: Integer,
daysTillDeletePdf: Integer
}

getDefaultNotificationEmailV30

Gets 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

Request format:

GET /organizations/notification/email/default

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
notificationEmailSubject: String,
notificationEmailNote: String
}

getExchangePolicyV30

Gets 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

Request format:

GET /organizations/documents/policies/list

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
allowPrintingToPdf: Boolean,
disableCurtain: Boolean,
disablePasscodeLock: Boolean,
allowNonControllableFileTypes: Boolean,
protectImagesInExchangeDocuments: Boolean,
useAutoComplete: Boolean,
enableSimpleSharing: Boolean,
simpleSharingDefault: Boolean,
disableWdSentItems: Boolean,
enableReadConfirmation: Boolean,
readConfirmByDefault: Boolean,
supportedTypes: Set(String)
}

getExternalTransactionStatusV30

Gets external transactions status.

Version: 3.0
Synopsis: POST
Path: /organizations/external/transactions/status
Request Body: ExternalTransactionInput
Response Headers: N/A
Response Body: ExternalTransactionStatus

Request format:

POST /organizations/external/transactions/status

Authorization: Bearer <ssid>
Content-type: application/json

{
transactionUUID: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
transactionUUID: String,
resultJson: String,
status: TransactionStatusEnum,
bulkOperationResultJson:
{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
})
}

getLogoV30

Get 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.

Request format:

GET /organizationswhitelabel/{orgId}

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

InputStream

getOrganizationActiveBYOKV30

Get organization active BYOK

Version: 3.0
Synopsis: GET
Path: /organizations/byok/active
Request Body: N/A
Response Headers: N/A
Response Body: OrganizationActiveBYOK

Request format:

GET /organizations/byok/active

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
uuid: String,
region: String,
selfGeneratedKey: String
}

getOrganizationLicenseExpirationTimeV30

Version: 3.0
Synopsis: POST
Path: /organizations/license/expirationtime
Request Body: OrgLicenseExpirationTimeRequest
Response Headers: N/A
Response Body: OrgLicenseExpirationTimeResponse

Request format:

POST /organizations/license/expirationtime

Authorization: Bearer <ssid>
Content-type: application/json

{
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
licenseExpirationTime: Date
}

getOrganizationLicenseSubscriptionInfoV30

Version: 3.0
Synopsis: POST
Path: /organizations/license/subscriptionInfo
Request Body: OrgLicenseSubscriptionInfoRequest
Response Headers: N/A
Response Body: OrgLicenseSubscriptionInfoResponse

Request format:

POST /organizations/license/subscriptionInfo

Authorization: Bearer <ssid>
Content-type: application/json

{
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
licenseExpirationTime: Date,
InternalUsers: long,
ExternalUsers: long
}

getProtectAnywherePolicyV30

Gets 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

Request format:

POST /organizations/protectAnywhere/policy/list

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
whitelistUsers: Set(String)
}

getStoragePolicyV30

Gets 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

Request format:

POST /organizations/storage/policy/list

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
precentageTotalOrgThreshold: Integer,
sendOrgReportToSuperAdmins: Boolean,
sendOrgReportToAdmins: Boolean,
totalUserThresholdInMB: Integer,
sendUserReportToSuperAdmins: Boolean,
sendUserReportToAdmins: Boolean,
enableSendingUsersReport: Boolean,
daysTillPermanentlyDeleteFromRb: Integer,
inactivityDaysTillDeleteRoom: Integer,
inactivityDaysTillDeleteSdsFile: Integer,
numOfVersionsToKeepFiles: Integer,
enableGFSVersionRetention: Boolean,
numOfDailyVersionsToKeep: Integer,
numOfWeeklyVersionsToKeep: Integer,
numOfMonthlyVersionsToKeep: Integer
}

getTagValuesListV30

Returns 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 - the workspace types for which tags are being retrieved.

Request format:

POST /organizations/tags/values/list

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
tags: List(
{
name: String,
type: String,
values: List(String)
})
}

getUserAuthenticationLoggingInitialDateV30

Version: 3.0
Synopsis: POST
Path: /organizations/reports/audit/userAuthentication/logging/startDate/list
Request Body: OrgLicenseSubscriptionInfoRequest
Response Headers: N/A
Response Body: UserAuthenticationLoggingInitialDateResponse

Request format:

POST /organizations/reports/audit/userAuthentication/logging/startDate/list

Authorization: Bearer <ssid>
Content-type: application/json

{
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
logCollectionStartDate: Date
}

getUserReportV30

Creates 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 of type UserReport

Request format:

POST /organizations/reports/users/create

Authorization: Bearer <ssid>
Content-type: application/json

{
reportFilter:
{
usersAddresses: Set(String),
roomIds: Set(Integer),
roomGuids: Set(String),
distributionListsNames: Set(String),
groups: Set(
{
roomId: Integer,
roomGuid: String,
groupName: String
}),
activeDirectoryGroupsGuids: Set(String)
}),
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
},
usersOrder: UsersReportOrder,
orderAscending: Boolean,
useLocalLang: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(UserReport )
}

getWorkspacesPolicyV30

Lists 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

Request format:

GET /organizations/rooms/policies/list

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
allowPrintingToPdf: Boolean,
disableCurtain: Boolean,
disablePasscodeLock: Boolean,
allowNonControllableFileTypes: Boolean,
protectImagesInWorkspaces: Boolean,
useAutoComplete: Boolean,
supportedTypes: Set(String),
allowEditDescription: Boolean,
logAccessActionsToFiles: Boolean,
enableReadConfirmation: Boolean,
readConfirmByDefault: Boolean,
fileUploadNotifyWorkspaceMembersDefault: Boolean
}

isActiveDirectorySettingsEnabledV30

Lists whether active directory is configured.

Version: 3.0
Synopsis: POST
Path: /organizations/activeDirectory/isEnabled
Request Body: IsActiveDirectorySettingsEnabled
Response Headers: N/A
Response Body: IsActiveDirectoryConfiguredResult

Request format:

POST /organizations/activeDirectory/isEnabled

Authorization: Bearer <ssid>
Content-type: application/json

{
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isConfigured: Boolean
}

listActiveDirectoryGroupsV30

Lists 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 of type ActiveDirectoryGroupInfo

Request format:

POST /organizations/activeDirectory/groups/list

Authorization: Bearer <ssid>
Content-type: application/json

{
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
},
orderAscending: Boolean,
activeDirectoryOrder: ActiveDirectoryGroupOrder
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(ActiveDirectoryGroupInfo )
}

listActiveDirectorySettingsV30

Lists 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 of type ActiveDirectorySettings

Request format:

POST /organizations/activeDirectory/settings/list

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(ActiveDirectorySettings )
}

listDistrbutionListsV30

Returns 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 of type DistributionList

Request format:

POST /organizations/distributionLists/list

Authorization: Bearer <ssid>
Content-type: application/json

{
includeMemebers: Boolean,
pagination:
{
pageSize: Integer,
pageNumber: Integer
},
distributionlistsOrder: DistributionlistsOrder,
ascending: Boolean,
groupTypeRequest: GroupTypeRequest
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(DistributionList )
}

listDistributionListsByNameV30

Gets 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 of type DistributionList

Request format:

POST /organizations/distributionLists/listByName

Authorization: Bearer <ssid>
Content-type: application/json

{
listNames: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(DistributionList )
}

listDomainsV30

Lists domains with roles.

Version: 3.0
Synopsis: POST
Path: /organizations/domains/list
Request Body: ListDomains
Response Headers: N/A
Response Body: PagingItemListJson of type Domain

Request format:

POST /organizations/domains/list

Authorization: Bearer <ssid>
Content-type: application/json

{
pagination:
{
pageSize: Integer,
pageNumber: Integer
},
domainsOrder: DomainsOrder,
ascending: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(Domain )
}

listExternalConnectorsV30

List 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 of type ListExternalConnectorsResult

Request format:

POST /organizations/connectors/list

Authorization: Bearer <ssid>
Content-type: application/json

{
externalRepositoryTypes: Set(ExternalRepositoryType )
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(ListExternalConnectorsResult )
}

listIdpSettingsV30

Lists 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 of type ListIdpSettingsResultItem

Request format:

POST /organizations/idp/settings/list

Authorization: Bearer <ssid>
Content-type: application/json

{
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(ListIdpSettingsResultItem )
}

listInternalDomainsForOrganizationResponseJsonV30

Lists internal domains for organization.

Version: 3.0
Synopsis: POST
Path: /organizations/internalDomains/list
Request Body: ListInternalDomainsForOrganizationRequest
Response Headers: N/A
Response Body: ListInternalDomainsForOrganizationResponse

Request format:

POST /organizations/internalDomains/list

Authorization: Bearer <ssid>
Content-type: application/json

{
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
internalDomains: Set(String)
}

listOrganizationBlacklistingV30

Lists an organization blacklist.

Version: 3.0
Synopsis: POST
Path: /organizations/policy/blacklist/list
Request Body: ListOrganizationBlacklisting
Response Headers: N/A
Response Body: PagingItemListJson of type ListOrganizationBlacklistingResult

Request format:

POST /organizations/policy/blacklist/list

Authorization: Bearer <ssid>
Content-type: application/json

{
pagingData:
{
pageSize: Integer,
pageNumber: Integer
},
ascending: Boolean,
userEmails: Set(String),
returnNamesAndAddresses: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(ListOrganizationBlacklistingResult )
}

listOrganizationPolicyV30

Lists organizational policy.

Version: 3.0
Synopsis: POST
Path: /organizations/policy/list
Request Body: N/A
Response Headers: N/A
Response Body: OrganizationPolicy

Request format:

POST /organizations/policy/list

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isAllowedToShareAnnotationsWithWorkspaceAdmins: Boolean,
isAllowedToShareAnnotationsWithAllWorkspaceGroups: Boolean,
isAllowedToShareAnnotationsWithSelectedGroups: Boolean,
isAllowedToShareAnnotationsWithUsersManually: Boolean,
allowDownloadOriginal: Boolean,
allowDownloadProtected: Boolean,
isAllowedToShareDocumentsWithWorkspaceAdmins: Boolean,
isAllowedToShareDocumentsWithAllWorkspaceGroups: Boolean,
isAllowedToShareDocumentsWithSelectedGroups: Boolean,
isAllowedToShareDocumentsWithUsersManually: Boolean,
allowMobileIos: Boolean,
allowMobileAndroid: Boolean,
allowMobileBlackberry: Boolean,
allowMobileWindowsMobile: Boolean,
deleteFromDisk: Boolean,
licenseHoursValid: Integer,
defaultChangeGroupsToAllDocs: Boolean,
defaultAddGroupsAsDefaultEntity: Boolean,
allowOpenOriginalsInOtherApps: Boolean,
allowOpenUnsupportedInOtherApps: Boolean,
enableRmsSealing: Boolean,
uploadBandwidthLimit: Integer,
downloadBandwidthLimit: Integer,
enableBandwidthLimit: Boolean,
globalDownloadControlled: Boolean,
enableCloudStorageWorkspaces: Boolean,
allowTrackingFromMicrosoftOfficeDocuments: Boolean,
blockNonProvisionedUsers: Boolean,
enableSalesForce: Boolean,
enableWivi: Boolean,
enableOnlineViewerForUnsupportedBrowsers: Boolean,
enableWopi: Boolean,
allowLockingDocuments: Boolean,
useAutoComplete: Boolean,
autoCompleteAllowToAll: Boolean,
autoCompleteDisplayAll: Boolean,
wopiDiscoveryUrl: String,
enableSharingWithoutEmailNotification: Boolean,
shareFilesWithNotificationByDefault: Boolean,
isDisableOnBehalfOfForAllOutgoingEmails: Boolean,
enableComments: Boolean,
commentsDefaultValue: Boolean,
sendWeeklyLicensingReport: Boolean,
sendWeeklyInternalDomainLicensingReport: Boolean,
enablePushNotifications: Boolean,
sendMissingSetupNotificationEmails: Boolean,
sendDailyActivityEmail: Boolean,
enableFetchMembers: Boolean,
forcePinWorkspaces: Boolean,
displayCommentContent: Boolean,
allowAdvancedPrinting: Boolean,
customizedNotificationsEmails: Boolean,
disallowChangeToPermissionTemplates: Boolean
}

listOrganizationPolicyV30

Lists organizational policy.

Version: 3.0
Synopsis: POST
Path: /organizations/policy/document/list
Request Body: ListOrganizationPolicy
Response Headers: N/A
Response Body: OrganizationPolicy

Request format:

POST /organizations/policy/document/list

Authorization: Bearer <ssid>
Content-type: application/json

{
documentGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isAllowedToShareAnnotationsWithWorkspaceAdmins: Boolean,
isAllowedToShareAnnotationsWithAllWorkspaceGroups: Boolean,
isAllowedToShareAnnotationsWithSelectedGroups: Boolean,
isAllowedToShareAnnotationsWithUsersManually: Boolean,
allowDownloadOriginal: Boolean,
allowDownloadProtected: Boolean,
isAllowedToShareDocumentsWithWorkspaceAdmins: Boolean,
isAllowedToShareDocumentsWithAllWorkspaceGroups: Boolean,
isAllowedToShareDocumentsWithSelectedGroups: Boolean,
isAllowedToShareDocumentsWithUsersManually: Boolean,
allowMobileIos: Boolean,
allowMobileAndroid: Boolean,
allowMobileBlackberry: Boolean,
allowMobileWindowsMobile: Boolean,
deleteFromDisk: Boolean,
licenseHoursValid: Integer,
defaultChangeGroupsToAllDocs: Boolean,
defaultAddGroupsAsDefaultEntity: Boolean,
allowOpenOriginalsInOtherApps: Boolean,
allowOpenUnsupportedInOtherApps: Boolean,
enableRmsSealing: Boolean,
uploadBandwidthLimit: Integer,
downloadBandwidthLimit: Integer,
enableBandwidthLimit: Boolean,
globalDownloadControlled: Boolean,
enableCloudStorageWorkspaces: Boolean,
allowTrackingFromMicrosoftOfficeDocuments: Boolean,
blockNonProvisionedUsers: Boolean,
enableSalesForce: Boolean,
enableWivi: Boolean,
enableOnlineViewerForUnsupportedBrowsers: Boolean,
enableWopi: Boolean,
allowLockingDocuments: Boolean,
useAutoComplete: Boolean,
autoCompleteAllowToAll: Boolean,
autoCompleteDisplayAll: Boolean,
wopiDiscoveryUrl: String,
enableSharingWithoutEmailNotification: Boolean,
shareFilesWithNotificationByDefault: Boolean,
isDisableOnBehalfOfForAllOutgoingEmails: Boolean,
enableComments: Boolean,
commentsDefaultValue: Boolean,
sendWeeklyLicensingReport: Boolean,
sendWeeklyInternalDomainLicensingReport: Boolean,
enablePushNotifications: Boolean,
sendMissingSetupNotificationEmails: Boolean,
sendDailyActivityEmail: Boolean,
enableFetchMembers: Boolean,
forcePinWorkspaces: Boolean,
displayCommentContent: Boolean,
allowAdvancedPrinting: Boolean,
customizedNotificationsEmails: Boolean,
disallowChangeToPermissionTemplates: Boolean
}

listOrganizationWatermarkV30

Lists 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 of type OrganizationWatermarkConfig

Request format:

POST /organizations/watermarks/list

Authorization: Bearer <ssid>
Content-type: application/json

{
watermarkPositions: Set(WaterMarkPosition )
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(OrganizationWatermarkConfig )
}

listPagingTagsV30

Lists 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 of type TagRecord

Request format:

POST /organizations/tags/list

Authorization: Bearer <ssid>
Content-type: application/json

{
pagination:
{
pageSize: Integer,
pageNumber: Integer
},
getTagsOrder: TagsOrder,
ascending: Boolean,
workspaceId: Integer,
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(TagRecord )
}

listPendingNumberPermissionRequestsV30

Lists 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

Request format:

POST /organizations/permissions/requests/listPending

Authorization: Bearer <ssid>
Content-type: application/json

{
adminMode: Boolean,
workspaceTypes: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
filePermissionRequestsNumber: Integer,
workspacePermissionRequestsNumber: Integer,
transientDocumentPermissionRequestsNumber: Integer,
transientWorkspacePermissionRequestsNumber: Integer
}

listSystemAccountV30

Lists system accounts for an organization.

Version: 3.0
Synopsis: POST
Path: /organizations/systemaccount/list
Request Body: ListOrganizationSystemAccountsIdp
Response Headers: N/A
Response Body: ItemListJson of type ListSystemAccountItem

Request format:

POST /organizations/systemaccount/list

Authorization: Bearer <ssid>
Content-type: application/json

{
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(ListSystemAccountItem )
}

removeMembersFromDistributionListV30

Removes 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.

Request format:

POST /organizations/distributionLists/{name}/members/remove

Authorization: Bearer <ssid>
Content-type: application/json

{
userMembers: List(String),
distributionListMembers: List(String),
activeDirectoryGroupsMembersGuids: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

removeOrganizationBlacklistingV30

Removes 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

Request format:

POST /organizations/policy/blacklist/remove

Authorization: Bearer <ssid>
Content-type: application/json

{
permittedEntitiesToBlacklist: Set(
{
address: String,
entityType: EntityType
})
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

renameDistributionListV30

Renames 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).

Request format:

POST /organizations/distributionLists/{name}/rename

Authorization: Bearer <ssid>
Content-type: application/json

{
newName: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

resetPasswordV30

Resets 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

Request format:

POST /organizations/rules/authentication/resetPassword

Authorization: Bearer <ssid>
Content-type: application/json

{
users: List(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

revokeBYOKV30

revoke organization from being BYOK

Version: 3.0
Synopsis: GET
Path: /organizationsbyok/revoke
Request Body: N/A
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

GET /organizationsbyok/revoke

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

searchActiveDirectoryGroupsV30

Searches 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 of type ActiveDirectoryGroupSuggestion

Request format:

POST /organizations/activeDirectory/groups/search

Authorization: Bearer <ssid>
Content-type: application/json

{
partialName: String,
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
},
entityTypesToFind: Set(ADGroupType )
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(ActiveDirectoryGroupSuggestion )
}

searchExistingActiveDirectoryGroupsV30

Searches 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 of type ExistingActiveDirectoryGroupSuggestion

Request format:

POST /organizations/activeDirectory/groups/searchExisting

Authorization: Bearer <ssid>
Content-type: application/json

{
partialName: String,
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(ExistingActiveDirectoryGroupSuggestion )
}

sendSupportEmailV30

Version: 3.0
Synopsis: POST
Path: /organizations/support/email/send
Request Body: SendSupportEmail
Response Headers: N/A
Response Body: N/A

Request format:

POST /organizations/support/email/send

Authorization: Bearer <ssid>
Content-type: application/json

{
emailBody: String
}

Response format:

HTTP/1.1 200 OK

String

setAuthenticationPoliciesV30

Sets 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

Request format:

POST /organizations/rules/authentication/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
authenticationMethod: AuthenticationMethod,
secretQuestions: List(String),
passwordMaxLength: Integer,
passwordMinLength: Integer,
passwordMinUpCaseLetters: Integer,
passwordMinLoCaseLetters: Integer,
passwordMinSpecialSymbols: Integer,
passwordMinNumbers: Integer,
passwordBlackList: List(String),
maxPasswordEntryAttempts: Integer,
passwordLifeInDays: Integer,
rememberMeTokenValidityInDays: Integer,
passwordHistoryCount: Integer,
passwordHistoryDays: Integer,
editIdpTTLSettings:
{
defaultRefreshTokenTTL:
{
value: Integer
},
defaultAccessTokenTTL:
{
value: Integer
},
singleUseAccessTokenTTL:
{
value: Integer
},
defaultAutoRenewRefreshToken: Boolean,
clientsSettings: List(
{
clientId: String,
refreshTokenTTL:
{
value: Integer
},
accessTokenTTL:
{
value: Integer
},
autoRenewRefreshToken: Boolean
})
})
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

setInternalDomainsForOrganizationResponseJsonV30

Sets internal domains for the organization.

Version: 3.0
Synopsis: POST
Path: /organizations/internalDomains/set
Request Body: ListInternalDomainsForOrganizationResponse
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/internalDomains/set

Authorization: Bearer <ssid>
Content-type: application/json

{
internalDomains: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

setProtectAnywherePolicyV30

Sets 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

Request format:

POST /organizations/protectAnywhere/policy/set

Authorization: Bearer <ssid>
Content-type: application/json

{
whitelistUsers: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

void

validateUsersNotAdminsInWorkspacesV30

Validates 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

Request format:

POST /organizations/users/delete/validateAdmins

Authorization: Bearer <ssid>
Content-type: application/json

{
userAddresses: Set(String),
userUuids: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
allowDeleteByMovePermissionsOnly: Boolean
}

verifyActiveDirectorySettingsV30

Verifies Active Directory settings.

Version: 3.0
Synopsis: POST
Path: /organizations/activeDirectory/settings/verify
Request Body: VerifyActiveDirectorySettings
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /organizations/activeDirectory/settings/verify

Authorization: Bearer <ssid>
Content-type: application/json

{
settingsUUID: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}