Created by Docfx
  • Home
  • API Documentation
  • API Documentation
Show / Hide Table of Contents

Namespace Dropbox.Api.Team

Classes

ActiveWebSession

Information on active web sessions.

AddSecondaryEmailResult

Result of trying to add a secondary email to a user. 'success' is the only value indicating that a secondary email was successfully added to a user. The other values explain the type of error that occurred, and include the email for which the error occurred.

AddSecondaryEmailResult.AlreadyOwnedByUser

Secondary email is already a verified email for the user.

AddSecondaryEmailResult.AlreadyPending

Secondary email is already a pending email for the user.

AddSecondaryEmailResult.Other

The other object

AddSecondaryEmailResult.RateLimited

Too many emails are being sent to this email address. Please try again later.

AddSecondaryEmailResult.ReachedLimit

User already has the maximum number of secondary emails allowed.

AddSecondaryEmailResult.Success

Describes a secondary email that was successfully added to a user.

AddSecondaryEmailResult.TooManyUpdates

An error occurred due to conflicting updates. Please try again later.

AddSecondaryEmailResult.TransientError

A transient error occurred. Please try again later.

AddSecondaryEmailResult.Unavailable

Secondary email is not available to be claimed by the user.

AddSecondaryEmailResult.UnknownError

An unknown error occurred.

AddSecondaryEmailsArg

The add secondary emails arg object

AddSecondaryEmailsError

Error returned when adding secondary emails fails.

AddSecondaryEmailsError.Other

The other object

AddSecondaryEmailsError.SecondaryEmailsDisabled

Secondary emails are disabled for the team.

AddSecondaryEmailsError.TooManyEmails

A maximum of 20 secondary emails can be added in a single call.

AddSecondaryEmailsResult

The add secondary emails result object

AdminTier

Describes which team-related admin permissions a user has.

AdminTier.MemberOnly

User is not an admin of the team.

AdminTier.SupportAdmin

User can do a limited set of common support tasks for existing users. Note: Dropbox is adding new types of admin roles; these may display as support_admin.

AdminTier.TeamAdmin

User is an administrator of the team - has all permissions.

AdminTier.UserManagementAdmin

User can do most user provisioning, de-provisioning and management.

ApiApp

Information on linked third party applications.

BaseDfbReport

Base report structure.

BaseTeamFolderError

Base error that all errors for existing team folders should extend.

BaseTeamFolderError.AccessError

The access error object

BaseTeamFolderError.Other

The other object

BaseTeamFolderError.StatusError

The status error object

BaseTeamFolderError.TeamSharedDropboxError

The team shared dropbox error object

CustomQuotaError

Error returned when getting member custom quota.

CustomQuotaError.Other

The other object

CustomQuotaError.TooManyUsers

A maximum of 1000 users can be set for a single call.

CustomQuotaResult

User custom quota.

CustomQuotaResult.InvalidUser

Invalid user (not in team).

CustomQuotaResult.Other

The other object

CustomQuotaResult.Success

User's custom quota.

CustomQuotaUsersArg

The custom quota users arg object

DateRange

Input arguments that can be provided for most reports.

DateRangeError

Errors that can originate from problems in input arguments to reports.

DateRangeError.Other

The other object

DeleteSecondaryEmailResult

Result of trying to delete a secondary email address. 'success' is the only value indicating that a secondary email was successfully deleted. The other values explain the type of error that occurred, and include the email for which the error occurred.

DeleteSecondaryEmailResult.CannotRemovePrimary

The email address is the primary email address of the user, and cannot be removed.

DeleteSecondaryEmailResult.NotFound

The email address was not found for the user.

DeleteSecondaryEmailResult.Other

The other object

DeleteSecondaryEmailResult.Success

The secondary email was successfully deleted.

DeleteSecondaryEmailsArg

The delete secondary emails arg object

DeleteSecondaryEmailsResult

The delete secondary emails result object

DesktopClientSession

Information about linked Dropbox desktop client sessions.

DesktopPlatform

The desktop platform object

DesktopPlatform.Linux

Official Linux Dropbox desktop client.

DesktopPlatform.Mac

Official Mac Dropbox desktop client.

DesktopPlatform.Other

The other object

DesktopPlatform.Windows

Official Windows Dropbox desktop client.

DevicesActive

Each of the items is an array of values, one value per day. The value is the number of devices active within a time window, ending with that day.

If there is no data for a day, then the value will be None.

DeviceSession

The device session object

DeviceSessionArg

The device session arg object

ExcludedUsersListArg

Excluded users list argument.

ExcludedUsersListContinueArg

Excluded users list continue argument.

ExcludedUsersListContinueError

Excluded users list continue error.

ExcludedUsersListContinueError.InvalidCursor

The cursor is invalid.

ExcludedUsersListContinueError.Other

The other object

ExcludedUsersListError

Excluded users list error.

ExcludedUsersListError.ListError

An error occurred.

ExcludedUsersListError.Other

The other object

ExcludedUsersListResult

Excluded users list result.

ExcludedUsersUpdateArg

Argument of excluded users update operation. Should include a list of users to add/remove (according to endpoint), Maximum size of the list is 1000 users.

ExcludedUsersUpdateError

Excluded users update error.

ExcludedUsersUpdateError.Other

The other object

ExcludedUsersUpdateError.TooManyUsers

A maximum of 1000 users for each of addition/removal can be supplied.

ExcludedUsersUpdateError.UsersNotInTeam

At least one of the users is not part of your team.

ExcludedUsersUpdateResult

Excluded users update result.

ExcludedUsersUpdateStatus

Excluded users update operation status.

ExcludedUsersUpdateStatus.Other

The other object

ExcludedUsersUpdateStatus.Success

Update successful.

Feature

A set of features that a Dropbox Business account may support.

Feature.HasTeamFileEvents

Does this team have file events.

Feature.HasTeamSelectiveSync

Does this team have team selective sync enabled.

Feature.HasTeamSharedDropbox

Does this team have a shared team root.

Feature.Other

The other object

Feature.UploadApiRateLimit

The number of upload API calls allowed per month.

FeaturesGetValuesBatchArg

The features get values batch arg object

FeaturesGetValuesBatchError

The features get values batch error object

FeaturesGetValuesBatchError.EmptyFeaturesList

At least one Feature must be included in the FeaturesGetValuesBatchArg.features list.

FeaturesGetValuesBatchError.Other

The other object

FeaturesGetValuesBatchResult

The features get values batch result object

FeatureValue

The values correspond to entries in Feature. You may get different value according to your Dropbox Business plan.

FeatureValue.HasTeamFileEvents

The has team file events object

FeatureValue.HasTeamSelectiveSync

The has team selective sync object

FeatureValue.HasTeamSharedDropbox

The has team shared dropbox object

FeatureValue.Other

The other object

FeatureValue.UploadApiRateLimit

The upload api rate limit object

GetActivityReport

Activity Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.

GetDevicesReport

Devices Report Result. Contains subsections for different time ranges of activity. Each of the items in each subsection of the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.

GetMembershipReport

Membership Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.

GetStorageReport

Storage Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.

GroupAccessType

Role of a user in group.

GroupAccessType.Member

User is a member of the group, but has no special permissions.

GroupAccessType.Owner

User can rename the group, and add/remove members.

GroupCreateArg

