type: object properties: data: type: object description: > Arguments for methods that poll the status of an asynchronous job. async_job_id: Id of the asynchronous job. This is the value of a response returned from the method that launched the job. properties: async_job_id: type: string description: >- Id of the asynchronous job. This is the value of a response returned from the method that launched the job. title: Data

type: object description: > in_progress: The asynchronous job is still in progress. complete: Removing the folder member has finished. The value is information about whether the member has another form of access. failed: None properties: failed: type: object description: > access_error: None member_error: None folder_owner: The target user is the owner of the shared folder. You can't remove this user until ownership has been transferred to another member. group_access: The target user has access to the shared folder via a group. team_folder: This action cannot be performed on a team shared folder. no_permission: The current user does not have permission to perform this action. too_many_files: This shared folder has too many files for leaving a copy. You can still remove this user without leaving a copy. other: None properties: access_error: type: object description: > There is an error accessing the shared folder. invalid_id: This shared folder ID is invalid. not_a_member: The user is not a member of the shared folder thus cannot access it. email_unverified: Never set. unmounted: The shared folder is unmounted. other: None properties: .tag: title: Choice of SharedFolderAccessError type: string enum: - invalid_id - not_a_member - email_unverified - unmounted - other .tag: title: Choice of RemoveFolderMemberError type: string enum: - access_error - member_error - folder_owner - group_access - team_folder - no_permission - too_many_files - other member_error: type: object description: > invalid_dropbox_id: The target dropbox_id is invalid. not_a_member: The target dropbox_id is not a member of the shared folder. no_explicit_access: The target member only has inherited access to the shared folder. other: None properties: .tag: title: Choice of SharedFolderMemberError type: string enum: - invalid_dropbox_id - not_a_member - no_explicit_access - other no_explicit_access: type: object description: > Contains information about a member's access level to content after an operation. access_level: The member still has this level of access to the content through a parent folder. warning: A localized string with additional information about why the user has this access level to the content. access_details: The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. properties: access_level: type: object description: > Defines the access levels for collaborators. owner: The collaborator is the owner of the shared folder. Owners can view and edit the shared folder as well as set the folder's policies using :route:`update_folder_policy`. editor: The collaborator can both view and edit the shared folder. viewer: The collaborator can only view the shared folder. viewer_no_comment: The collaborator can only view the shared folder and does not have any access to comments. other: None properties: .tag: title: Choice of AccessLevel type: string enum: - owner - editor - viewer - viewer_no_comment - other access_details: type: array description: >- The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. items: type: object description: > Contains information about a parent folder that a member has access to. folder_name: Display name for the folder. shared_folder_id: The identifier of the parent shared folder. permissions: The user's permissions for the parent shared folder. path: The full path to the parent shared folder relative to the acting user's root. properties: path: type: string description: >- The full path to the parent shared folder relative to the acting user's root. shared_folder_id: type: string description: The identifier of the parent shared folder. folder_name: type: string description: Display name for the folder. permissions: type: array description: The user's permissions for the parent shared folder. items: type: object description: > Whether the user is allowed to take the action on the associated member. action: The action that the user may wish to take on the member. allow: True if the user is allowed to take the action. reason: The reason why the user is denied the permission. Not present if the action is allowed. properties: action: type: object description: > Actions that may be taken on members of a shared folder. leave_a_copy: Allow the member to keep a copy of the folder when removing. make_editor: Make the member an editor of the folder. make_owner: Make the member an owner of the folder. make_viewer: Make the member a viewer of the folder. make_viewer_no_comment: Make the member a viewer of the folder without commenting permissions. remove: Remove the member from the folder. other: None properties: .tag: title: Choice of MemberAction type: string enum: - leave_a_copy - make_editor - make_owner - make_viewer - make_viewer_no_comment - remove - other reason: type: object description: > Possible reasons the user is denied a permission. user_not_same_team_as_owner: User is not on the same team as the folder owner. user_not_allowed_by_owner: User is prohibited by the owner from taking the action. target_is_indirect_member: Target is indirectly a member of the folder, for example by being part of a group. target_is_owner: Target is the owner of the folder. target_is_self: Target is the user itself. target_not_active: Target is not an active member of the team. folder_is_limited_team_folder: Folder is team folder for a limited team. owner_not_on_team: The content owner needs to be on a Dropbox team to perform this action. permission_denied: The user does not have permission to perform this action on the link. restricted_by_team: The user's team policy prevents performing this action on the link. user_account_type: The user's account type does not support this action. user_not_on_team: The user needs to be on a Dropbox team to perform this action. folder_is_inside_shared_folder: Folder is inside of another shared folder. restricted_by_parent_folder: Policy cannot be changed due to restrictions from parent folder. insufficient_plan: None other: None properties: insufficient_plan: type: object description: > message: A message to tell the user to upgrade in order to support expected action. upsell_url: A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. properties: message: type: string description: >- A message to tell the user to upgrade in order to support expected action. upsell_url: type: string description: >- A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. .tag: title: Choice of PermissionDeniedReason type: string enum: - user_not_same_team_as_owner - user_not_allowed_by_owner - target_is_indirect_member - target_is_owner - target_is_self - target_not_active - folder_is_limited_team_folder - owner_not_on_team - permission_denied - restricted_by_team - user_account_type - user_not_on_team - folder_is_inside_shared_folder - restricted_by_parent_folder - insufficient_plan - other allow: type: boolean description: True if the user is allowed to take the action. warning: type: string description: >- A localized string with additional information about why the user has this access level to the content. .tag: title: Choice of RemoveMemberJobStatus type: string enum: - in_progress - complete - failed complete: type: object description: > Contains information about a member's access level to content after an operation. access_level: The member still has this level of access to the content through a parent folder. warning: A localized string with additional information about why the user has this access level to the content. access_details: The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. properties: access_level: type: object description: > Defines the access levels for collaborators. owner: The collaborator is the owner of the shared folder. Owners can view and edit the shared folder as well as set the folder's policies using :route:`update_folder_policy`. editor: The collaborator can both view and edit the shared folder. viewer: The collaborator can only view the shared folder. viewer_no_comment: The collaborator can only view the shared folder and does not have any access to comments. other: None properties: .tag: title: Choice of AccessLevel type: string enum: - owner - editor - viewer - viewer_no_comment - other access_details: type: array description: >- The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. items: type: object description: > Contains information about a parent folder that a member has access to. folder_name: Display name for the folder. shared_folder_id: The identifier of the parent shared folder. permissions: The user's permissions for the parent shared folder. path: The full path to the parent shared folder relative to the acting user's root. properties: path: type: string description: >- The full path to the parent shared folder relative to the acting user's root. shared_folder_id: type: string description: The identifier of the parent shared folder. folder_name: type: string description: Display name for the folder. permissions: type: array description: The user's permissions for the parent shared folder. items: type: object description: > Whether the user is allowed to take the action on the associated member. action: The action that the user may wish to take on the member. allow: True if the user is allowed to take the action. reason: The reason why the user is denied the permission. Not present if the action is allowed. properties: action: type: object description: > Actions that may be taken on members of a shared folder. leave_a_copy: Allow the member to keep a copy of the folder when removing. make_editor: Make the member an editor of the folder. make_owner: Make the member an owner of the folder. make_viewer: Make the member a viewer of the folder. make_viewer_no_comment: Make the member a viewer of the folder without commenting permissions. remove: Remove the member from the folder. other: None properties: .tag: title: Choice of MemberAction type: string enum: - leave_a_copy - make_editor - make_owner - make_viewer - make_viewer_no_comment - remove - other reason: type: object description: > Possible reasons the user is denied a permission. user_not_same_team_as_owner: User is not on the same team as the folder owner. user_not_allowed_by_owner: User is prohibited by the owner from taking the action. target_is_indirect_member: Target is indirectly a member of the folder, for example by being part of a group. target_is_owner: Target is the owner of the folder. target_is_self: Target is the user itself. target_not_active: Target is not an active member of the team. folder_is_limited_team_folder: Folder is team folder for a limited team. owner_not_on_team: The content owner needs to be on a Dropbox team to perform this action. permission_denied: The user does not have permission to perform this action on the link. restricted_by_team: The user's team policy prevents performing this action on the link. user_account_type: The user's account type does not support this action. user_not_on_team: The user needs to be on a Dropbox team to perform this action. folder_is_inside_shared_folder: Folder is inside of another shared folder. restricted_by_parent_folder: Policy cannot be changed due to restrictions from parent folder. insufficient_plan: None other: None properties: insufficient_plan: type: object description: > message: A message to tell the user to upgrade in order to support expected action. upsell_url: A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. properties: message: type: string description: >- A message to tell the user to upgrade in order to support expected action. upsell_url: type: string description: >- A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. .tag: title: Choice of PermissionDeniedReason type: string enum: - user_not_same_team_as_owner - user_not_allowed_by_owner - target_is_indirect_member - target_is_owner - target_is_self - target_not_active - folder_is_limited_team_folder - owner_not_on_team - permission_denied - restricted_by_team - user_account_type - user_not_on_team - folder_is_inside_shared_folder - restricted_by_parent_folder - insufficient_plan - other allow: type: boolean description: True if the user is allowed to take the action. warning: type: string description: >- A localized string with additional information about why the user has this access level to the content.