Module dropbox_sdk::team
source · [−]dbx_team only.Structs
Information on active web sessions.
Information on linked third party applications.
Base report structure.
Input arguments that can be provided for most reports.
Information about linked Dropbox desktop client sessions.
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.
Excluded users list argument.
Excluded users list continue argument.
Excluded users list result.
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.
Excluded users update result.
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.
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.
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.
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.
Full description of a group.
Profile of group member, and role in group.
Argument for selecting a group and a single user.
Result returned by groups_members_add() and
groups_members_remove().
Argument for selecting a group and a list of users.
Arguments for linked_apps_list_members_linked_apps().
Information returned by
linked_apps_list_members_linked_apps().
Arguments for linked_apps_list_team_linked_apps().
Information returned by
linked_apps_list_team_linked_apps().
Specify access type a member should have when joined to a group.
Information on devices of a team’s member.
Information on linked applications of a team member.
Basic member profile.
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Available TeamMemberRole for the connected team. To be used with
members_set_admin_permissions_v2().
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
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.
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Information about linked Dropbox mobile client sessions.
Properties of a namespace.
List of users and resend results.
Describes the number of users in a specific storage bucket.
Result for team_folder_list() and
team_folder_list_continue().
Properties of a team folder.
Information about a team member.
Information about a team member.
Information about a team member, after the change, like at
members_set_profile_v2().
Profile of a user as a member of a team.
A role which can be attached to a team member. This replaces AdminTier; each AdminTier corresponds to a new TeamMemberRole with a matching name.
Result for namespaces_list().
User and their required custom quota in GB (1 TB = 1024 GB).
User and their custom quota in GB (1 TB = 1024 GB). No quota returns if the user has no custom quota set.
User and a list of secondary emails.
Enums
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.
Error returned when adding secondary emails fails.
Describes which team-related admin permissions a user has.
Base error that all errors for existing team folders should extend.
Error returned when getting member custom quota.
User custom quota.
Errors that can originate from problems in input arguments to reports.
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.
Excluded users list continue error.
Excluded users list error.
Excluded users update error.
Excluded users update operation status.
A set of features that a Dropbox Business account may support.
The values correspond to entries in Feature. You may get different value according
to your Dropbox Business plan.
Role of a user in group.
Error that can be raised when GroupMemberSelector is used, and the user
is required to be a member of the specified group.
Error that can be raised when GroupMembersSelector is used, and the
users are required to be members of the specified group.
Argument for selecting a single group, either by group_id or by external group ID.
Error that can be raised when GroupSelector is used.
Error that can be raised when GroupSelector is used and team groups are
disallowed from being used.
Argument for selecting a list of groups, either by group_ids, or external group IDs.
The value for Feature::HasTeamFileEvents.
The value for Feature::HasTeamSelectiveSync.
The value for Feature::HasTeamSharedDropbox.
Error returned by
linked_apps_list_member_linked_apps().
Error returned by
linked_apps_list_members_linked_apps().
Error returned by linked_apps_list_team_linked_apps().
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.
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.
Describes a result obtained for a single user whose id was specified in the parameter of
members_get_info().
Describes a result obtained for a single user whose id was specified in the parameter of
members_get_info_v2().
User result for setting member custom quota.
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.
Error returned by
linked_apps_revoke_linked_app_batch().
Error returned by linked_apps_revoke_linked_app().
Error returned when setting member custom quota.
The user’s status as a member of a specific team.
Error returned by token_get_authenticated_admin().
The value for Feature::UploadApiRateLimit.
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.
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.
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.
Argument for selecting a single user, either by team_member_id, external_id or email.
Error that can be returned whenever a struct derived from UserSelectorArg
is used.
Argument for selecting a list of users, either by team_member_ids, external_ids or emails.
Functions
List all device sessions of a team’s member.
List all device sessions of a team. Permission : Team member file access.
List all device sessions of a team. Permission : Team member file access.
Revoke a device session of a team’s member.
Revoke a list of device sessions of team members.
Get the values for one or more featues. This route allows you to check your account’s capability for what feature you can access or what value you have for certain features. Permission : Team information.
Retrieves information about a team.
Creates a new, empty group, with a requested name. Permission : Team member management.
Deletes a group. The group is deleted immediately. However the revoking of group-owned resources
may take additional time. Use the groups_job_status_get() to
determine whether this process has completed. Permission : Team member management.
Retrieves information about one or more groups. Note that the optional field
GroupFullInfo::members is not returned for system-managed groups. Permission
: Team Information.
Once an async_job_id is returned from groups_delete(),
groups_members_add() , or
groups_members_remove() use this method to poll the status of
granting/revoking group members’ access to group-owned resources. Permission : Team member
management.
Lists groups on a team. Permission : Team Information.
Once a cursor has been retrieved from groups_list(), use this to paginate
through all groups. Permission : Team Information.
Adds members to a group. The members are added immediately. However the granting of group-owned
resources may take additional time. Use the groups_job_status_get()
to determine whether this process has completed. Permission : Team member management.
Lists members of a group. Permission : Team Information.
Once a cursor has been retrieved from groups_members_list(), use this
to paginate through all members of the group. Permission : Team information.
Removes members from a group. The members are removed immediately. However the revoking of
group-owned resources may take additional time. Use the
groups_job_status_get() to determine whether this process has
completed. This method permits removing the only owner of a group, even in cases where this is
not possible via the web client. Permission : Team member management.
Sets a member’s access type in a group. Permission : Team member management.
Updates a group’s name and/or external ID. Permission : Team member management.
Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.
Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.
List the file metadata that’s under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.
Continue listing the file metadata that’s under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.
Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.
Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.
Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.
List all linked applications of the team member. Note, this endpoint does not list any team-linked applications.
List all applications linked to the team members’ accounts. Note, this endpoint does not list any team-linked applications.
List all applications linked to the team members’ accounts. Note, this endpoint doesn’t list any team-linked applications.
Revoke a linked application of the team member.
Revoke a list of linked applications of the team members.
Add users to member space limits excluded users list.
List member space limits excluded users.
Continue listing member space limits excluded users.
Remove users from member space limits excluded users list.
Get users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call.
Remove users custom quota. A maximum of 1000 members can be specified in a single call.
Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.
Adds members to a team. Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for ‘Perform as team member’ actions taken on the user before they become ‘active’.
Once an async_job_id is returned from members_add() , use this to poll the
status of the asynchronous request. Permission : Team member management.
Once an async_job_id is returned from members_add_v2() , use this to poll
the status of the asynchronous request. Permission : Team member management.
Adds members to a team. Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for ‘Perform as team member’ actions taken on the user before they become ‘active’.
Deletes a team member’s profile photo. Permission : Team member management.
Deletes a team member’s profile photo. Permission : Team member management.
Get available TeamMemberRoles for the connected team. To be used with
members_set_admin_permissions_v2(). Permission : Team
member management.
Returns information about multiple team members. Permission : Team information This endpoint
will return MembersGetInfoItem::IdNotFound, for IDs (or
emails) that cannot be matched to a valid team member.
Returns information about multiple team members. Permission : Team information This endpoint
will return MembersGetInfoItem::IdNotFound, for IDs (or
emails) that cannot be matched to a valid team member.
Lists members of a team. Permission : Team information.
Once a cursor has been retrieved from members_list(), use this to paginate
through all team members. Permission : Team information.
Once a cursor has been retrieved from members_list_v2(), use this to
paginate through all team members. Permission : Team information.
Lists members of a team. Permission : Team information.
Moves removed member’s files to a different member. This endpoint initiates an asynchronous job.
To obtain the final result of the job, the client should periodically poll
members_move_former_member_files_job_status_check().
Permission : Team member management.
Once an async_job_id is returned from
members_move_former_member_files() , use this to poll the
status of the asynchronous request. Permission : Team member management.
Recover a deleted member. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Removes a member from a team. Permission : Team member management Exactly one of team_member_id,
email, or external_id must be provided to identify the user account. Accounts can be recovered
via members_recover() for a 7 day period or until the account has been
permanently deleted or transferred to another account (whichever comes first). Calling
members_add() while a user is still recoverable on your team will return with
MemberAddResult::UserAlreadyOnTeam. Accounts can have
their files transferred via the admin console for a limited time, based on the version history
length associated with the team (180 days for most teams). This endpoint may initiate an
asynchronous job. To obtain the final result of the job, the client should periodically poll
members_remove_job_status_get().
Once an async_job_id is returned from members_remove() , use this to poll
the status of the asynchronous request. Permission : Team member management.
Add secondary emails to users. Permission : Team member management. Emails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent.
Delete secondary emails from users Permission : Team member management. Users will be notified of deletions of verified secondary emails at both the secondary email and their primary email.
Resend secondary email verification emails. Permission : Team member management.
Sends welcome email to pending team member. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. No-op if team member is not pending.
Updates a team member’s permissions. Permission : Team member management.
Updates a team member’s permissions. Permission : Team member management.
Updates a team member’s profile. Permission : Team member management.
Updates a team member’s profile photo. Permission : Team member management.
Updates a team member’s profile photo. Permission : Team member management.
Updates a team member’s profile. Permission : Team member management.
Suspend a member from a team. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Unsuspend a member from a team. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Returns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members’ home namespaces, and team members’ app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.
Once a cursor has been retrieved from namespaces_list(), use this to
paginate through all team-accessible namespaces. Duplicates may occur in the list.
Permission : Team member file access.
Permission : Team member file access. The scope for the route is files.team_metadata.write.
Permission : Team member file access. The scope for the route is files.team_metadata.write.
Permission : Team member file access.
Retrieves reporting data about a team’s user activity. Deprecated: Will be removed on July 1st 2021.
Retrieves reporting data about a team’s linked devices. Deprecated: Will be removed on July 1st 2021.
Retrieves reporting data about a team’s membership. Deprecated: Will be removed on July 1st 2021.
Retrieves reporting data about a team’s storage usage. Deprecated: Will be removed on July 1st 2021.
Sets an archived team folder’s status to active. Permission : Team member file access.
Sets an active team folder’s status to archived and removes all folder and file members. This endpoint cannot be used for teams that have a shared team space. Permission : Team member file access.
Returns the status of an asynchronous job for archiving a team folder. Permission : Team member file access.
Creates a new, active, team folder with no members. This endpoint can only be used for teams that do not already have a shared team space. Permission : Team member file access.
Retrieves metadata for team folders. Permission : Team member file access.
Lists all team folders. Permission : Team member file access.
Once a cursor has been retrieved from team_folder_list(), use this to
paginate through all team folders. Permission : Team member file access.
Permanently deletes an archived team folder. This endpoint cannot be used for teams that have a shared team space. Permission : Team member file access.
Changes an active team folder’s name. Permission : Team member file access.
Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.
Returns the member profile of the admin who generated the team access token used to make the call.