The group create arg object

GroupCreateError

The group create error object

GroupCreateError.ExternalIdAlreadyInUse

The requested external ID is already being used by another group.

GroupCreateError.GroupNameAlreadyUsed

The requested group name is already being used by another group.

GroupCreateError.GroupNameInvalid

Group name is empty or has invalid characters.

GroupCreateError.Other

The other object

GroupCreateError.SystemManagedGroupDisallowed

System-managed group cannot be manually created.

GroupDeleteError

The group delete error object

GroupDeleteError.GroupAlreadyDeleted

This group has already been deleted.

GroupDeleteError.GroupNotFound

No matching group found. No groups match the specified group ID.

GroupDeleteError.Other

The other object

GroupDeleteError.SystemManagedGroupDisallowed

This operation is not supported on system-managed groups.

GroupFullInfo

Full description of a group.

GroupMemberInfo

Profile of group member, and role in group.

GroupMembersAddArg

The group members add arg object

GroupMembersAddError

The group members add error object

GroupMembersAddError.DuplicateUser

You cannot add duplicate users. One or more of the members you are trying to add is already a member of the group.

GroupMembersAddError.GroupNotFound

No matching group found. No groups match the specified group ID.

GroupMembersAddError.GroupNotInTeam

Group is not in this team. You cannot add members to a group that is outside of your team.

GroupMembersAddError.MembersNotInTeam

These members are not part of your team. Currently, you cannot add members to a group if they are not part of your team, though this may change in a subsequent version. To add new members to your Dropbox Business team, use the MembersAddAsync(MembersAddArg) endpoint.

GroupMembersAddError.Other

The other object

GroupMembersAddError.SystemManagedGroupDisallowed

This operation is not supported on system-managed groups.

GroupMembersAddError.UserCannotBeManagerOfCompanyManagedGroup

A company-managed group cannot be managed by a user.

GroupMembersAddError.UserMustBeActiveToBeOwner

A suspended user cannot be added to a group as GroupAccessType.Owner.

GroupMembersAddError.UsersNotFound

These users were not found in Dropbox.

GroupMembersChangeResult

Result returned by GroupsMembersAddAsync(GroupMembersAddArg) and GroupsMembersRemoveAsync(GroupMembersRemoveArg).

GroupMemberSelector

Argument for selecting a group and a single user.

GroupMemberSelectorError

Error that can be raised when GroupMemberSelector is used, and the user is required to be a member of the specified group.

GroupMemberSelectorError.GroupNotFound

No matching group found. No groups match the specified group ID.

GroupMemberSelectorError.MemberNotInGroup

The specified user is not a member of this group.

GroupMemberSelectorError.Other

The other object

GroupMemberSelectorError.SystemManagedGroupDisallowed

This operation is not supported on system-managed groups.

GroupMemberSetAccessTypeError

The group member set access type error object

GroupMemberSetAccessTypeError.GroupNotFound

No matching group found. No groups match the specified group ID.

GroupMemberSetAccessTypeError.MemberNotInGroup

The specified user is not a member of this group.

GroupMemberSetAccessTypeError.Other

The other object

GroupMemberSetAccessTypeError.SystemManagedGroupDisallowed

This operation is not supported on system-managed groups.

GroupMemberSetAccessTypeError.UserCannotBeManagerOfCompanyManagedGroup

A company managed group cannot be managed by a user.

GroupMembersRemoveArg

The group members remove arg object

GroupMembersRemoveError

The group members remove error object

GroupMembersRemoveError.GroupNotFound

No matching group found. No groups match the specified group ID.

GroupMembersRemoveError.GroupNotInTeam

Group is not in this team. You cannot remove members from a group that is outside of your team.

GroupMembersRemoveError.MemberNotInGroup

At least one of the specified users is not a member of the group.

GroupMembersRemoveError.MembersNotInTeam

These members are not part of your team.

GroupMembersRemoveError.Other

The other object

GroupMembersRemoveError.SystemManagedGroupDisallowed

This operation is not supported on system-managed groups.

GroupMembersRemoveError.UsersNotFound

These users were not found in Dropbox.

GroupMembersSelector

Argument for selecting a group and a list of users.

GroupMembersSelectorError

Error that can be raised when GroupMembersSelector is used, and the users are required to be members of the specified group.

GroupMembersSelectorError.GroupNotFound

No matching group found. No groups match the specified group ID.

GroupMembersSelectorError.MemberNotInGroup

At least one of the specified users is not a member of the group.

GroupMembersSelectorError.Other

The other object

GroupMembersSelectorError.SystemManagedGroupDisallowed

This operation is not supported on system-managed groups.

GroupMembersSetAccessTypeArg

The group members set access type arg object

GroupSelector

Argument for selecting a single group, either by group_id or by external group ID.

GroupSelector.GroupExternalId

External ID of the group.

GroupSelector.GroupId

Group ID.

GroupSelectorError

Error that can be raised when GroupSelector is used.

GroupSelectorError.GroupNotFound

No matching group found. No groups match the specified group ID.

GroupSelectorError.Other

The other object

GroupSelectorWithTeamGroupError

Error that can be raised when GroupSelector is used and team groups are disallowed from being used.

GroupSelectorWithTeamGroupError.GroupNotFound

No matching group found. No groups match the specified group ID.

GroupSelectorWithTeamGroupError.Other

The other object

GroupSelectorWithTeamGroupError.SystemManagedGroupDisallowed

This operation is not supported on system-managed groups.

GroupsGetInfoError

The groups get info error object

GroupsGetInfoError.GroupNotOnTeam

The group is not on your team.

GroupsGetInfoError.Other

The other object

GroupsGetInfoItem

The groups get info item object

GroupsGetInfoItem.GroupInfo

Info about a group.

GroupsGetInfoItem.IdNotFound

An ID that was provided as a parameter to GroupsGetInfoAsync(GroupsSelector), and did not match a corresponding group. The ID can be a group ID, or an external ID, depending on how the method was called.

GroupsListArg

The groups list arg object

GroupsListContinueArg

The groups list continue arg object

GroupsListContinueError

The groups list continue error object

GroupsListContinueError.InvalidCursor

The cursor is invalid.

GroupsListContinueError.Other

The other object

GroupsListResult

The groups list result object

GroupsMembersListArg

The groups members list arg object

GroupsMembersListContinueArg

The groups members list continue arg object

GroupsMembersListContinueError

The groups members list continue error object

GroupsMembersListContinueError.InvalidCursor

The cursor is invalid.

GroupsMembersListContinueError.Other

The other object

GroupsMembersListResult

The groups members list result object

GroupsPollError

The groups poll error object

GroupsPollError.AccessDenied

You are not allowed to poll this job.

GroupsPollError.InternalError

Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

GroupsPollError.InvalidAsyncJobId

The job ID is invalid.

GroupsPollError.Other

The other object

GroupsSelector

Argument for selecting a list of groups, either by group_ids, or external group IDs.

GroupsSelector.GroupExternalIds

List of external IDs of groups.

GroupsSelector.GroupIds

List of group IDs.

GroupUpdateArgs

The group update args object

GroupUpdateError

The group update error object

GroupUpdateError.ExternalIdAlreadyInUse

The requested external ID is already being used by another group.

GroupUpdateError.GroupNameAlreadyUsed

