dropbox.base_team.DropboxTeamBase

Add a template associated with a team. See :meth:`file_properties_properties_add` to add properties to a file or folder. Note: this endpoint will create team-owned templates. Route attributes: scope: files.team_metadata.write :rtype: :class:`dropbox.file_properties.AddTemplateResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.file_properties.ModifyTemplateError`

Get the schema for a specified template. Route attributes: scope: files.team_metadata.write :param str template_id: An identifier for template added by route See :meth:`file_properties_templates_add_for_user` or :meth:`file_properties_templates_add_for_team`. :rtype: :class:`dropbox.file_properties.GetTemplateResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.file_properties.TemplateError`

Get the template identifiers for a team. To get the schema of each template use :meth:`file_properties_templates_get_for_team`. Route attributes: scope: files.team_metadata.write :rtype: :class:`dropbox.file_properties.ListTemplateResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.file_properties.TemplateError`

Permanently removes the specified template created from :meth:`file_properties_templates_add_for_user`. All properties associated with the template will also be removed. This action cannot be undone. Route attributes: scope: files.team_metadata.write :param str template_id: An identifier for a template created by :meth:`file_properties_templates_add_for_user` or :meth:`file_properties_templates_add_for_team`. :rtype: None :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.file_properties.TemplateError`

Update a template associated with a team. This route can update the template name, the template description and add optional properties to templates. Route attributes: scope: files.team_metadata.write :param str template_id: An identifier for template added by See :meth:`file_properties_templates_add_for_user` or :meth:`file_properties_templates_add_for_team`. :param Nullable[str] name: A display name for the template. template names can be up to 256 bytes. :param Nullable[str] description: Description for the new template. Template descriptions can be up to 1024 bytes. :param Nullable[List[:class:`dropbox.file_properties.PropertyFieldTemplate`]] add_fields: Property field templates to be added to the group template. There can be up to 32 properties in a single template. :rtype: :class:`dropbox.file_properties.UpdateTemplateResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.file_properties.ModifyTemplateError`

Undocumented

List all device sessions of a team's member. Route attributes: scope: sessions.list :param str team_member_id: The team's member id. :param bool include_web_sessions: Whether to list web sessions of the team's member. :param bool include_desktop_clients: Whether to list linked desktop devices of the team's member. :param bool include_mobile_clients: Whether to list linked mobile devices of the team's member. :rtype: :class:`dropbox.team.ListMemberDevicesResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ListMemberDevicesError`

List all device sessions of a team. Permission : Team member file access. Route attributes: scope: sessions.list :param Nullable[str] cursor: At the first call to the :meth:`team_devices_list_members_devices` the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of team devices. :param bool include_web_sessions: Whether to list web sessions of the team members. :param bool include_desktop_clients: Whether to list desktop clients of the team members. :param bool include_mobile_clients: Whether to list mobile clients of the team members. :rtype: :class:`dropbox.team.ListMembersDevicesResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ListMembersDevicesError`

List all device sessions of a team. Permission : Team member file access. Route attributes: scope: sessions.list :param Nullable[str] cursor: At the first call to the :meth:`team_devices_list_team_devices` the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of team devices. :param bool include_web_sessions: Whether to list web sessions of the team members. :param bool include_desktop_clients: Whether to list desktop clients of the team members. :param bool include_mobile_clients: Whether to list mobile clients of the team members. :rtype: :class:`dropbox.team.ListTeamDevicesResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ListTeamDevicesError`

Revoke a device session of a team's member. Route attributes: scope: sessions.modify :type arg: :class:`dropbox.team.RevokeDeviceSessionArg` :rtype: None :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.RevokeDeviceSessionError`

Revoke a list of device sessions of team members. Route attributes: scope: sessions.modify :type revoke_devices: List[:class:`dropbox.team.RevokeDeviceSessionArg`] :rtype: :class:`dropbox.team.RevokeDeviceSessionBatchResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.RevokeDeviceSessionBatchError`

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. Route attributes: scope: team_info.read :param List[:class:`dropbox.team.Feature`] features: A list of features in :class:`dropbox.team.Feature`. If the list is empty, this route will return :class:`dropbox.team.FeaturesGetValuesBatchError`. :rtype: :class:`dropbox.team.FeaturesGetValuesBatchResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.FeaturesGetValuesBatchError`