The requested group name is already being used by another group.

GroupUpdateError.GroupNameInvalid

Group name is empty or has invalid characters.

GroupUpdateError.GroupNotFound

No matching group found. No groups match the specified group ID.

GroupUpdateError.Other

The other object

GroupUpdateError.SystemManagedGroupDisallowed

This operation is not supported on system-managed groups.

HasTeamFileEventsValue

The value for Feature.HasTeamFileEvents.

HasTeamFileEventsValue.Enabled

Does this team have file events.

HasTeamFileEventsValue.Other

The other object

HasTeamSelectiveSyncValue

The value for Feature.HasTeamSelectiveSync.

HasTeamSelectiveSyncValue.HasTeamSelectiveSync

Does this team have team selective sync enabled.

HasTeamSelectiveSyncValue.Other

The other object

HasTeamSharedDropboxValue

The value for Feature.HasTeamSharedDropbox.

HasTeamSharedDropboxValue.HasTeamSharedDropbox

Does this team have a shared team root.

HasTeamSharedDropboxValue.Other

The other object

IncludeMembersArg

The include members arg object

LegalHoldHeldRevisionMetadata

The legal hold held revision metadata object

LegalHoldPolicy

The legal hold policy object

LegalHoldsError

The legal holds error object

LegalHoldsError.InsufficientPermissions

You don't have permissions to perform this action.

LegalHoldsError.Other

The other object

LegalHoldsError.UnknownLegalHoldError

There has been an unknown legal hold error.

LegalHoldsGetPolicyArg

The legal holds get policy arg object

LegalHoldsGetPolicyError

The legal holds get policy error object

LegalHoldsGetPolicyError.InsufficientPermissions

You don't have permissions to perform this action.

LegalHoldsGetPolicyError.LegalHoldPolicyNotFound

Legal hold policy does not exist for Id.

LegalHoldsGetPolicyError.Other

The other object

LegalHoldsGetPolicyError.UnknownLegalHoldError

There has been an unknown legal hold error.

LegalHoldsListHeldRevisionResult

The legal holds list held revision result object

LegalHoldsListHeldRevisionsArg

The legal holds list held revisions arg object

LegalHoldsListHeldRevisionsContinueArg

The legal holds list held revisions continue arg object

LegalHoldsListHeldRevisionsContinueError

The legal holds list held revisions continue error object

LegalHoldsListHeldRevisionsContinueError.Other

The other object

LegalHoldsListHeldRevisionsContinueError.Reset

Indicates that the cursor has been invalidated. Call LegalHoldsListHeldRevisionsContinueAsync(LegalHoldsListHeldRevisionsContinueArg) again with an empty cursor to obtain a new cursor.

LegalHoldsListHeldRevisionsContinueError.TransientError

Temporary infrastructure failure, please retry.

LegalHoldsListHeldRevisionsContinueError.UnknownLegalHoldError

There has been an unknown legal hold error.

LegalHoldsListHeldRevisionsError

The legal holds list held revisions error object

LegalHoldsListHeldRevisionsError.InactiveLegalHold

Trying to list revisions for an inactive legal hold.

LegalHoldsListHeldRevisionsError.InsufficientPermissions

You don't have permissions to perform this action.

LegalHoldsListHeldRevisionsError.LegalHoldStillEmpty

The legal hold is not holding any revisions yet.

LegalHoldsListHeldRevisionsError.Other

The other object

LegalHoldsListHeldRevisionsError.TransientError

Temporary infrastructure failure, please retry.

LegalHoldsListHeldRevisionsError.UnknownLegalHoldError

There has been an unknown legal hold error.

LegalHoldsListPoliciesArg

The legal holds list policies arg object

LegalHoldsListPoliciesError

The legal holds list policies error object

LegalHoldsListPoliciesError.InsufficientPermissions

You don't have permissions to perform this action.

LegalHoldsListPoliciesError.Other

The other object

LegalHoldsListPoliciesError.TransientError

Temporary infrastructure failure, please retry.

LegalHoldsListPoliciesError.UnknownLegalHoldError

There has been an unknown legal hold error.

LegalHoldsListPoliciesResult

The legal holds list policies result object

LegalHoldsPolicyCreateArg

The legal holds policy create arg object

LegalHoldsPolicyCreateError

The legal holds policy create error object

LegalHoldsPolicyCreateError.EmptyMembersList

The users list must have at least one user.

LegalHoldsPolicyCreateError.InsufficientPermissions

You don't have permissions to perform this action.

LegalHoldsPolicyCreateError.InvalidDate

The provided date is invalid.

LegalHoldsPolicyCreateError.InvalidMembers

Some members in the members list are not valid to be placed under legal hold.

LegalHoldsPolicyCreateError.NameMustBeUnique

The name provided is already in use by another legal hold.

LegalHoldsPolicyCreateError.NumberOfUsersOnHoldIsGreaterThanHoldLimitation

You cannot add more than 5 users in a legal hold.

LegalHoldsPolicyCreateError.Other

The other object

LegalHoldsPolicyCreateError.StartDateIsLaterThanEndDate

Start date must be earlier than end date.

LegalHoldsPolicyCreateError.TeamExceededLegalHoldQuota

Team exceeded legal hold quota.

LegalHoldsPolicyCreateError.TransientError

Temporary infrastructure failure, please retry.

LegalHoldsPolicyCreateError.UnknownLegalHoldError

There has been an unknown legal hold error.

LegalHoldsPolicyReleaseArg

The legal holds policy release arg object

LegalHoldsPolicyReleaseError

The legal holds policy release error object

LegalHoldsPolicyReleaseError.InsufficientPermissions

You don't have permissions to perform this action.

LegalHoldsPolicyReleaseError.LegalHoldAlreadyReleasing

Legal hold is currently performing a release or is already released.

LegalHoldsPolicyReleaseError.LegalHoldPerformingAnotherOperation

Legal hold is currently performing another operation.

LegalHoldsPolicyReleaseError.LegalHoldPolicyNotFound

Legal hold policy does not exist for Id.

LegalHoldsPolicyReleaseError.Other

The other object

LegalHoldsPolicyReleaseError.UnknownLegalHoldError

There has been an unknown legal hold error.

LegalHoldsPolicyUpdateArg

The legal holds policy update arg object

LegalHoldsPolicyUpdateError

The legal holds policy update error object

LegalHoldsPolicyUpdateError.EmptyMembersList

The users list must have at least one user.

LegalHoldsPolicyUpdateError.InactiveLegalHold

Trying to release an inactive legal hold.

LegalHoldsPolicyUpdateError.InsufficientPermissions

You don't have permissions to perform this action.

LegalHoldsPolicyUpdateError.InvalidMembers

Some members in the members list are not valid to be placed under legal hold.

LegalHoldsPolicyUpdateError.LegalHoldPerformingAnotherOperation

Legal hold is currently performing another operation.

LegalHoldsPolicyUpdateError.LegalHoldPolicyNotFound

Legal hold policy does not exist for Id.

LegalHoldsPolicyUpdateError.NameMustBeUnique

The name provided is already in use by another legal hold.

LegalHoldsPolicyUpdateError.NumberOfUsersOnHoldIsGreaterThanHoldLimitation

You cannot add more than 5 users in a legal hold.

LegalHoldsPolicyUpdateError.Other

The other object

LegalHoldsPolicyUpdateError.TransientError

Temporary infrastructure failure, please retry.

LegalHoldsPolicyUpdateError.UnknownLegalHoldError

There has been an unknown legal hold error.

LegalHoldStatus

The legal hold status object

LegalHoldStatus.Activating

The legal hold policy is activating.

LegalHoldStatus.Active

The legal hold policy is active.

LegalHoldStatus.Exporting

The legal hold policy is exporting.

LegalHoldStatus.Other

The other object

LegalHoldStatus.Released

The legal hold policy was released.

LegalHoldStatus.Releasing

The legal hold policy is releasing.

LegalHoldStatus.Updating

The legal hold policy is updating.

ListMemberAppsArg

The list member apps arg object

ListMemberAppsError

Error returned by LinkedAppsListMemberLinkedAppsAsync(ListMemberAppsArg).

ListMemberAppsError.MemberNotFound

Member not found.

ListMemberAppsError.Other

The other object

ListMemberAppsResult

The list member apps result object

ListMemberDevicesArg

The list member devices arg object

ListMemberDevicesError

The list member devices error object

ListMemberDevicesError.MemberNotFound

Member not found.

ListMemberDevicesError.Other

The other object

ListMemberDevicesResult

The list member devices result object

ListMembersAppsArg

Arguments for LinkedAppsListMembersLinkedAppsAsync(ListMembersAppsArg).

ListMembersAppsError

Error returned by LinkedAppsListMembersLinkedAppsAsync(ListMembersAppsArg).

ListMembersAppsError.Other

The other object

ListMembersAppsError.Reset

Indicates that the cursor has been invalidated. Call LinkedAppsListMembersLinkedAppsAsync(ListMembersAppsArg) again with an empty cursor to obtain a new cursor.

ListMembersAppsResult

Information returned by LinkedAppsListMembersLinkedAppsAsync(ListMembersAppsArg).

ListMembersDevicesArg

The list members devices arg object

ListMembersDevicesError

The list members devices error object

ListMembersDevicesError.Other

The other object

ListMembersDevicesError.Reset

Indicates that the cursor has been invalidated. Call DevicesListMembersDevicesAsync(ListMembersDevicesArg) again with an empty cursor to obtain a new cursor.

ListMembersDevicesResult

The list members devices result object

ListTeamAppsArg

Arguments for LinkedAppsListTeamLinkedAppsAsync(ListTeamAppsArg).

ListTeamAppsError

Error returned by LinkedAppsListTeamLinkedAppsAsync(ListTeamAppsArg).

ListTeamAppsError.Other

The other object

ListTeamAppsError.Reset

Indicates that the cursor has been invalidated. Call LinkedAppsListTeamLinkedAppsAsync(ListTeamAppsArg) again with an empty cursor to obtain a new cursor.

ListTeamAppsResult

Information returned by LinkedAppsListTeamLinkedAppsAsync(ListTeamAppsArg).

ListTeamDevicesArg

The list team devices arg object

ListTeamDevicesError

The list team devices error object

ListTeamDevicesError.Other

The other object

ListTeamDevicesError.Reset

Indicates that the cursor has been invalidated. Call DevicesListTeamDevicesAsync(ListTeamDevicesArg) again with an empty cursor to obtain a new cursor.

ListTeamDevicesResult

The list team devices result object

MemberAccess

Specify access type a member should have when joined to a group.

MemberAddArg

The member add arg object

MemberAddArgBase

The member add arg base object

MemberAddResult

Describes the result of attempting to add a single user to the team. 'success' is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed.

MemberAddResult.DuplicateExternalMemberId

A user with the given external member ID already exists on the team (including in recoverable state).

MemberAddResult.DuplicateMemberPersistentId

A user with the given persistent ID already exists on the team (including in recoverable state).

MemberAddResult.FreeTeamMemberLimitReached

Team is already full. The free team member limit has been reached.

MemberAddResult.PersistentIdDisabled

Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.

MemberAddResult.Success

Describes a user that was successfully added to the team.

MemberAddResult.TeamLicenseLimit

Team is already full. The organization has no available licenses.

MemberAddResult.UserAlreadyOnTeam

User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.

MemberAddResult.UserAlreadyPaired

User is already paired.

MemberAddResult.UserCreationFailed

User creation has failed.

MemberAddResult.UserMigrationFailed

User migration has failed.

MemberAddResult.UserOnAnotherTeam

User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.

MemberAddResultBase

The member add result base object

MemberAddResultBase.DuplicateExternalMemberId

A user with the given external member ID already exists on the team (including in recoverable state).

MemberAddResultBase.DuplicateMemberPersistentId

A user with the given persistent ID already exists on the team (including in recoverable state).

MemberAddResultBase.FreeTeamMemberLimitReached

Team is already full. The free team member limit has been reached.

MemberAddResultBase.PersistentIdDisabled

Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.

MemberAddResultBase.TeamLicenseLimit

Team is already full. The organization has no available licenses.

MemberAddResultBase.UserAlreadyOnTeam

User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.

MemberAddResultBase.UserAlreadyPaired

User is already paired.

MemberAddResultBase.UserCreationFailed

User creation has failed.

MemberAddResultBase.UserMigrationFailed

User migration has failed.

MemberAddResultBase.UserOnAnotherTeam

User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.

MemberAddV2Arg

The member add v2 arg object

MemberAddV2Result

Describes the result of attempting to add a single user to the team. 'success' is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed.

MemberAddV2Result.DuplicateExternalMemberId

A user with the given external member ID already exists on the team (including in recoverable state).

MemberAddV2Result.DuplicateMemberPersistentId

A user with the given persistent ID already exists on the team (including in recoverable state).

MemberAddV2Result.FreeTeamMemberLimitReached

Team is already full. The free team member limit has been reached.

MemberAddV2Result.Other

The other object

MemberAddV2Result.PersistentIdDisabled

Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.

MemberAddV2Result.Success

Describes a user that was successfully added to the team.

MemberAddV2Result.TeamLicenseLimit

Team is already full. The organization has no available licenses.

MemberAddV2Result.UserAlreadyOnTeam

User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.

MemberAddV2Result.UserAlreadyPaired

User is already paired.

MemberAddV2Result.UserCreationFailed

User creation has failed.

MemberAddV2Result.UserMigrationFailed

User migration has failed.

MemberAddV2Result.UserOnAnotherTeam

User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.

MemberDevices

Information on devices of a team's member.

MemberLinkedApps

Information on linked applications of a team member.

MemberProfile

Basic member profile.

MembersAddArg

The members add arg object

MembersAddArgBase

The members add arg base object

MembersAddJobStatus

The members add job status object

MembersAddJobStatus.Complete

The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to MembersAddAsync(MembersAddArg), a corresponding item is returned in this list.

MembersAddJobStatus.Failed

The asynchronous job returned an error. The string contains an error message.

MembersAddJobStatus.InProgress

The asynchronous job is still in progress.

MembersAddJobStatusV2Result

The members add job status v2 result object

MembersAddJobStatusV2Result.Complete

The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to MembersAddV2Async(MembersAddV2Arg), a corresponding item is returned in this list.

MembersAddJobStatusV2Result.Failed

The asynchronous job returned an error. The string contains an error message.