Retrieves information about a team. Route attributes: scope: team_info.read :rtype: :class:`dropbox.team.TeamGetInfoResult`

Creates a new, empty group, with a requested name. Permission : Team member management. Route attributes: scope: groups.write :param str group_name: Group name. :param bool add_creator_as_owner: Automatically add the creator of the group. :param Nullable[str] group_external_id: The creator of a team can associate an arbitrary external ID to the group. :param Nullable[:class:`dropbox.team.GroupManagementType`] group_management_type: Whether the team can be managed by selected users, or only by team admins. :rtype: :class:`dropbox.team.GroupFullInfo` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupCreateError`

Deletes a group. The group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the :meth:`team_groups_job_status_get` to determine whether this process has completed. Permission : Team member management. Route attributes: scope: groups.write :param arg: Argument for selecting a single group, either by group_id or by external group ID. :type arg: :class:`dropbox.team.GroupSelector` :rtype: :class:`dropbox.team.LaunchEmptyResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupDeleteError`

Retrieves information about one or more groups. Note that the optional field ``GroupFullInfo.members`` is not returned for system-managed groups. Permission : Team Information. Route attributes: scope: groups.read :param arg: Argument for selecting a list of groups, either by group_ids, or external group IDs. :type arg: :class:`dropbox.team.GroupsSelector` :rtype: List[:class:`dropbox.team.GroupsGetInfoItem`] :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupsGetInfoError`

Once an async_job_id is returned from :meth:`team_groups_delete`, :meth:`team_groups_members_add` , or :meth:`team_groups_members_remove` use this method to poll the status of granting/revoking group members' access to group-owned resources. Permission : Team member management. Route attributes: scope: groups.write :param str async_job_id: Id of the asynchronous job. This is the value of a response returned from the method that launched the job. :rtype: :class:`dropbox.team.PollEmptyResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupsPollError`

Lists groups on a team. Permission : Team Information. Route attributes: scope: groups.read :param int limit: Number of results to return per call. :rtype: :class:`dropbox.team.GroupsListResult`

Once a cursor has been retrieved from :meth:`team_groups_list`, use this to paginate through all groups. Permission : Team Information. Route attributes: scope: groups.read :param str cursor: Indicates from what point to get the next set of groups. :rtype: :class:`dropbox.team.GroupsListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupsListContinueError`

Adds members to a group. The members are added immediately. However the granting of group-owned resources may take additional time. Use the :meth:`team_groups_job_status_get` to determine whether this process has completed. Permission : Team member management. Route attributes: scope: groups.write :param group: Group to which users will be added. :type group: :class:`dropbox.team.GroupSelector` :param List[:class:`dropbox.team.MemberAccess`] members: List of users to be added to the group. :rtype: :class:`dropbox.team.GroupMembersChangeResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupMembersAddError`

Lists members of a group. Permission : Team Information. Route attributes: scope: groups.read :param group: The group whose members are to be listed. :type group: :class:`dropbox.team.GroupSelector` :param int limit: Number of results to return per call. :rtype: :class:`dropbox.team.GroupsMembersListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupSelectorError`

Once a cursor has been retrieved from :meth:`team_groups_members_list`, use this to paginate through all members of the group. Permission : Team information. Route attributes: scope: groups.read :param str cursor: Indicates from what point to get the next set of groups. :rtype: :class:`dropbox.team.GroupsMembersListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupsMembersListContinueError`

Removes members from a group. The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the :meth:`team_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. Route attributes: scope: groups.write :param group: Group from which users will be removed. :type group: :class:`dropbox.team.GroupSelector` :param List[:class:`dropbox.team.UserSelectorArg`] users: List of users to be removed from the group. :rtype: :class:`dropbox.team.GroupMembersChangeResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupMembersRemoveError`

Sets a member's access type in a group. Permission : Team member management. Route attributes: scope: groups.write :param access_type: New group access type the user will have. :type access_type: :class:`dropbox.team.GroupAccessType` :param bool return_members: Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. :rtype: List[:class:`dropbox.team.GroupsGetInfoItem`] :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupMemberSetAccessTypeError`

Updates a group's name and/or external ID. Permission : Team member management. Route attributes: scope: groups.write :param group: Specify a group. :type group: :class:`dropbox.team.GroupSelector` :param Nullable[str] new_group_name: Optional argument. Set group name to this if provided. :param Nullable[str] new_group_external_id: Optional argument. New group external ID. If the argument is None, the group's external_id won't be updated. If the argument is empty string, the group's external id will be cleared. :param Nullable[:class:`dropbox.team.GroupManagementType`] new_group_management_type: Set new group management type, if provided. :rtype: :class:`dropbox.team.GroupFullInfo` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.GroupUpdateError`

Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access. Route attributes: scope: team_data.governance.write :param str name: Policy name. :param Nullable[str] description: A description of the legal hold policy. :param List[str] members: List of team member IDs added to the hold. :param Nullable[datetime] start_date: start date of the legal hold policy. :param Nullable[datetime] end_date: end date of the legal hold policy. :rtype: :class:`dropbox.team.LegalHoldPolicy` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.LegalHoldsPolicyCreateError`

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. Route attributes: scope: team_data.governance.write :param str id: The legal hold Id. :rtype: :class:`dropbox.team.LegalHoldPolicy` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.LegalHoldsGetPolicyError`

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. Route attributes: scope: team_data.governance.write :param str id: The legal hold Id. :rtype: :class:`dropbox.team.LegalHoldsListHeldRevisionResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.LegalHoldsListHeldRevisionsError`

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. Route attributes: scope: team_data.governance.write :param str id: The legal hold Id. :param Nullable[str] cursor: The cursor idicates where to continue reading file metadata entries for the next API call. When there are no more entries, the cursor will return none. :rtype: :class:`dropbox.team.LegalHoldsListHeldRevisionResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.LegalHoldsListHeldRevisionsError`

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. Route attributes: scope: team_data.governance.write :param bool include_released: Whether to return holds that were released. :rtype: :class:`dropbox.team.LegalHoldsListPoliciesResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.LegalHoldsListPoliciesError`

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. Route attributes: scope: team_data.governance.write :param str id: The legal hold Id. :rtype: None :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.LegalHoldsPolicyReleaseError`

Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access. Route attributes: scope: team_data.governance.write :param str id: The legal hold Id. :param Nullable[str] name: Policy new name. :param Nullable[str] description: Policy new description. :param Nullable[List[str]] members: List of team member IDs to apply the policy on. :rtype: :class:`dropbox.team.LegalHoldPolicy` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.LegalHoldsPolicyUpdateError`

List all linked applications of the team member. Note, this endpoint does not list any team-linked applications. Route attributes: scope: sessions.list :param str team_member_id: The team member id. :rtype: :class:`dropbox.team.ListMemberAppsResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ListMemberAppsError`

List all applications linked to the team members' accounts. Note, this endpoint does not list any team-linked applications. Route attributes: scope: sessions.list :param Nullable[str] cursor: At the first call to the :meth:`team_linked_apps_list_members_linked_apps` the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications. :rtype: :class:`dropbox.team.ListMembersAppsResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ListMembersAppsError`

List all applications linked to the team members' accounts. Note, this endpoint doesn't list any team-linked applications. Route attributes: scope: sessions.list :param Nullable[str] cursor: At the first call to the :meth:`team_linked_apps_list_team_linked_apps` the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications. :rtype: :class:`dropbox.team.ListTeamAppsResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ListTeamAppsError`

Revoke a linked application of the team member. Route attributes: scope: sessions.modify :param str app_id: The application's unique id. :param str team_member_id: The unique id of the member owning the device. :param bool keep_app_folder: This flag is not longer supported, the application dedicated folder (in case the application uses one) will be kept. :rtype: None :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.RevokeLinkedAppError`

Revoke a list of linked applications of the team members. Route attributes: scope: sessions.modify :type revoke_linked_app: List[:class:`dropbox.team.RevokeLinkedApiAppArg`] :rtype: :class:`dropbox.team.RevokeLinkedAppBatchResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.RevokeLinkedAppBatchError`