MembersAddJobStatusV2Result.InProgress

The asynchronous job is still in progress.

MembersAddJobStatusV2Result.Other

The other object

MembersAddLaunch

The members add launch object

MembersAddLaunch.AsyncJobId

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

MembersAddLaunch.Complete

The complete object

MembersAddLaunchV2Result

The members add launch v2 result object

MembersAddLaunchV2Result.AsyncJobId

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

MembersAddLaunchV2Result.Complete

The complete object

MembersAddLaunchV2Result.Other

The other object

MembersAddV2Arg

The members add v2 arg object

MembersDataTransferArg

The members data transfer arg object

MembersDeactivateArg

The members deactivate arg object

MembersDeactivateBaseArg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

MembersDeactivateError

The members deactivate error object

MembersDeactivateError.Other

The other object

MembersDeactivateError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersDeactivateError.UserNotInTeam

The user is not a member of the team.

MembersDeleteProfilePhotoArg

The members delete profile photo arg object

MembersDeleteProfilePhotoError

The members delete profile photo error object

MembersDeleteProfilePhotoError.Other

The other object

MembersDeleteProfilePhotoError.SetProfileDisallowed

Modifying deleted users is not allowed.

MembersDeleteProfilePhotoError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersDeleteProfilePhotoError.UserNotInTeam

The user is not a member of the team.

MemberSelectorError

The member selector error object

MemberSelectorError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MemberSelectorError.UserNotInTeam

The user is not a member of the team.

MembersGetAvailableTeamMemberRolesResult

Available TeamMemberRole for the connected team. To be used with MembersSetAdminPermissionsV2Async(MembersSetPermissions2Arg).

MembersGetInfoArgs

The members get info args object

MembersGetInfoError

The members get info error object

MembersGetInfoError.Other

The other object

MembersGetInfoItem

Describes a result obtained for a single user whose id was specified in the parameter of MembersGetInfoAsync(MembersGetInfoArgs).

MembersGetInfoItem.IdNotFound

An ID that was provided as a parameter to MembersGetInfoAsync(MembersGetInfoArgs) or MembersGetInfoV2Async(MembersGetInfoV2Arg), and did not match a corresponding user. This might be a team_member_id, an email, or an external ID, depending on how the method was called.

MembersGetInfoItem.MemberInfo

Info about a team member.

MembersGetInfoItemBase

The members get info item base object

MembersGetInfoItemBase.IdNotFound

An ID that was provided as a parameter to MembersGetInfoAsync(MembersGetInfoArgs) or MembersGetInfoV2Async(MembersGetInfoV2Arg), and did not match a corresponding user. This might be a team_member_id, an email, or an external ID, depending on how the method was called.

MembersGetInfoItemV2

Describes a result obtained for a single user whose id was specified in the parameter of MembersGetInfoV2Async(MembersGetInfoV2Arg).

MembersGetInfoItemV2.IdNotFound

An ID that was provided as a parameter to MembersGetInfoAsync(MembersGetInfoArgs) or MembersGetInfoV2Async(MembersGetInfoV2Arg), and did not match a corresponding user. This might be a team_member_id, an email, or an external ID, depending on how the method was called.

MembersGetInfoItemV2.MemberInfo

Info about a team member.

MembersGetInfoItemV2.Other

The other object

MembersGetInfoV2Arg

The members get info v2 arg object

MembersGetInfoV2Result

The members get info v2 result object

MembersInfo

The members info object

MembersListArg

The members list arg object

MembersListContinueArg

The members list continue arg object

MembersListContinueError

The members list continue error object

MembersListContinueError.InvalidCursor

The cursor is invalid.

MembersListContinueError.Other

The other object

MembersListError

The members list error object

MembersListError.Other

The other object

MembersListResult

The members list result object

MembersListV2Result

The members list v2 result object

MembersRecoverArg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

MembersRecoverError

The members recover error object

MembersRecoverError.Other

The other object

MembersRecoverError.TeamLicenseLimit

Team is full. The organization has no available licenses.

MembersRecoverError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersRecoverError.UserNotInTeam

The user is not a member of the team.

MembersRecoverError.UserUnrecoverable

The user is not recoverable.

MembersRemoveArg

The members remove arg object

MembersRemoveError

The members remove error object

MembersRemoveError.CannotKeepAccount

Only a team admin, can convert this account to a Basic account.

MembersRemoveError.CannotKeepAccountAndDeleteData

Cannot keep account and delete the data at the same time. To keep the account the argument wipe_data should be set to false.

MembersRemoveError.CannotKeepAccountAndTransfer

Cannot keep account and transfer the data to another user at the same time.

MembersRemoveError.CannotKeepAccountRequiredToSignTos

To convert this member to a Basic account, they'll first need to sign in to Dropbox and agree to the terms of service.

MembersRemoveError.CannotKeepAccountUnderLegalHold

This user content is currently being held. To convert this member's account to a Basic account, you'll first need to remove them from the hold.

MembersRemoveError.CannotKeepInvitedUserAccount

Cannot keep account of an invited user.

MembersRemoveError.CannotRetainSharesWhenDataWiped

Cannot retain team shares when the user's data is marked for deletion on their linked devices. The argument wipe_data should be set to false.

MembersRemoveError.CannotRetainSharesWhenNoAccountKept

The user's account must be kept in order to retain team shares. The argument keep_account should be set to true.

MembersRemoveError.CannotRetainSharesWhenTeamExternalSharingOff

Externally sharing files, folders, and links must be enabled in team settings in order to retain team shares for the user.

MembersRemoveError.EmailAddressTooLongToBeDisabled

The email address of the user is too long to be disabled.

MembersRemoveError.Other

The other object

MembersRemoveError.RecipientNotVerified

The recipient user's email is not verified.

MembersRemoveError.RemovedAndTransferAdminShouldDiffer

Expected removed user and transfer_admin user to be different.

MembersRemoveError.RemovedAndTransferDestShouldDiffer

Expected removed user and transfer_dest user to be different.

MembersRemoveError.RemoveLastAdmin

The user is the last admin of the team, so it cannot be removed from it.

MembersRemoveError.TransferAdminIsNotAdmin

Specified transfer_admin user is not a team admin.

MembersRemoveError.TransferAdminUserNotFound

No matching user found for the argument transfer_admin_id.

MembersRemoveError.TransferAdminUserNotInTeam

The provided transfer_admin_id does not exist on this team.

MembersRemoveError.TransferDestUserNotFound

No matching user found for the argument transfer_dest_id.

MembersRemoveError.TransferDestUserNotInTeam

The provided transfer_dest_id does not exist on this team.

MembersRemoveError.UnspecifiedTransferAdminId

The transfer_admin_id argument must be provided when file transfer is requested.

MembersRemoveError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersRemoveError.UserNotInTeam

The user is not a member of the team.

MembersSendWelcomeError

The members send welcome error object

MembersSendWelcomeError.Other

The other object

MembersSendWelcomeError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersSendWelcomeError.UserNotInTeam

The user is not a member of the team.

MembersSetPermissions2Arg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

MembersSetPermissions2Error

The members set permissions2 error object

MembersSetPermissions2Error.CannotSetPermissions

Cannot remove/grant permissions. This can happen if the team member is suspended.

MembersSetPermissions2Error.LastAdmin

Cannot remove the admin setting of the last admin.

MembersSetPermissions2Error.Other

The other object

MembersSetPermissions2Error.RoleNotFound

No matching role found. At least one of the provided new_roles does not exist on this team.

MembersSetPermissions2Error.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersSetPermissions2Error.UserNotInTeam

The user is not a member of the team.

MembersSetPermissions2Result

The members set permissions2 result object

MembersSetPermissionsArg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

MembersSetPermissionsError

The members set permissions error object

MembersSetPermissionsError.CannotSetPermissions

Cannot remove/grant permissions.

MembersSetPermissionsError.LastAdmin

Cannot remove the admin setting of the last admin.

MembersSetPermissionsError.Other

The other object

MembersSetPermissionsError.TeamLicenseLimit

Team is full. The organization has no available licenses.

MembersSetPermissionsError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersSetPermissionsError.UserNotInTeam

The user is not a member of the team.

MembersSetPermissionsResult

The members set permissions result object

MembersSetProfileArg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

At least one of new_email, new_external_id, new_given_name, and/or new_surname must be provided.

MembersSetProfileError

The members set profile error object

MembersSetProfileError.DirectoryRestrictedOff

Directory Restrictions option is not available.

MembersSetProfileError.EmailReservedForOtherUser

Email is already reserved for another user.

MembersSetProfileError.ExternalIdAndNewExternalIdUnsafe

It is unsafe to use both external_id and new_external_id.

MembersSetProfileError.ExternalIdUsedByOtherUser

The external ID is already in use by another team member.

MembersSetProfileError.NoNewDataSpecified

None of new_email, new_given_name, new_surname, or new_external_id are specified.

MembersSetProfileError.Other

The other object

MembersSetProfileError.ParamCannotBeEmpty

Parameter new_email cannot be empty.

MembersSetProfileError.PersistentIdDisabled

Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.

MembersSetProfileError.PersistentIdUsedByOtherUser

The persistent ID is already in use by another team member.

MembersSetProfileError.SetProfileDisallowed

Modifying deleted users is not allowed.

MembersSetProfileError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersSetProfileError.UserNotInTeam

The user is not a member of the team.

MembersSetProfilePhotoArg

The members set profile photo arg object

MembersSetProfilePhotoError

The members set profile photo error object

MembersSetProfilePhotoError.Other

The other object

MembersSetProfilePhotoError.PhotoError

The photo error object

MembersSetProfilePhotoError.SetProfileDisallowed

Modifying deleted users is not allowed.

MembersSetProfilePhotoError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersSetProfilePhotoError.UserNotInTeam

The user is not a member of the team.

MembersSuspendError

The members suspend error object

MembersSuspendError.Other

The other object

MembersSuspendError.SuspendInactiveUser

The user is not active, so it cannot be suspended.

MembersSuspendError.SuspendLastAdmin

The user is the last admin of the team, so it cannot be suspended.

MembersSuspendError.TeamLicenseLimit

Team is full. The organization has no available licenses.

MembersSuspendError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersSuspendError.UserNotInTeam

The user is not a member of the team.

MembersTransferFilesError

The members transfer files error object

MembersTransferFilesError.Other

The other object

MembersTransferFilesError.RecipientNotVerified

The recipient user's email is not verified.

MembersTransferFilesError.RemovedAndTransferAdminShouldDiffer

Expected removed user and transfer_admin user to be different.

MembersTransferFilesError.RemovedAndTransferDestShouldDiffer

Expected removed user and transfer_dest user to be different.

MembersTransferFilesError.TransferAdminIsNotAdmin

Specified transfer_admin user is not a team admin.

MembersTransferFilesError.TransferAdminUserNotFound

No matching user found for the argument transfer_admin_id.

MembersTransferFilesError.TransferAdminUserNotInTeam

The provided transfer_admin_id does not exist on this team.

MembersTransferFilesError.TransferDestUserNotFound

No matching user found for the argument transfer_dest_id.

MembersTransferFilesError.TransferDestUserNotInTeam

The provided transfer_dest_id does not exist on this team.

MembersTransferFilesError.UnspecifiedTransferAdminId

The transfer_admin_id argument must be provided when file transfer is requested.

MembersTransferFilesError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersTransferFilesError.UserNotInTeam

The user is not a member of the team.

MembersTransferFormerMembersFilesError

The members transfer former members files error object

MembersTransferFormerMembersFilesError.Other

The other object

MembersTransferFormerMembersFilesError.RecipientNotVerified

The recipient user's email is not verified.

MembersTransferFormerMembersFilesError.RemovedAndTransferAdminShouldDiffer

Expected removed user and transfer_admin user to be different.

MembersTransferFormerMembersFilesError.RemovedAndTransferDestShouldDiffer

Expected removed user and transfer_dest user to be different.

MembersTransferFormerMembersFilesError.TransferAdminIsNotAdmin

Specified transfer_admin user is not a team admin.

MembersTransferFormerMembersFilesError.TransferAdminUserNotFound

No matching user found for the argument transfer_admin_id.

MembersTransferFormerMembersFilesError.TransferAdminUserNotInTeam

The provided transfer_admin_id does not exist on this team.

MembersTransferFormerMembersFilesError.TransferDestUserNotFound

No matching user found for the argument transfer_dest_id.

MembersTransferFormerMembersFilesError.TransferDestUserNotInTeam

The provided transfer_dest_id does not exist on this team.

MembersTransferFormerMembersFilesError.UnspecifiedTransferAdminId

The transfer_admin_id argument must be provided when file transfer is requested.

MembersTransferFormerMembersFilesError.UserDataAlreadyTransferred

User's data has already been transferred to another user.

MembersTransferFormerMembersFilesError.UserDataCannotBeTransferred

User files aren't transferable anymore.

MembersTransferFormerMembersFilesError.UserDataIsBeingTransferred

The user's data is being transferred. Please wait some time before retrying.

MembersTransferFormerMembersFilesError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersTransferFormerMembersFilesError.UserNotInTeam

The user is not a member of the team.

MembersTransferFormerMembersFilesError.UserNotRemoved

No matching removed user found for the argument user.

MembersUnsuspendArg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

MembersUnsuspendError

The members unsuspend error object

MembersUnsuspendError.Other

The other object

MembersUnsuspendError.TeamLicenseLimit

Team is full. The organization has no available licenses.

MembersUnsuspendError.UnsuspendNonSuspendedMember

The user is unsuspended, so it cannot be unsuspended again.

MembersUnsuspendError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

MembersUnsuspendError.UserNotInTeam

The user is not a member of the team.

MobileClientPlatform

The mobile client platform object

MobileClientPlatform.Android

Official Dropbox Android client.

MobileClientPlatform.Blackberry

Official Dropbox Blackberry client.

MobileClientPlatform.Ipad

Official Dropbox iPad client.

MobileClientPlatform.Iphone

Official Dropbox iPhone client.

MobileClientPlatform.Other

The other object

MobileClientPlatform.WindowsPhone

Official Dropbox Windows phone client.

MobileClientSession

Information about linked Dropbox mobile client sessions.

NamespaceMetadata

Properties of a namespace.

NamespaceType

The namespace type object

NamespaceType.AppFolder

App sandbox folder.