Retrieves team events. If the result's ``GetTeamEventsResult.has_more`` field is ``True``, call :meth:`team_log_get_events_continue` with the returned cursor to retrieve more entries. If end_time is not specified in your request, you may use the returned cursor to poll :meth:`team_log_get_events_continue` for new events. Many attributes note 'may be missing due to historical data gap'. Note that the file_operations category and & analogous paper events are not available on all Dropbox Business `plans </business/plans-comparison>`_. Use `features/get_values </developers/documentation/http/teams#team-features-get_values>`_ to check for this feature. Permission : Team Auditing. Route attributes: scope: events.read :param int limit: The maximal number of results to return per call. Note that some calls may not return ``limit`` number of events, and may even return no events, even with `has_more` set to true. In this case, callers should fetch again using :meth:`team_log_get_events_continue`. :param Nullable[str] account_id: Filter the events by account ID. Return only events with this account_id as either Actor, Context, or Participants. :param Nullable[:class:`dropbox.team_log.TimeRange`] time: Filter by time range. :param Nullable[:class:`dropbox.team_log.EventCategory`] category: Filter the returned events to a single category. Note that category shouldn't be provided together with event_type. :param Nullable[:class:`dropbox.team_log.EventTypeArg`] event_type: Filter the returned events to a single event type. Note that event_type shouldn't be provided together with category. :rtype: :class:`dropbox.team_log.GetTeamEventsResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team_log.GetTeamEventsError`

Once a cursor has been retrieved from :meth:`team_log_get_events`, use this to paginate through all events. Permission : Team Auditing. Route attributes: scope: events.read :param str cursor: Indicates from what point to get the next set of events. :rtype: :class:`dropbox.team_log.GetTeamEventsResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team_log.GetTeamEventsContinueError`

Add users to member space limits excluded users list. Route attributes: scope: members.write :param Nullable[List[:class:`dropbox.team.UserSelectorArg`]] users: List of users to be added/removed. :rtype: :class:`dropbox.team.ExcludedUsersUpdateResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ExcludedUsersUpdateError`

List member space limits excluded users. Route attributes: scope: members.read :param int limit: Number of results to return per call. :rtype: :class:`dropbox.team.ExcludedUsersListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ExcludedUsersListError`

Continue listing member space limits excluded users. Route attributes: scope: members.read :param str cursor: Indicates from what point to get the next set of users. :rtype: :class:`dropbox.team.ExcludedUsersListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ExcludedUsersListContinueError`

Remove users from member space limits excluded users list. Route attributes: scope: members.write :param Nullable[List[:class:`dropbox.team.UserSelectorArg`]] users: List of users to be added/removed. :rtype: :class:`dropbox.team.ExcludedUsersUpdateResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ExcludedUsersUpdateError`

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. Route attributes: scope: members.read :param List[:class:`dropbox.team.UserSelectorArg`] users: List of users. :rtype: List[:class:`dropbox.team.CustomQuotaResult`] :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.CustomQuotaError`

Remove users custom quota. A maximum of 1000 members can be specified in a single call. Route attributes: scope: members.write :param List[:class:`dropbox.team.UserSelectorArg`] users: List of users. :rtype: List[:class:`dropbox.team.RemoveCustomQuotaResult`] :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.CustomQuotaError`

Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call. Route attributes: scope: members.read :param List[:class:`dropbox.team.UserCustomQuotaArg`] users_and_quotas: List of users and their custom quotas. :rtype: List[:class:`dropbox.team.CustomQuotaResult`] :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.SetCustomQuotaError`

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'. Route attributes: scope: members.write :param List[:class:`dropbox.team.MemberAddArg`] new_members: Details of new members to be added to the team. :rtype: :class:`dropbox.team.MembersAddLaunch`

Once an async_job_id is returned from :meth:`team_members_add` , use this to poll the status of the asynchronous request. Permission : Team member management. Route attributes: scope: members.write :param str async_job_id: Id of the asynchronous job. This is the value of a response returned from the method that launched the job. :rtype: :class:`dropbox.team.MembersAddJobStatus` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.PollError`

Once an async_job_id is returned from :meth:`team_members_add_v2` , use this to poll the status of the asynchronous request. Permission : Team member management. Route attributes: scope: members.write :param str async_job_id: Id of the asynchronous job. This is the value of a response returned from the method that launched the job. :rtype: :class:`dropbox.team.MembersAddJobStatusV2Result` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.PollError`

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'. Route attributes: scope: members.write :param List[:class:`dropbox.team.MemberAddV2Arg`] new_members: Details of new members to be added to the team. :rtype: :class:`dropbox.team.MembersAddLaunchV2Result`

Deletes a team member's profile photo. Permission : Team member management. Route attributes: scope: members.write :param user: Identity of the user whose profile photo will be deleted. :type user: :class:`dropbox.team.UserSelectorArg` :rtype: :class:`dropbox.team.TeamMemberInfo` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersDeleteProfilePhotoError`

Deletes a team member's profile photo. Permission : Team member management. Route attributes: scope: members.write :param user: Identity of the user whose profile photo will be deleted. :type user: :class:`dropbox.team.UserSelectorArg` :rtype: :class:`dropbox.team.TeamMemberInfoV2Result` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersDeleteProfilePhotoError`

Get available TeamMemberRoles for the connected team. To be used with :meth:`team_members_set_admin_permissions_v2`. Permission : Team member management. Route attributes: scope: members.read :rtype: :class:`dropbox.team.MembersGetAvailableTeamMemberRolesResult`

Returns information about multiple team members. Permission : Team information This endpoint will return ``MembersGetInfoItem.id_not_found``, for IDs (or emails) that cannot be matched to a valid team member. Route attributes: scope: members.read :param List[:class:`dropbox.team.UserSelectorArg`] members: List of team members. :rtype: List[:class:`dropbox.team.MembersGetInfoItem`] :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersGetInfoError`

Returns information about multiple team members. Permission : Team information This endpoint will return ``MembersGetInfoItem.id_not_found``, for IDs (or emails) that cannot be matched to a valid team member. Route attributes: scope: members.read :param List[:class:`dropbox.team.UserSelectorArg`] members: List of team members. :rtype: :class:`dropbox.team.MembersGetInfoV2Result` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersGetInfoError`

Lists members of a team. Permission : Team information. Route attributes: scope: members.read :param int limit: Number of results to return per call. :param bool include_removed: Whether to return removed members. :rtype: :class:`dropbox.team.MembersListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersListError`

Once a cursor has been retrieved from :meth:`team_members_list`, use this to paginate through all team members. Permission : Team information. Route attributes: scope: members.read :param str cursor: Indicates from what point to get the next set of members. :rtype: :class:`dropbox.team.MembersListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersListContinueError`

Once a cursor has been retrieved from :meth:`team_members_list_v2`, use this to paginate through all team members. Permission : Team information. Route attributes: scope: members.read :param str cursor: Indicates from what point to get the next set of members. :rtype: :class:`dropbox.team.MembersListV2Result` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersListContinueError`

Lists members of a team. Permission : Team information. Route attributes: scope: members.read :param int limit: Number of results to return per call. :param bool include_removed: Whether to return removed members. :rtype: :class:`dropbox.team.MembersListV2Result` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersListError`

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 :meth:`team_members_move_former_member_files_job_status_check`. Permission : Team member management. Route attributes: scope: members.write :param transfer_dest_id: Files from the deleted member account will be transferred to this user. :type transfer_dest_id: :class:`dropbox.team.UserSelectorArg` :param transfer_admin_id: Errors during the transfer process will be sent via email to this user. :type transfer_admin_id: :class:`dropbox.team.UserSelectorArg` :rtype: :class:`dropbox.team.LaunchEmptyResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersTransferFormerMembersFilesError`

Once an async_job_id is returned from :meth:`team_members_move_former_member_files` , use this to poll the status of the asynchronous request. Permission : Team member management. Route attributes: scope: members.write :param str async_job_id: Id of the asynchronous job. This is the value of a response returned from the method that launched the job. :rtype: :class:`dropbox.team.PollEmptyResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.PollError`

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. Route attributes: scope: members.delete :param user: Identity of user to recover. :type user: :class:`dropbox.team.UserSelectorArg` :rtype: None :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersRecoverError`

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 :meth:`team_members_recover` for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling :meth:`team_members_add` while a user is still recoverable on your team will return with ``MemberAddResult.user_already_on_team``. 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 :meth:`team_members_remove_job_status_get`. Route attributes: scope: members.delete :param Nullable[:class:`dropbox.team.UserSelectorArg`] transfer_dest_id: If provided, files from the deleted member account will be transferred to this user. :param Nullable[:class:`dropbox.team.UserSelectorArg`] transfer_admin_id: If provided, errors during the transfer process will be sent via email to this user. If the transfer_dest_id argument was provided, then this argument must be provided as well. :param bool keep_account: Downgrade the member to a Basic account. The user will retain the email address associated with their Dropbox account and data in their account that is not restricted to team members. In order to keep the account the argument ``wipe_data`` should be set to ``False``. :param bool retain_team_shares: If provided, allows removed users to keep access to Dropbox folders (not Dropbox Paper folders) already explicitly shared with them (not via a group) when they are downgraded to a Basic account. Users will not retain access to folders that do not allow external sharing. In order to keep the sharing relationships, the arguments ``wipe_data`` should be set to ``False`` and ``keep_account`` should be set to ``True``. :rtype: :class:`dropbox.team.LaunchEmptyResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersRemoveError`

Once an async_job_id is returned from :meth:`team_members_remove` , use this to poll the status of the asynchronous request. Permission : Team member management. Route attributes: scope: members.delete :param str async_job_id: Id of the asynchronous job. This is the value of a response returned from the method that launched the job. :rtype: :class:`dropbox.team.PollEmptyResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.PollError`

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. Route attributes: scope: members.write :param List[:class:`dropbox.team.UserSecondaryEmailsArg`] new_secondary_emails: List of users and secondary emails to add. :rtype: :class:`dropbox.team.AddSecondaryEmailsResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.AddSecondaryEmailsError`

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. Route attributes: scope: members.write :param List[:class:`dropbox.team.UserSecondaryEmailsArg`] emails_to_delete: List of users and their secondary emails to delete. :rtype: :class:`dropbox.team.DeleteSecondaryEmailsResult`

Resend secondary email verification emails. Permission : Team member management. Route attributes: scope: members.write :param List[:class:`dropbox.team.UserSecondaryEmailsArg`] emails_to_resend: List of users and secondary emails to resend verification emails to. :rtype: :class:`dropbox.team.ResendVerificationEmailResult`

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. Route attributes: scope: members.write :param arg: Argument for selecting a single user, either by team_member_id, external_id or email. :type arg: :class:`dropbox.team.UserSelectorArg` :rtype: None :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersSendWelcomeError`

Updates a team member's permissions. Permission : Team member management. Route attributes: scope: members.write :param user: Identity of user whose role will be set. :type user: :class:`dropbox.team.UserSelectorArg` :param new_role: The new role of the member. :type new_role: :class:`dropbox.team.AdminTier` :rtype: :class:`dropbox.team.MembersSetPermissionsResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersSetPermissionsError`

Updates a team member's permissions. Permission : Team member management. Route attributes: scope: members.write :param user: Identity of user whose role will be set. :type user: :class:`dropbox.team.UserSelectorArg` :param Nullable[List[str]] new_roles: The new roles for the member. Send empty list to make user member only. For now, only up to one role is allowed. :rtype: :class:`dropbox.team.MembersSetPermissions2Result` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersSetPermissions2Error`

Updates a team member's profile. Permission : Team member management. Route attributes: scope: members.write :param user: Identity of user whose profile will be set. :type user: :class:`dropbox.team.UserSelectorArg` :param Nullable[str] new_email: New email for member. :param Nullable[str] new_external_id: New external ID for member. :param Nullable[str] new_given_name: New given name for member. :param Nullable[str] new_surname: New surname for member. :param Nullable[str] new_persistent_id: New persistent ID. This field only available to teams using persistent ID SAML configuration. :param Nullable[bool] new_is_directory_restricted: New value for whether the user is a directory restricted user. :rtype: :class:`dropbox.team.TeamMemberInfo` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersSetProfileError`

Updates a team member's profile photo. Permission : Team member management. Route attributes: scope: members.write :param user: Identity of the user whose profile photo will be set. :type user: :class:`dropbox.team.UserSelectorArg` :param photo: Image to set as the member's new profile photo. :type photo: :class:`dropbox.team.PhotoSourceArg` :rtype: :class:`dropbox.team.TeamMemberInfo` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersSetProfilePhotoError`

Updates a team member's profile photo. Permission : Team member management. Route attributes: scope: members.write :param user: Identity of the user whose profile photo will be set. :type user: :class:`dropbox.team.UserSelectorArg` :param photo: Image to set as the member's new profile photo. :type photo: :class:`dropbox.team.PhotoSourceArg` :rtype: :class:`dropbox.team.TeamMemberInfoV2Result` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersSetProfilePhotoError`

Updates a team member's profile. Permission : Team member management. Route attributes: scope: members.write :param user: Identity of user whose profile will be set. :type user: :class:`dropbox.team.UserSelectorArg` :param Nullable[str] new_email: New email for member. :param Nullable[str] new_external_id: New external ID for member. :param Nullable[str] new_given_name: New given name for member. :param Nullable[str] new_surname: New surname for member. :param Nullable[str] new_persistent_id: New persistent ID. This field only available to teams using persistent ID SAML configuration. :param Nullable[bool] new_is_directory_restricted: New value for whether the user is a directory restricted user. :rtype: :class:`dropbox.team.TeamMemberInfoV2Result` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersSetProfileError`

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. Route attributes: scope: members.write :param bool wipe_data: If provided, controls if the user's data will be deleted on their linked devices. :rtype: None :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersSuspendError`

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. Route attributes: scope: members.write :param user: Identity of user to unsuspend. :type user: :class:`dropbox.team.UserSelectorArg` :rtype: None :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.MembersUnsuspendError`

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. Route attributes: scope: team_data.member :param int limit: Specifying a value here has no effect. :rtype: :class:`dropbox.team.TeamNamespacesListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.TeamNamespacesListError`

Once a cursor has been retrieved from :meth:`team_namespaces_list`, use this to paginate through all team-accessible namespaces. Duplicates may occur in the list. Route attributes: scope: team_data.member :param str cursor: Indicates from what point to get the next set of team-accessible namespaces. :rtype: :class:`dropbox.team.TeamNamespacesListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.TeamNamespacesListContinueError`

Permission : Team member file access. Route attributes: scope: files.team_metadata.write :rtype: :class:`dropbox.team.AddTemplateResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ModifyTemplateError`

Permission : Team member file access. The scope for the route is files.team_metadata.write. Route attributes: scope: files.team_metadata.write :param str template_id: An identifier for template added by route See :meth:`team_templates_add_for_user` or :meth:`team_templates_add_for_team`. :rtype: :class:`dropbox.team.GetTemplateResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.TemplateError`

Permission : Team member file access. The scope for the route is files.team_metadata.write. Route attributes: scope: files.team_metadata.write :rtype: :class:`dropbox.team.ListTemplateResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.TemplateError`

Permission : Team member file access. Route attributes: scope: files.team_metadata.write :param str template_id: An identifier for template added by See :meth:`team_templates_add_for_user` or :meth:`team_templates_add_for_team`. :param Nullable[str] name: A display name for the template. template names can be up to 256 bytes. :param Nullable[str] description: Description for the new template. Template descriptions can be up to 1024 bytes. :param Nullable[List[:class:`dropbox.team.PropertyFieldTemplate`]] add_fields: Property field templates to be added to the group template. There can be up to 32 properties in a single template. :rtype: :class:`dropbox.team.UpdateTemplateResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.ModifyTemplateError`

Retrieves reporting data about a team's user activity. Deprecated: Will be removed on July 1st 2021. Route attributes: scope: team_info.read :param Nullable[datetime] start_date: Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. :param Nullable[datetime] end_date: Optional ending date (exclusive). :rtype: :class:`dropbox.team.GetActivityReport` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.DateRangeError`

Retrieves reporting data about a team's linked devices. Deprecated: Will be removed on July 1st 2021. Route attributes: scope: team_info.read :param Nullable[datetime] start_date: Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. :param Nullable[datetime] end_date: Optional ending date (exclusive). :rtype: :class:`dropbox.team.GetDevicesReport` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.DateRangeError`

Retrieves reporting data about a team's membership. Deprecated: Will be removed on July 1st 2021. Route attributes: scope: team_info.read :param Nullable[datetime] start_date: Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. :param Nullable[datetime] end_date: Optional ending date (exclusive). :rtype: :class:`dropbox.team.GetMembershipReport` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.DateRangeError`

Retrieves reporting data about a team's storage usage. Deprecated: Will be removed on July 1st 2021. Route attributes: scope: team_info.read :param Nullable[datetime] start_date: Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. :param Nullable[datetime] end_date: Optional ending date (exclusive). :rtype: :class:`dropbox.team.GetStorageReport` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.DateRangeError`