NamespaceType.Other

The other object

NamespaceType.SharedFolder

Shared folder.

NamespaceType.TeamFolder

Top-level team-owned folder.

NamespaceType.TeamMemberFolder

Team member's home folder.

RemoveCustomQuotaResult

User result for setting member custom quota.

RemoveCustomQuotaResult.InvalidUser

Invalid user (not in team).

RemoveCustomQuotaResult.Other

The other object

RemoveCustomQuotaResult.Success

Successfully removed user.

RemovedStatus

The removed status object

ResendSecondaryEmailResult

Result of trying to resend verification email to a secondary email address. 'success' is the only value indicating that a verification email was successfully sent. The other values explain the type of error that occurred, and include the email for which the error occurred.

ResendSecondaryEmailResult.NotPending

This secondary email address is not pending for the user.

ResendSecondaryEmailResult.Other

The other object

ResendSecondaryEmailResult.RateLimited

Too many emails are being sent to this email address. Please try again later.

ResendSecondaryEmailResult.Success

A verification email was successfully sent to the secondary email address.

ResendVerificationEmailArg

The resend verification email arg object

ResendVerificationEmailResult

List of users and resend results.

RevokeDesktopClientArg

The revoke desktop client arg object

RevokeDeviceSessionArg

The revoke device session arg object

RevokeDeviceSessionArg.DesktopClient

Unlink a linked desktop device.

RevokeDeviceSessionArg.MobileClient

Unlink a linked mobile device.

RevokeDeviceSessionArg.WebSession

End an active session.

RevokeDeviceSessionBatchArg

The revoke device session batch arg object

RevokeDeviceSessionBatchError

The revoke device session batch error object

RevokeDeviceSessionBatchError.Other

The other object

RevokeDeviceSessionBatchResult

The revoke device session batch result object

RevokeDeviceSessionError

The revoke device session error object

RevokeDeviceSessionError.DeviceSessionNotFound

Device session not found.

RevokeDeviceSessionError.MemberNotFound

Member not found.

RevokeDeviceSessionError.Other

The other object

RevokeDeviceSessionStatus

The revoke device session status object

RevokeLinkedApiAppArg

The revoke linked api app arg object

RevokeLinkedApiAppBatchArg

The revoke linked api app batch arg object

RevokeLinkedAppBatchError

Error returned by LinkedAppsRevokeLinkedAppBatchAsync(RevokeLinkedApiAppBatchArg).

RevokeLinkedAppBatchError.Other

The other object

RevokeLinkedAppBatchResult

The revoke linked app batch result object

RevokeLinkedAppError

Error returned by LinkedAppsRevokeLinkedAppAsync(RevokeLinkedApiAppArg).

RevokeLinkedAppError.AppFolderRemovalNotSupported

App folder removal is not supported.

RevokeLinkedAppError.AppNotFound

Application not found.

RevokeLinkedAppError.MemberNotFound

Member not found.

RevokeLinkedAppError.Other

The other object

RevokeLinkedAppStatus

The revoke linked app status object

SetCustomQuotaArg

The set custom quota arg object

SetCustomQuotaError

Error returned when setting member custom quota.

SetCustomQuotaError.Other

The other object

SetCustomQuotaError.SomeUsersAreExcluded

Some of the users are on the excluded users list and can't have custom quota set.

SetCustomQuotaError.TooManyUsers

A maximum of 1000 users can be set for a single call.

StorageBucket

Describes the number of users in a specific storage bucket.

TeamFolderAccessError

The team folder access error object

TeamFolderAccessError.InvalidTeamFolderId

The team folder ID is invalid.

TeamFolderAccessError.NoAccess

The authenticated app does not have permission to manage that team folder.

TeamFolderAccessError.Other

The other object

TeamFolderActivateError

The team folder activate error object

TeamFolderActivateError.AccessError

The access error object

TeamFolderActivateError.Other

The other object

TeamFolderActivateError.StatusError

The status error object

TeamFolderActivateError.TeamSharedDropboxError

The team shared dropbox error object

TeamFolderArchiveArg

The team folder archive arg object

TeamFolderArchiveError

The team folder archive error object

TeamFolderArchiveError.AccessError

The access error object

TeamFolderArchiveError.Other

The other object

TeamFolderArchiveError.StatusError

The status error object

TeamFolderArchiveError.TeamSharedDropboxError

The team shared dropbox error object

TeamFolderArchiveJobStatus

The team folder archive job status object

TeamFolderArchiveJobStatus.Complete

The archive job has finished. The value is the metadata for the resulting team folder.

TeamFolderArchiveJobStatus.Failed

Error occurred while performing an asynchronous job from TeamFolderArchiveAsync(TeamFolderArchiveArg).

TeamFolderArchiveJobStatus.InProgress

The asynchronous job is still in progress.

TeamFolderArchiveLaunch

The team folder archive launch object

TeamFolderArchiveLaunch.AsyncJobId

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

TeamFolderArchiveLaunch.Complete

The complete object

TeamFolderCreateArg

The team folder create arg object

TeamFolderCreateError

The team folder create error object

TeamFolderCreateError.FolderNameAlreadyUsed

There is already a team folder with the provided name.

TeamFolderCreateError.FolderNameReserved

The provided name cannot be used because it is reserved.

TeamFolderCreateError.InvalidFolderName

The provided name cannot be used.

TeamFolderCreateError.Other

The other object

TeamFolderCreateError.SyncSettingsError

An error occurred setting the sync settings.

TeamFolderGetInfoItem

The team folder get info item object

TeamFolderGetInfoItem.IdNotFound

An ID that was provided as a parameter to TeamFolderGetInfoAsync(TeamFolderIdListArg) did not match any of the team's team folders.

TeamFolderGetInfoItem.TeamFolderMetadata

Properties of a team folder.

TeamFolderIdArg

The team folder id arg object

TeamFolderIdListArg

The team folder id list arg object

TeamFolderInvalidStatusError

The team folder invalid status error object

TeamFolderInvalidStatusError.Active

The folder is active and the operation did not succeed.

TeamFolderInvalidStatusError.Archived

The folder is archived and the operation did not succeed.

TeamFolderInvalidStatusError.ArchiveInProgress

The folder is being archived and the operation did not succeed.

TeamFolderInvalidStatusError.Other

The other object

TeamFolderListArg

The team folder list arg object

TeamFolderListContinueArg

The team folder list continue arg object

TeamFolderListContinueError

The team folder list continue error object

TeamFolderListContinueError.InvalidCursor

The cursor is invalid.

TeamFolderListContinueError.Other

The other object

TeamFolderListError

The team folder list error object

TeamFolderListResult

Result for TeamFolderListAsync(TeamFolderListArg) and TeamFolderListContinueAsync(TeamFolderListContinueArg).

TeamFolderMetadata

Properties of a team folder.

TeamFolderPermanentlyDeleteError

The team folder permanently delete error object

TeamFolderPermanentlyDeleteError.AccessError

The access error object

TeamFolderPermanentlyDeleteError.Other

The other object

TeamFolderPermanentlyDeleteError.StatusError

The status error object

TeamFolderPermanentlyDeleteError.TeamSharedDropboxError

The team shared dropbox error object

TeamFolderRenameArg

The team folder rename arg object

TeamFolderRenameError

The team folder rename error object