Endpoint adds Approve List entries. Changes are effective immediately. Changes are committed in transaction. In case of single validation error - all entries are rejected. Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted. Added entries cannot overflow limit of 10000 entries per team. Maximum 100 entries per call is allowed. Route attributes: scope: team_info.write :param Nullable[List[str]] domains: List of domains represented by valid string representation (RFC-1034/5). :param Nullable[List[str]] emails: List of emails represented by valid string representation (RFC-5322/822). :rtype: :class:`dropbox.team.SharingAllowlistAddResponse` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.SharingAllowlistAddError`

Lists Approve List entries for given team, from newest to oldest, returning up to `limit` entries at a time. If there are more than `limit` entries associated with the current team, more can be fetched by passing the returned `cursor` to :meth:`team_sharing_allowlist_list_continue`. Route attributes: scope: team_info.read :param int limit: The number of entries to fetch at one time. :rtype: :class:`dropbox.team.SharingAllowlistListResponse`

Lists entries associated with given team, starting from a the cursor. See :meth:`team_sharing_allowlist_list`. Route attributes: scope: team_info.read :param str cursor: The cursor returned from a previous call to :meth:`team_sharing_allowlist_list` or :meth:`team_sharing_allowlist_list_continue`. :rtype: :class:`dropbox.team.SharingAllowlistListResponse` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.SharingAllowlistListContinueError`

Endpoint removes Approve List entries. Changes are effective immediately. Changes are committed in transaction. In case of single validation error - all entries are rejected. Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted. Entries being removed have to be present on the list. Maximum 1000 entries per call is allowed. Route attributes: scope: team_info.write :param Nullable[List[str]] domains: List of domains represented by valid string representation (RFC-1034/5). :param Nullable[List[str]] emails: List of emails represented by valid string representation (RFC-5322/822). :rtype: :class:`dropbox.team.SharingAllowlistRemoveResponse` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.SharingAllowlistRemoveError`

Sets an archived team folder's status to active. Permission : Team member file access. Route attributes: scope: team_data.content.write :param str team_folder_id: The ID of the team folder. :rtype: :class:`dropbox.team.TeamFolderMetadata`

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. Route attributes: scope: team_data.content.write :param bool force_async_off: Whether to force the archive to happen synchronously. :rtype: :class:`dropbox.team.TeamFolderArchiveLaunch`

Returns the status of an asynchronous job for archiving a team folder. Permission : Team member file access. Route attributes: scope: team_data.content.write :param str async_job_id: Id of the asynchronous job. This is the value of a response returned from the method that launched the job. :rtype: :class:`dropbox.team.TeamFolderArchiveJobStatus` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.PollError`

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. Route attributes: scope: team_data.content.write :param str name: Name for the new team folder. :param Nullable[:class:`dropbox.team.SyncSettingArg`] sync_setting: The sync setting to apply to this team folder. Only permitted if the team has team selective sync enabled. :rtype: :class:`dropbox.team.TeamFolderMetadata` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.TeamFolderCreateError`

Retrieves metadata for team folders. Permission : Team member file access. Route attributes: scope: team_data.content.read :param List[str] team_folder_ids: The list of team folder IDs. :rtype: List[:class:`dropbox.team.TeamFolderGetInfoItem`]

Lists all team folders. Permission : Team member file access. Route attributes: scope: team_data.content.read :param int limit: The maximum number of results to return per request. :rtype: :class:`dropbox.team.TeamFolderListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.TeamFolderListError`

Once a cursor has been retrieved from :meth:`team_team_folder_list`, use this to paginate through all team folders. Permission : Team member file access. Route attributes: scope: team_data.content.read :param str cursor: Indicates from what point to get the next set of team folders. :rtype: :class:`dropbox.team.TeamFolderListResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.TeamFolderListContinueError`

Permanently deletes an archived team folder. This endpoint cannot be used for teams that have a shared team space. Permission : Team member file access. Route attributes: scope: team_data.content.write :param str team_folder_id: The ID of the team folder. :rtype: None

Changes an active team folder's name. Permission : Team member file access. Route attributes: scope: team_data.content.write :param str name: New team folder name. :rtype: :class:`dropbox.team.TeamFolderMetadata` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.TeamFolderRenameError`

Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled. Route attributes: scope: team_data.content.write :param Nullable[:class:`dropbox.team.SyncSettingArg`] sync_setting: Sync setting to apply to the team folder itself. Only meaningful if the team folder is not a shared team root. :param Nullable[List[:class:`dropbox.team.ContentSyncSettingArg`]] content_sync_settings: Sync settings to apply to contents of this team folder. :rtype: :class:`dropbox.team.TeamFolderMetadata` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.TeamFolderUpdateSyncSettingsError`

Returns the member profile of the admin who generated the team access token used to make the call. Route attributes: scope: team_info.read :rtype: :class:`dropbox.team.TokenGetAuthenticatedAdminResult` :raises: :class:`.exceptions.ApiError` If this raises, ApiError will contain: :class:`dropbox.team.TokenGetAuthenticatedAdminError`