TeamFolderRenameError.AccessError

The access error object

TeamFolderRenameError.FolderNameAlreadyUsed

There is already a team folder with the same name.

TeamFolderRenameError.FolderNameReserved

The provided name cannot be used because it is reserved.

TeamFolderRenameError.InvalidFolderName

The provided folder name cannot be used.

TeamFolderRenameError.Other

The other object

TeamFolderRenameError.StatusError

The status error object

TeamFolderRenameError.TeamSharedDropboxError

The team shared dropbox error object

TeamFolderStatus

The team folder status object

TeamFolderStatus.Active

The team folder and sub-folders are available to all members.

TeamFolderStatus.Archived

The team folder is not accessible outside of the team folder manager.

TeamFolderStatus.ArchiveInProgress

The team folder is not accessible outside of the team folder manager.

TeamFolderStatus.Other

The other object

TeamFolderTeamSharedDropboxError

The team folder team shared dropbox error object

TeamFolderTeamSharedDropboxError.Disallowed

This action is not allowed for a shared team root.

TeamFolderTeamSharedDropboxError.Other

The other object

TeamFolderUpdateSyncSettingsArg

The team folder update sync settings arg object

TeamFolderUpdateSyncSettingsError

The team folder update sync settings error object

TeamFolderUpdateSyncSettingsError.AccessError

The access error object

TeamFolderUpdateSyncSettingsError.Other

The other object

TeamFolderUpdateSyncSettingsError.StatusError

The status error object

TeamFolderUpdateSyncSettingsError.SyncSettingsError

An error occurred setting the sync settings.

TeamFolderUpdateSyncSettingsError.TeamSharedDropboxError

The team shared dropbox error object

TeamGetInfoResult

The team get info result object

TeamMemberInfo

Information about a team member.

TeamMemberInfoV2

Information about a team member.

TeamMemberInfoV2Result

Information about a team member, after the change, like at MembersSetProfileV2Async(MembersSetProfileArg).

TeamMemberProfile

Profile of a user as a member of a team.

TeamMemberRole

A role which can be attached to a team member. This replaces AdminTier; each AdminTier corresponds to a new TeamMemberRole with a matching name.

TeamMembershipType

The team membership type object

TeamMembershipType.Full

User uses a license and has full access to team resources like the shared quota.

TeamMembershipType.Limited

User does not have access to the shared quota and team admins have restricted administrative control.

TeamMemberStatus

The user's status as a member of a specific team.

TeamMemberStatus.Active

User has successfully joined the team.

TeamMemberStatus.Invited

User has been invited to a team, but has not joined the team yet.

TeamMemberStatus.Removed

User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.

TeamMemberStatus.Suspended

User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.

TeamNamespacesListArg

The team namespaces list arg object

TeamNamespacesListContinueArg

The team namespaces list continue arg object

TeamNamespacesListContinueError

The team namespaces list continue error object

TeamNamespacesListContinueError.InvalidArg

Argument passed in is invalid.

TeamNamespacesListContinueError.InvalidCursor

The cursor is invalid.

TeamNamespacesListContinueError.Other

The other object

TeamNamespacesListError

The team namespaces list error object

TeamNamespacesListError.InvalidArg

Argument passed in is invalid.

TeamNamespacesListError.Other

The other object

TeamNamespacesListResult

Result for NamespacesListAsync(TeamNamespacesListArg).

TeamReportFailureReason

The team report failure reason object

TeamReportFailureReason.ManyReportsAtOnce

Too many other reports are being created right now. Try creating this report again once the others finish.

TeamReportFailureReason.Other

The other object

TeamReportFailureReason.TemporaryError

We couldn't create the report, but we think this was a fluke. Everything should work if you try it again.

TeamReportFailureReason.TooMuchData

We couldn't create the report. Try creating the report again with less data.

TokenGetAuthenticatedAdminError

Error returned by TokenGetAuthenticatedAdminAsync().

TokenGetAuthenticatedAdminError.AdminNotActive

Either the team admin that authorized this token is no longer an active member of the team or no longer a team admin.

TokenGetAuthenticatedAdminError.MappingNotFound

The current token is not associated with a team admin, because mappings were not recorded when the token was created. Consider re-authorizing a new access token to record its authenticating admin.

TokenGetAuthenticatedAdminError.Other

The other object

TokenGetAuthenticatedAdminResult

Results for TokenGetAuthenticatedAdminAsync().

UploadApiRateLimitValue

The value for Feature.UploadApiRateLimit.

UploadApiRateLimitValue.Limit

The number of upload API calls allowed per month.

UploadApiRateLimitValue.Other

The other object

UploadApiRateLimitValue.Unlimited

This team has unlimited upload API quota. So far both server version account and legacy account type have unlimited monthly upload api quota.

UserAddResult

Result of trying to add secondary emails to a user. 'success' is the only value indicating that a user was successfully retrieved for adding secondary emails. The other values explain the type of error that occurred, and include the user for which the error occurred.

UserAddResult.InvalidUser

Specified user is not a valid target for adding secondary emails.

UserAddResult.Other

The other object

UserAddResult.PlaceholderUser

Secondary emails cannot be added to placeholder users.

UserAddResult.Success

Describes a user and the results for each attempt to add a secondary email.

UserAddResult.Unverified

Secondary emails can only be added to verified users.

UserCustomQuotaArg

User and their required custom quota in GB (1 TB = 1024 GB).

UserCustomQuotaResult

User and their custom quota in GB (1 TB = 1024 GB). No quota returns if the user has no custom quota set.

UserDeleteEmailsResult

The user delete emails result object

UserDeleteResult

Result of trying to delete a user's secondary emails. 'success' is the only value indicating that a user was successfully retrieved for deleting secondary emails. The other values explain the type of error that occurred, and include the user for which the error occurred.

UserDeleteResult.InvalidUser

Specified user is not a valid target for deleting secondary emails.

UserDeleteResult.Other

The other object

UserDeleteResult.Success

Describes a user and the results for each attempt to delete a secondary email.

UserResendEmailsResult

The user resend emails result object

UserResendResult

Result of trying to resend verification emails to a user. 'success' is the only value indicating that a user was successfully retrieved for sending verification emails. The other values explain the type of error that occurred, and include the user for which the error occurred.

UserResendResult.InvalidUser

Specified user is not a valid target for resending verification emails.

UserResendResult.Other

The other object

UserResendResult.Success

Describes a user and the results for each attempt to resend verification emails.

UserSecondaryEmailsArg

User and a list of secondary emails.

UserSecondaryEmailsResult

The user secondary emails result object

UserSelectorArg

Argument for selecting a single user, either by team_member_id, external_id or email.

UserSelectorArg.Email

The email object

UserSelectorArg.ExternalId

The external id object

UserSelectorArg.TeamMemberId

The team member id object

UserSelectorError

Error that can be returned whenever a struct derived from UserSelectorArg is used.

UserSelectorError.UserNotFound

No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

UsersSelectorArg

Argument for selecting a list of users, either by team_member_ids, external_ids or emails.

UsersSelectorArg.Emails

List of email addresses.

UsersSelectorArg.ExternalIds

List of external user IDs.

UsersSelectorArg.TeamMemberIds

List of member IDs.

In This Article
  • Classes
Back to top Generated by DocFX