Dropbox Node SDK

Global

Methods

checkAndRefreshAccessToken()

Checks if a token is needed, can be refreshed and if the token is expired. If so, attempts to refresh access token
Returns:
Type
Promise.<*>

getAccessToken()

Get the access token
Returns:
Access token
Type
String

getAccessTokenExpiresAt()

Gets the access token's expiration date
Returns:
date of token expiration
Type
Date

getAccessTokenFromCode(redirectUri, code)

Get an OAuth2 access token from an OAuth2 Code.
Parameters:
Name Type Description
redirectUri String A URL to redirect the user to after authenticating. This must be added to your app through the admin interface.
code String An OAuth2 code.
Returns:
An object containing the token and related info (if applicable)
Type
Object

getAuthenticationUrl(redirectUri [, state] [, authType] [, tokenAccessType] [, scope] [, includeGrantedScopes] [, usePKCE])

Get a URL that can be used to authenticate users for the Dropbox API.
Parameters:
Name Type Argument Default Description
redirectUri String A URL to redirect the user to after authenticating. This must be added to your app through the admin interface.
state String <optional>
 State that will be returned in the redirect URL to help prevent cross site scripting attacks.
authType String <optional>
 token auth type, defaults to 'token', other option is 'code'
tokenAccessType String <optional>
 null type of token to request. From the following: null - creates a token with the app default (either legacy or online) legacy - creates one long-lived token with no expiration online - create one short-lived token with an expiration offline - create one short-lived token with an expiration with a refresh token
scope Array.<String> <optional>
 null scopes to request for the grant
includeGrantedScopes String <optional>
 none whether or not to include previously granted scopes. From the following: user - include user scopes in the grant team - include team scopes in the grant Note: if this user has never linked the app, include_granted_scopes must be None
usePKCE boolean <optional>
 false Whether or not to use Sha256 based PKCE. PKCE should be only use on client apps which doesn't call your server. It is less secure than non-PKCE flow but can be used if you are unable to safely retrieve your app secret
Returns:
- Url to send user to for Dropbox API authentication returned in a promise
Type
Promise.<String>

getClientId()

Get the client id
Returns:
Client id
Type
String

getClientSecret()

Get the client secret
Returns:
Client secret
Type
String

getCodeVerifier()

Gets the code verifier for PKCE flow
Returns:
- code verifier for PKCE
Type
String

getRefreshToken()

Gets the refresh token
Returns:
Refresh token
Type
String

refreshAccessToken(scope)

Refreshes the access token using the refresh token, if available
Parameters:
Name Type Default Description
scope Array.<String> null a subset of scopes from the original refresh to acquire with an access token
Returns:
Type
Promise.<*>

setAccessToken(accessToken)

Set the access token used to authenticate requests to the API.
Parameters:
Name Type Description
accessToken String An access token
Returns:
Type
undefined

setAccessTokenExpiresAt(accessTokenExpiresAt)

Sets the access token's expiration date
Parameters:
Name Type Description
accessTokenExpiresAt new expiration date

setClientId(clientId)

Set the client id, which is used to help gain an access token.
Parameters:
Name Type Description
clientId String Your apps client id
Returns:
Type
undefined

setClientSecret(clientSecret)

Set the client secret
Parameters:
Name Type Description
clientSecret String Your app's client secret
Returns:
Type
undefined

setCodeVerifier(codeVerifier)

Sets the code verifier for PKCE flow
Parameters:
Name Type Description
codeVerifier String new code verifier

setRefreshToken(refreshToken)

Sets the refresh token
Parameters:
Name Type Description
refreshToken A refresh token

Type Definitions

AccountPhotoSourceArg

Type:
  • Object
Properties:
Name Type Argument Description
base64_data string <optional>
 Available if .tag is base64_data. Image data in base64-encoded bytes.
.tag 'base64_data' | 'other' Tag identifying the union variant.

AccountSetProfilePhotoArg

Type:
  • Object
Properties:
Name Type Description
photo AccountPhotoSourceArg Image to set as the user's new profile photo.

AccountSetProfilePhotoError

Type:
  • Object
Properties:
Name Type Description
.tag 'file_type_error' | 'file_size_error' | 'dimension_error' | 'thumbnail_error' | 'transient_error' | 'other' Tag identifying the union variant.

AccountSetProfilePhotoResult

Type:
  • Object
Properties:
Name Type Description
profile_photo_url string URL for the photo representing the user, if one is set.

AsyncLaunchEmptyResult

Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
.tag 'async_job_id' | 'complete' Tag identifying the union variant.

AsyncLaunchResultBase

Result returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response. See LaunchEmptyResult for an example.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
.tag 'async_job_id' Tag identifying the union variant.

AsyncPollArg

Arguments for methods that poll the status of an asynchronous job.
Type:
  • Object
Properties:
Name Type Description
async_job_id string Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

AsyncPollEmptyResult

Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned.
Type:
  • Object
Properties:
Name Type Description
.tag 'in_progress' | 'complete' Tag identifying the union variant.

AsyncPollError

Error returned by methods for polling the status of asynchronous job.
Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_async_job_id' | 'internal_error' | 'other' Tag identifying the union variant.

AsyncPollResultBase

Result returned by methods that poll for the status of an asynchronous job. Unions that extend this union should add a 'complete' field with a type of the information returned upon job completion. See PollEmptyResult for an example.
Type:
  • Object
Properties:
Name Type Description
.tag 'in_progress' Tag identifying the union variant.

AuthAccessError

Error occurred because the account doesn't have permission to access the resource.
Type:
  • Object
Properties:
Name Type Argument Description
invalid_account_type AuthInvalidAccountTypeError <optional>
 Available if .tag is invalid_account_type. Current account type cannot access the resource.
paper_access_denied AuthPaperAccessError <optional>
 Available if .tag is paper_access_denied. Current account cannot access Paper.
.tag 'invalid_account_type' | 'paper_access_denied' | 'other' Tag identifying the union variant.

AuthAuthError

Errors occurred during authentication.
Type:
  • Object
Properties:
Name Type Argument Description
missing_scope AuthTokenScopeError <optional>
 Available if .tag is missing_scope. The access token does not have the required scope to access the route.
.tag 'invalid_access_token' | 'invalid_select_user' | 'invalid_select_admin' | 'user_suspended' | 'expired_access_token' | 'missing_scope' | 'route_access_denied' | 'other' Tag identifying the union variant.

AuthInvalidAccountTypeError

Type:
  • Object
Properties:
Name Type Description
.tag 'endpoint' | 'feature' | 'other' Tag identifying the union variant.

AuthPaperAccessError

Type:
  • Object
Properties:
Name Type Description
.tag 'paper_disabled' | 'not_paper_user' | 'other' Tag identifying the union variant.

AuthRateLimitError

Error occurred because the app is being rate limited.
Type:
  • Object
Properties:
Name Type Description
reason AuthRateLimitReason The reason why the app is being rate limited.
retry_after number The number of seconds that the app should wait before making another request.

AuthRateLimitReason

Type:
  • Object
Properties:
Name Type Description
.tag 'too_many_requests' | 'too_many_write_operations' | 'other' Tag identifying the union variant.

AuthTokenFromOAuth1Arg

Type:
  • Object
Properties:
Name Type Description
oauth1_token string The supplied OAuth 1.0 access token.
oauth1_token_secret string The token secret associated with the supplied access token.

AuthTokenFromOAuth1Error

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_oauth1_token_info' | 'app_id_mismatch' | 'other' Tag identifying the union variant.

AuthTokenFromOAuth1Result

Type:
  • Object
Properties:
Name Type Description
oauth2_token string The OAuth 2.0 token generated from the supplied OAuth 1.0 token.

AuthTokenScopeError

Type:
  • Object
Properties:
Name Type Description
required_scope string The required scope to access the route.

CheckEchoArg

EchoArg contains the arguments to be sent to the Dropbox servers.
Type:
  • Object
Properties:
Name Type Description
query string The string that you'd like to be echoed back to you.

CheckEchoResult

EchoResult contains the result returned from the Dropbox servers.
Type:
  • Object
Properties:
Name Type Description
result string If everything worked correctly, this would be the same as query.

CommonPathRoot

Type:
  • Object
Properties:
Name Type Argument Description
root string <optional>
 Available if .tag is root. Paths are relative to the authenticating user's root namespace (This results in :field:`PathRootError.invalid_root` if the user's root namespace has changed.).
namespace_id string <optional>
 Available if .tag is namespace_id. Paths are relative to given namespace id (This results in :field:`PathRootError.no_permission` if you don't have access to this namespace.).
.tag 'home' | 'root' | 'namespace_id' | 'other' Tag identifying the union variant.

CommonPathRootError

Type:
  • Object
Properties:
Name Type Argument Description
invalid_root CommonTeamRootInfo | CommonUserRootInfo | CommonRootInfo <optional>
 Available if .tag is invalid_root. The root namespace id in Dropbox-API-Path-Root header is not valid. The value of this error is the user's latest root info.
.tag 'invalid_root' | 'no_permission' | 'other' Tag identifying the union variant.

CommonRootInfo

Information about current user's root.
Type:
  • Object
Properties:
Name Type Description
.tag "team" | "user" Tag identifying the subtype variant.
root_namespace_id string The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root. Otherwise it will be same as RootInfo.home_namespace_id.
home_namespace_id string The namespace ID for user's home namespace.

CommonTeamRootInfo

Root info when user is member of a team with a separate root namespace ID.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'team' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
root_namespace_id string The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root. Otherwise it will be same as RootInfo.home_namespace_id.
home_namespace_id string The namespace ID for user's home namespace.
home_path string The path for user's home directory under the shared team root.

CommonUserRootInfo

Root info when user is not member of a team or the user is a member of a team and the team does not have a separate root namespace.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'user' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
root_namespace_id string The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root. Otherwise it will be same as RootInfo.home_namespace_id.
home_namespace_id string The namespace ID for user's home namespace.

ContactsDeleteManualContactsArg

Type:
  • Object
Properties:
Name Type Description
email_addresses Array.<Object> List of manually added contacts to be deleted.

ContactsDeleteManualContactsError

Type:
  • Object
Properties:
Name Type Argument Description
contacts_not_found Array.<Object> <optional>
 Available if .tag is contacts_not_found. Can't delete contacts from this list. Make sure the list only has manually added contacts. The deletion was cancelled.
.tag 'contacts_not_found' | 'other' Tag identifying the union variant.

Error

An Error object returned from a route.
Type:
  • Object
Properties:
Name Type Description
error_summary string Text summary of the error.
error T The error object.
user_message UserMessage An optional field. If present, it includes a message that can be shown directly to the end user of your app. You should show this message if your app is unprepared to programmatically handle the error returned by an endpoint.

FilePropertiesAddPropertiesArg

Type:
  • Object
Properties:
Name Type Description
path string A unique identifier for the file or folder.
property_groups Array.<FilePropertiesPropertyGroup> The property groups which are to be added to a Dropbox file. No two groups in the input should refer to the same template.

FilePropertiesAddPropertiesError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
path FilePropertiesLookupError <optional>
 Available if .tag is path.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'path' | 'unsupported_folder' | 'property_field_too_large' | 'does_not_fit_template' | 'duplicate_property_groups' | 'property_group_already_exists' Tag identifying the union variant.

FilePropertiesAddTemplateArg

Type:
  • Object
Properties:
Name Type Description
name string Display name for the template. Template names can be up to 256 bytes.
description string Description for the template. Template descriptions can be up to 1024 bytes.
fields Array.<FilePropertiesPropertyFieldTemplate> Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.

FilePropertiesAddTemplateResult

Type:
  • Object
Properties:
Name Type Description
template_id string An identifier for template added by See templates/add_for_user or templates/add_for_team.

FilePropertiesGetTemplateArg

Type:
  • Object
Properties:
Name Type Description
template_id string An identifier for template added by route See templates/add_for_user or templates/add_for_team.

FilePropertiesGetTemplateResult

Type:
  • Object
Properties:
Name Type Description
name string Display name for the template. Template names can be up to 256 bytes.
description string Description for the template. Template descriptions can be up to 1024 bytes.
fields Array.<FilePropertiesPropertyFieldTemplate> Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.

FilePropertiesInvalidPropertyGroupError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
path FilePropertiesLookupError <optional>
 Available if .tag is path.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'path' | 'unsupported_folder' | 'property_field_too_large' | 'does_not_fit_template' | 'duplicate_property_groups' Tag identifying the union variant.

FilePropertiesListTemplateResult

Type:
  • Object
Properties:
Name Type Description
template_ids Array.<Object> List of identifiers for templates added by See templates/add_for_user or templates/add_for_team.

FilePropertiesLogicalOperator

Logical operator to join search queries together.
Type:
  • Object
Properties:
Name Type Description
.tag 'or_operator' | 'other' Tag identifying the union variant.

FilePropertiesLookupError

Type:
  • Object
Properties:
Name Type Argument Description
malformed_path string <optional>
 Available if .tag is malformed_path.
.tag 'malformed_path' | 'not_found' | 'not_file' | 'not_folder' | 'restricted_content' | 'other' Tag identifying the union variant.

FilePropertiesLookUpPropertiesError

Type:
  • Object
Properties:
Name Type Description
.tag 'property_group_not_found' | 'other' Tag identifying the union variant.

FilePropertiesModifyTemplateError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'conflicting_property_names' | 'too_many_properties' | 'too_many_templates' | 'template_attribute_too_large' Tag identifying the union variant.

FilePropertiesOverwritePropertyGroupArg

Type:
  • Object
Properties:
Name Type Description
path string A unique identifier for the file or folder.
property_groups Array.<FilePropertiesPropertyGroup> The property groups "snapshot" updates to force apply. No two groups in the input should refer to the same template.

FilePropertiesPropertiesError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
path FilePropertiesLookupError <optional>
 Available if .tag is path.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'path' | 'unsupported_folder' Tag identifying the union variant.

FilePropertiesPropertiesSearchArg

Type:
  • Object
Properties:
Name Type Description
queries Array.<FilePropertiesPropertiesSearchQuery> Queries to search.
template_filter FilePropertiesTemplateFilter Filter results to contain only properties associated with these template IDs.

FilePropertiesPropertiesSearchContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by your last call to properties/search or properties/search/continue.

FilePropertiesPropertiesSearchContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'reset' | 'other' Tag identifying the union variant.

FilePropertiesPropertiesSearchError

Type:
  • Object
Properties:
Name Type Argument Description
property_group_lookup FilePropertiesLookUpPropertiesError <optional>
 Available if .tag is property_group_lookup.
.tag 'property_group_lookup' | 'other' Tag identifying the union variant.

FilePropertiesPropertiesSearchMatch

Type:
  • Object
Properties:
Name Type Description
id string The ID for the matched file or folder.
path string The path for the matched file or folder.
is_deleted boolean Whether the file or folder is deleted.
property_groups Array.<FilePropertiesPropertyGroup> List of custom property groups associated with the file.

FilePropertiesPropertiesSearchMode

Type:
  • Object
Properties:
Name Type Argument Description
field_name string <optional>
 Available if .tag is field_name. Search for a value associated with this field name.
.tag 'field_name' | 'other' Tag identifying the union variant.

FilePropertiesPropertiesSearchQuery

Type:
  • Object
Properties:
Name Type Description
query string The property field value for which to search across templates.
mode FilePropertiesPropertiesSearchMode The mode with which to perform the search.
logical_operator FilePropertiesLogicalOperator The logical operator with which to append the query.

FilePropertiesPropertiesSearchResult

Type:
  • Object
Properties:
Name Type Argument Description
matches Array.<FilePropertiesPropertiesSearchMatch> A list (possibly empty) of matches for the query.
cursor string <optional>
 Pass the cursor into properties/search/continue to continue to receive search results. Cursor will be null when there are no more results.

FilePropertiesPropertyField

Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a PropertyGroup.
Type:
  • Object
Properties:
Name Type Description
name string Key of the property field associated with a file and template. Keys can be up to 256 bytes.
value string Value of the property field associated with a file and template. Values can be up to 1024 bytes.

FilePropertiesPropertyFieldTemplate

Defines how a single property field may be structured. Used exclusively by PropertyGroupTemplate.
Type:
  • Object
Properties:
Name Type Description
name string Key of the property field being described. Property field keys can be up to 256 bytes.
description string Description of the property field. Property field descriptions can be up to 1024 bytes.
type FilePropertiesPropertyType Data type of the value of this property field. This type will be enforced upon property creation and modifications.

FilePropertiesPropertyGroup

A subset of the property fields described by the corresponding PropertyGroupTemplate. Properties are always added to a Dropbox file as a PropertyGroup. The possible key names and value types in this group are defined by the corresponding PropertyGroupTemplate.
Type:
  • Object
Properties:
Name Type Description
template_id string A unique identifier for the associated template.
fields Array.<FilePropertiesPropertyField> The actual properties associated with the template. There can be up to 32 property types per template.

FilePropertiesPropertyGroupTemplate

Defines how a property group may be structured.
Type:
  • Object
Properties:
Name Type Description
name string Display name for the template. Template names can be up to 256 bytes.
description string Description for the template. Template descriptions can be up to 1024 bytes.
fields Array.<FilePropertiesPropertyFieldTemplate> Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.

FilePropertiesPropertyGroupUpdate

Type:
  • Object
Properties:
Name Type Argument Description
template_id string A unique identifier for a property template.
add_or_update_fields Array.<FilePropertiesPropertyField> <optional>
 Property fields to update. If the property field already exists, it is updated. If the property field doesn't exist, the property group is added.
remove_fields Array.<string> <optional>
 Property fields to remove (by name), provided they exist.

FilePropertiesPropertyType

Data type of the given property field added.
Type:
  • Object
Properties:
Name Type Description
.tag 'string' | 'other' Tag identifying the union variant.

FilePropertiesRemovePropertiesArg

Type:
  • Object
Properties:
Name Type Description
path string A unique identifier for the file or folder.
property_template_ids Array.<Object> A list of identifiers for a template created by templates/add_for_user or templates/add_for_team.

FilePropertiesRemovePropertiesError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
path FilePropertiesLookupError <optional>
 Available if .tag is path.
property_group_lookup FilePropertiesLookUpPropertiesError <optional>
 Available if .tag is property_group_lookup.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'path' | 'unsupported_folder' | 'property_group_lookup' Tag identifying the union variant.

FilePropertiesRemoveTemplateArg

Type:
  • Object
Properties:
Name Type Description
template_id string An identifier for a template created by templates/add_for_user or templates/add_for_team.

FilePropertiesTemplateError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
.tag 'template_not_found' | 'restricted_content' | 'other' Tag identifying the union variant.

FilePropertiesTemplateFilter

Type:
  • Object
Properties:
Name Type Argument Description
filter_some Array.<Object> <optional>
 Available if .tag is filter_some. Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).
.tag 'filter_some' | 'other' | 'filter_none' Tag identifying the union variant.

FilePropertiesTemplateFilterBase

Type:
  • Object
Properties:
Name Type Argument Description
filter_some Array.<Object> <optional>
 Available if .tag is filter_some. Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).
.tag 'filter_some' | 'other' Tag identifying the union variant.

FilePropertiesTemplateOwnerType

Type:
  • Object
Properties:
Name Type Description
.tag 'user' | 'team' | 'other' Tag identifying the union variant.

FilePropertiesUpdatePropertiesArg

Type:
  • Object
Properties:
Name Type Description
path string A unique identifier for the file or folder.
update_property_groups Array.<FilePropertiesPropertyGroupUpdate> - The property groups "delta" updates to apply.

FilePropertiesUpdatePropertiesError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
path FilePropertiesLookupError <optional>
 Available if .tag is path.
property_group_lookup FilePropertiesLookUpPropertiesError <optional>
 Available if .tag is property_group_lookup.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'path' | 'unsupported_folder' | 'property_field_too_large' | 'does_not_fit_template' | 'duplicate_property_groups' | 'property_group_lookup' Tag identifying the union variant.

FilePropertiesUpdateTemplateArg

Type:
  • Object
Properties:
Name Type Argument Description
template_id string An identifier for template added by See templates/add_for_user or templates/add_for_team.
name string <optional>
 A display name for the template. template names can be up to 256 bytes.
description string <optional>
 Description for the new template. Template descriptions can be up to 1024 bytes.
add_fields Array.<FilePropertiesPropertyFieldTemplate> <optional>
 Property field templates to be added to the group template. There can be up to 32 properties in a single template.

FilePropertiesUpdateTemplateResult

Type:
  • Object
Properties:
Name Type Description
template_id string An identifier for template added by route See templates/add_for_user or templates/add_for_team.

FileRequestsCountFileRequestsError

There was an error counting the file requests.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' Tag identifying the union variant.

FileRequestsCountFileRequestsResult

Result for count.
Type:
  • Object
Properties:
Name Type Description
file_request_count number The number file requests owner by this user.

FileRequestsCreateFileRequestArgs

Arguments for create.
Type:
  • Object
Properties:
Name Type Argument Description
title string The title of the file request. Must not be empty.
destination string The path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
deadline FileRequestsFileRequestDeadline <optional>
 The deadline for the file request. Deadlines can only be set by Professional and Business accounts.
open boolean Whether or not the file request should be open. If the file request is closed, it will not accept any file submissions, but it can be opened later.
description string <optional>
 A description of the file request.

FileRequestsCreateFileRequestError

There was an error creating the file request.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' | 'invalid_location' | 'rate_limit' Tag identifying the union variant.

FileRequestsDeleteAllClosedFileRequestsError

There was an error deleting all closed file requests.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' Tag identifying the union variant.

FileRequestsDeleteAllClosedFileRequestsResult

Result for delete_all_closed.
Type:
  • Object
Properties:
Name Type Description
file_requests Array.<FileRequestsFileRequest> The file requests deleted for this user.

FileRequestsDeleteFileRequestArgs

Arguments for delete.
Type:
  • Object
Properties:
Name Type Description
ids Array.<Object> List IDs of the file requests to delete.

FileRequestsDeleteFileRequestError

There was an error deleting these file requests.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' | 'file_request_open' Tag identifying the union variant.

FileRequestsDeleteFileRequestsResult

Result for delete.
Type:
  • Object
Properties:
Name Type Description
file_requests Array.<FileRequestsFileRequest> The file requests deleted by the request.

FileRequestsFileRequest

A file request https://www.dropbox.com/help/9090 for receiving files into the user's Dropbox account.
Type:
  • Object
Properties:
Name Type Argument Description
id string The ID of the file request.
url string The URL of the file request.
title string The title of the file request.
created Timestamp When this file request was created.
is_open boolean Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions.
file_count number The number of files this file request has received.
destination string <optional>
 The path of the folder in the Dropbox where uploaded files will be sent. This can be null if the destination was removed. For apps with the app folder permission, this will be relative to the app folder.
deadline FileRequestsFileRequestDeadline <optional>
 The deadline for this file request. Only set if the request has a deadline.
description string <optional>
 A description of the file request.

FileRequestsFileRequestDeadline

Type:
  • Object
Properties:
Name Type Argument Description
deadline Timestamp The deadline for this file request.
allow_late_uploads FileRequestsGracePeriod <optional>
 If set, allow uploads after the deadline has passed. These uploads will be marked overdue.

FileRequestsFileRequestError

There is an error with the file request.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' Tag identifying the union variant.

FileRequestsGeneralFileRequestsError

There is an error accessing the file requests functionality.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' Tag identifying the union variant.

FileRequestsGetFileRequestArgs

Arguments for get.
Type:
  • Object
Properties:
Name Type Description
id string The ID of the file request to retrieve.

FileRequestsGetFileRequestError

There was an error retrieving the specified file request.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' Tag identifying the union variant.

FileRequestsGracePeriod

Type:
  • Object
Properties:
Name Type Description
.tag 'one_day' | 'two_days' | 'seven_days' | 'thirty_days' | 'always' | 'other' Tag identifying the union variant.

FileRequestsListFileRequestsArg

Arguments for list:2.
Type:
  • Object
Properties:
Name Type Description
limit number The maximum number of file requests that should be returned per request.

FileRequestsListFileRequestsContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by the previous API call specified in the endpoint description.

FileRequestsListFileRequestsContinueError

There was an error retrieving the file requests.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'invalid_cursor' Tag identifying the union variant.

FileRequestsListFileRequestsError

There was an error retrieving the file requests.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' Tag identifying the union variant.

FileRequestsListFileRequestsResult

Result for list.
Type:
  • Object
Properties:
Name Type Description
file_requests Array.<FileRequestsFileRequest> The file requests owned by this user. Apps with the app folder permission will only see file requests in their app folder.

FileRequestsListFileRequestsV2Result

Result for list:2 and list/continue.
Type:
  • Object
Properties:
Name Type Description
file_requests Array.<FileRequestsFileRequest> The file requests owned by this user. Apps with the app folder permission will only see file requests in their app folder.
cursor string Pass the cursor into list/continue to obtain additional file requests.
has_more boolean Is true if there are additional file requests that have not been returned yet. An additional call to :route:list/continue` can retrieve them.

FileRequestsUpdateFileRequestArgs

Arguments for update.
Type:
  • Object
Properties:
Name Type Argument Description
id string The ID of the file request to update.
title string <optional>
 The new title of the file request. Must not be empty.
destination string <optional>
 The new path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
deadline FileRequestsUpdateFileRequestDeadline The new deadline for the file request. Deadlines can only be set by Professional and Business accounts.
open boolean <optional>
 Whether to set this file request as open or closed.
description string <optional>
 The description of the file request.

FileRequestsUpdateFileRequestDeadline

Type:
  • Object
Properties:
Name Type Argument Description
update FileRequestsFileRequestDeadline <optional>
 Available if .tag is update. If :val:`null`, the file request's deadline is cleared.
.tag 'no_update' | 'update' | 'other' Tag identifying the union variant.

FileRequestsUpdateFileRequestError

There is an error updating the file request.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' Tag identifying the union variant.

FilesAddTagArg

Type:
  • Object
Properties:
Name Type Description
path string Path to the item to be tagged.
tag_text string The value of the tag to add. Will be automatically converted to lowercase letters.

FilesAddTagError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' | 'too_many_tags' Tag identifying the union variant.

FilesAlphaGetMetadataArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path of a file or folder on Dropbox.
include_media_info boolean If true, FileMetadata.media_info is set for photo and video.
include_deleted boolean If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned.
include_has_explicit_shared_members boolean If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
include_property_groups FilePropertiesTemplateFilterBase <optional>
 If set to a valid list of template IDs, FileMetadata.property_groups is set if there exists property data associated with the file and each of the listed templates.
include_property_templates Array.<Object> <optional>
 If set to a valid list of template IDs, FileMetadata.property_groups is set for files with custom properties.

FilesAlphaGetMetadataError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
properties_error FilePropertiesLookUpPropertiesError <optional>
 Available if .tag is properties_error.
.tag 'path' | 'properties_error' Tag identifying the union variant.

FilesBaseTagError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

FilesCommitInfo

Type:
  • Object
Properties:
Name Type Argument Description
path string Path in the user's Dropbox to save the file.
mode FilesWriteMode Selects what to do if the file already exists.
autorename boolean If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
client_modified Timestamp <optional>
 The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
mute boolean Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification.
property_groups Array.<FilePropertiesPropertyGroup> <optional>
 List of custom properties to add to file.
strict_conflict boolean Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.

FilesContentSyncSetting

Type:
  • Object
Properties:
Name Type Description
id string Id of the item this setting is applied to.
sync_setting FilesSyncSetting Setting for this item.

FilesContentSyncSettingArg

Type:
  • Object
Properties:
Name Type Description
id string Id of the item this setting is applied to.
sync_setting FilesSyncSettingArg Setting for this item.

FilesCreateFolderArg

Type:
  • Object
Properties:
Name Type Description
path string Path in the user's Dropbox to create.
autorename boolean If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.

FilesCreateFolderBatchArg

Type:
  • Object
Properties:
Name Type Description
paths Array.<Object> List of paths to be created in the user's Dropbox. Duplicate path arguments in the batch are considered only once.
autorename boolean If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.
force_async boolean Whether to force the create to happen asynchronously.

FilesCreateFolderBatchError

Type:
  • Object
Properties:
Name Type Description
.tag 'too_many_files' | 'other' Tag identifying the union variant.

FilesCreateFolderBatchJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete FilesCreateFolderBatchResult <optional>
 Available if .tag is complete. The batch create folder has finished.
failed FilesCreateFolderBatchError <optional>
 Available if .tag is failed. The batch create folder has failed.
.tag 'in_progress' | 'complete' | 'failed' | 'other' Tag identifying the union variant.

FilesCreateFolderBatchLaunch

Result returned by create_folder_batch that may either launch an asynchronous job or complete synchronously.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
complete FilesCreateFolderBatchResult <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' | 'other' Tag identifying the union variant.

FilesCreateFolderBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesCreateFolderBatchResultEntry> Each entry in CreateFolderBatchArg.paths will appear at the same position inside CreateFolderBatchResult.entries.

FilesCreateFolderBatchResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesCreateFolderEntryResult <optional>
 Available if .tag is success.
failure FilesCreateFolderEntryError <optional>
 Available if .tag is failure.
.tag 'success' | 'failure' Tag identifying the union variant.

FilesCreateFolderEntryError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesWriteError <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

FilesCreateFolderEntryResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFolderMetadata Metadata of the created folder.

FilesCreateFolderError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesWriteError <optional>
 Available if .tag is path.
.tag 'path' Tag identifying the union variant.

FilesCreateFolderResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFolderMetadata Metadata of the created folder.

FilesDeleteArg

Type:
  • Object
Properties:
Name Type Argument Description
path string Path in the user's Dropbox to delete.
parent_rev string <optional>
 Perform delete if given "rev" matches the existing file's latest "rev". This field does not support deleting a folder.

FilesDeleteBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesDeleteArg>

FilesDeleteBatchError

Type:
  • Object
Properties:
Name Type Description
.tag 'too_many_write_operations' | 'other' Tag identifying the union variant.

FilesDeleteBatchJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete FilesDeleteBatchResult <optional>
 Available if .tag is complete. The batch delete has finished.
failed FilesDeleteBatchError <optional>
 Available if .tag is failed. The batch delete has failed.
.tag 'in_progress' | 'complete' | 'failed' | 'other' Tag identifying the union variant.

FilesDeleteBatchLaunch

Result returned by delete_batch that may either launch an asynchronous job or complete synchronously.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
complete FilesDeleteBatchResult <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' | 'other' Tag identifying the union variant.

FilesDeleteBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesDeleteBatchResultEntry> Each entry in DeleteBatchArg.entries will appear at the same position inside DeleteBatchResult.entries.

FilesDeleteBatchResultData

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the deleted object.

FilesDeleteBatchResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesDeleteBatchResultData <optional>
 Available if .tag is success.
failure FilesDeleteError <optional>
 Available if .tag is failure.
.tag 'success' | 'failure' Tag identifying the union variant.

FilesDeletedMetadata

Indicates that there used to be a file or folder at this path, but it no longer exists.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'deleted' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
name string The last component of the path (including extension). This never contains a slash.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.
path_display string <optional>
 The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by list_folder/continue. This field will be null if the file or folder is not mounted.
parent_shared_folder_id string <optional>
 Please use FileSharingInfo.parent_shared_folder_id or FolderSharingInfo.parent_shared_folder_id instead.
preview_url string <optional>
 The preview URL of the file.

FilesDeleteError

Type:
  • Object
Properties:
Name Type Argument Description
path_lookup FilesLookupError <optional>
 Available if .tag is path_lookup.
path_write FilesWriteError <optional>
 Available if .tag is path_write.
.tag 'path_lookup' | 'path_write' | 'too_many_write_operations' | 'too_many_files' | 'other' Tag identifying the union variant.

FilesDeleteResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the deleted object.

FilesDimensions

Dimensions for a photo or video.
Type:
  • Object
Properties:
Name Type Description
height number Height of the photo/video.
width number Width of the photo/video.

FilesDownloadArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path of the file to download.
rev string <optional>
 Please specify revision in path instead.

FilesDownloadError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'unsupported_file' | 'other' Tag identifying the union variant.

FilesDownloadZipArg

Type:
  • Object
Properties:
Name Type Description
path string The path of the folder to download.

FilesDownloadZipError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'too_large' | 'too_many_files' | 'other' Tag identifying the union variant.

FilesDownloadZipResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFolderMetadata

FilesExportArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path of the file to be exported.
export_format string <optional>
 The file format to which the file should be exported. This must be one of the formats listed in the file's export_options returned by get_metadata. If none is specified, the default format (specified in export_as in file metadata) will be used.

FilesExportError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'non_exportable' | 'invalid_export_format' | 'retry_error' | 'other' Tag identifying the union variant.

FilesExportInfo

Export information for a file.
Type:
  • Object
Properties:
Name Type Argument Description
export_as string <optional>
 Format to which the file can be exported to.
export_options Array.<string> <optional>
 Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export.

FilesExportMetadata

Type:
  • Object
Properties:
Name Type Argument Description
name string The last component of the path (including extension). This never contains a slash.
size number The file size in bytes.
export_hash string <optional>
 A hash based on the exported file content. This field can be used to verify data integrity. Similar to content hash. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.
paper_revision number <optional>
 If the file is a Paper doc, this gives the latest doc revision which can be used in paper/update.

FilesExportResult

Type:
  • Object
Properties:
Name Type Description
export_metadata FilesExportMetadata Metadata for the exported version of the file.
file_metadata FilesFileMetadata Metadata for the original file.

FilesFileCategory

Type:
  • Object
Properties:
Name Type Description
.tag 'image' | 'document' | 'pdf' | 'spreadsheet' | 'presentation' | 'audio' | 'video' | 'folder' | 'paper' | 'others' | 'other' Tag identifying the union variant.

FilesFileLock

Type:
  • Object
Properties:
Name Type Description
content FilesFileLockContent The lock description.

FilesFileLockContent

Type:
  • Object
Properties:
Name Type Argument Description
single_user FilesSingleUserLock <optional>
 Available if .tag is single_user. A lock held by a single user.
.tag 'unlocked' | 'single_user' | 'other' Tag identifying the union variant.

FilesFileLockMetadata

Type:
  • Object
Properties:
Name Type Argument Description
is_lockholder boolean <optional>
 True if caller holds the file lock.
lockholder_name string <optional>
 The display name of the lock holder.
lockholder_account_id string <optional>
 The account ID of the lock holder if known.
created Timestamp <optional>
 The timestamp of the lock was created.

FilesFileMetadata

Type:
  • Object
Properties:
Name Type Argument Description
.tag 'file' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
name string The last component of the path (including extension). This never contains a slash.
id string A unique identifier for the file.
client_modified Timestamp For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not.
server_modified Timestamp The last time the file was modified on Dropbox.
rev string A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.
size number The file size in bytes.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.
path_display string <optional>
 The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by list_folder/continue. This field will be null if the file or folder is not mounted.
parent_shared_folder_id string <optional>
 Please use FileSharingInfo.parent_shared_folder_id or FolderSharingInfo.parent_shared_folder_id instead.
preview_url string <optional>
 The preview URL of the file.
media_info FilesMediaInfo <optional>
 Additional information if the file is a photo or video. This field will not be set on entries returned by list_folder, list_folder/continue, or get_thumbnail_batch, starting December 2, 2019.
symlink_info FilesSymlinkInfo <optional>
 Set if this file is a symlink.
sharing_info FilesFileSharingInfo <optional>
 Set if this file is contained in a shared folder.
is_downloadable boolean If true, file can be downloaded directly; else the file must be exported.
export_info FilesExportInfo <optional>
 Information about format this file can be exported to. This filed must be set if is_downloadable is set to false.
property_groups Array.<FilePropertiesPropertyGroup> <optional>
 Additional information if the file has custom properties with the property template specified.
has_explicit_shared_members boolean <optional>
 This flag will only be present if include_has_explicit_shared_members is true in list_folder or get_metadata. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder.
content_hash string <optional>
 A hash of the file content. This field can be used to verify data integrity. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.
file_lock_info FilesFileLockMetadata <optional>
 If present, the metadata associated with the file's current lock.

FilesFileOpsResult

Type:
  • Object

FilesFileSharingInfo

Sharing info for a file which is contained by a shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
read_only boolean True if the file or folder is inside a read-only shared folder.
parent_shared_folder_id string ID of shared folder that holds this file.
modified_by string <optional>
 The last user who modified the file. This field will be null if the user's account has been deleted.

FilesFileStatus

Type:
  • Object
Properties:
Name Type Description
.tag 'active' | 'deleted' | 'other' Tag identifying the union variant.

FilesFolderMetadata

Type:
  • Object
Properties:
Name Type Argument Description
.tag 'folder' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
name string The last component of the path (including extension). This never contains a slash.
id string A unique identifier for the folder.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.
path_display string <optional>
 The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by list_folder/continue. This field will be null if the file or folder is not mounted.
parent_shared_folder_id string <optional>
 Please use FileSharingInfo.parent_shared_folder_id or FolderSharingInfo.parent_shared_folder_id instead.
preview_url string <optional>
 The preview URL of the file.
shared_folder_id string <optional>
 Please use sharing_info instead.
sharing_info FilesFolderSharingInfo <optional>
 Set if the folder is contained in a shared folder or is a shared folder mount point.
property_groups Array.<FilePropertiesPropertyGroup> <optional>
 Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders.

FilesFolderSharingInfo

Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.
Type:
  • Object
Properties:
Name Type Argument Description
read_only boolean True if the file or folder is inside a read-only shared folder.
parent_shared_folder_id string <optional>
 Set if the folder is contained by a shared folder.
shared_folder_id string <optional>
 If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
traverse_only boolean Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder.
no_access boolean Specifies that the folder cannot be accessed by the user.

FilesGetCopyReferenceArg

Type:
  • Object
Properties:
Name Type Description
path string The path to the file or folder you want to get a copy reference to.

FilesGetCopyReferenceError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

FilesGetCopyReferenceResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the file or folder.
copy_reference string A copy reference to the file or folder.
expires Timestamp The expiration date of the copy reference. This value is currently set to be far enough in the future so that expiration is effectively not an issue.

FilesGetMetadataArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path of a file or folder on Dropbox.
include_media_info boolean If true, FileMetadata.media_info is set for photo and video.
include_deleted boolean If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned.
include_has_explicit_shared_members boolean If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
include_property_groups FilePropertiesTemplateFilterBase <optional>
 If set to a valid list of template IDs, FileMetadata.property_groups is set if there exists property data associated with the file and each of the listed templates.

FilesGetMetadataError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' Tag identifying the union variant.

FilesGetTagsArg

Type:
  • Object
Properties:
Name Type Description
paths Array.<Object> Path to the items.

FilesGetTagsResult

Type:
  • Object
Properties:
Name Type Description
paths_to_tags Array.<FilesPathToTags> List of paths and their corresponding tags.

FilesGetTemporaryLinkArg

Type:
  • Object
Properties:
Name Type Description
path string The path to the file you want a temporary link to.

FilesGetTemporaryLinkError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'email_not_verified' | 'unsupported_file' | 'not_allowed' | 'other' Tag identifying the union variant.

FilesGetTemporaryLinkResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata Metadata of the file.
link string The temporary link which can be used to stream content the file.

FilesGetTemporaryUploadLinkArg

Type:
  • Object
Properties:
Name Type Description
commit_info FilesCommitInfo Contains the path and other optional modifiers for the future upload commit. Equivalent to the parameters provided to upload.
duration number How long before this link expires, in seconds. Attempting to start an upload with this link longer than this period of time after link creation will result in an error.

FilesGetTemporaryUploadLinkResult

Type:
  • Object
Properties:
Name Type Description
link string The temporary link which can be used to stream a file to a Dropbox location.

FilesGetThumbnailBatchArg

Arguments for get_thumbnail_batch.
Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesThumbnailArg> List of files to get thumbnails.

FilesGetThumbnailBatchError

Type:
  • Object
Properties:
Name Type Description
.tag 'too_many_files' | 'other' Tag identifying the union variant.

FilesGetThumbnailBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesGetThumbnailBatchResultEntry> List of files and their thumbnails.

FilesGetThumbnailBatchResultData

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata
thumbnail string A string containing the base64-encoded thumbnail data for this file.

FilesGetThumbnailBatchResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesGetThumbnailBatchResultData <optional>
 Available if .tag is success.
failure FilesThumbnailError <optional>
 Available if .tag is failure. The result for this file if it was an error.
.tag 'success' | 'failure' | 'other' Tag identifying the union variant.

FilesGpsCoordinates

GPS coordinates for a photo or video.
Type:
  • Object
Properties:
Name Type Description
latitude number Latitude of the GPS coordinates.
longitude number Longitude of the GPS coordinates.

FilesHighlightSpan

Type:
  • Object
Properties:
Name Type Description
highlight_str string String to be determined whether it should be highlighted or not.
is_highlighted boolean The string should be highlighted or not.

FilesImportFormat

The import format of the incoming Paper doc content.
Type:
  • Object
Properties:
Name Type Description
.tag 'html' | 'markdown' | 'plain_text' | 'other' Tag identifying the union variant.

FilesListFolderArg

Type:
  • Object
Properties:
Name Type Argument Description
path string A unique identifier for the file.
recursive boolean If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.
include_media_info boolean If true, FileMetadata.media_info is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.
include_deleted boolean If true, the results will include entries for files and folders that used to exist but were deleted.
include_has_explicit_shared_members boolean If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
include_mounted_folders boolean If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.
limit number <optional>
 The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.
shared_link FilesSharedLink <optional>
 A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, ListFolderArg.path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.
include_property_groups FilePropertiesTemplateFilterBase <optional>
 If set to a valid list of template IDs, FileMetadata.property_groups is set if there exists property data associated with the file and each of the listed templates.
include_non_downloadable_files boolean If true, include files that are not downloadable, i.e. Google Docs.

FilesListFolderContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by your last call to list_folder or list_folder/continue.

FilesListFolderContinueError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'reset' | 'other' Tag identifying the union variant.

FilesListFolderError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
template_error FilePropertiesTemplateError <optional>
 Available if .tag is template_error.
.tag 'path' | 'template_error' | 'other' Tag identifying the union variant.

FilesListFolderGetLatestCursorResult

Type:
  • Object
Properties:
Name Type Description
cursor string Pass the cursor into list_folder/continue to see what's changed in the folder since your previous query.

FilesListFolderLongpollArg

Type:
  • Object
Properties:
Name Type Description
cursor string A cursor as returned by list_folder or list_folder/continue. Cursors retrieved by setting ListFolderArg.include_media_info to true are not supported.
timeout number A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts.

FilesListFolderLongpollError

Type:
  • Object
Properties:
Name Type Description
.tag 'reset' | 'other' Tag identifying the union variant.

FilesListFolderLongpollResult

Type:
  • Object
Properties:
Name Type Argument Description
changes boolean Indicates whether new changes are available. If true, call list_folder/continue to retrieve the changes.
backoff number <optional>
 If present, backoff for at least this many seconds before calling list_folder/longpoll again.

FilesListFolderResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)> The files and (direct) subfolders in the folder.
cursor string Pass the cursor into list_folder/continue to see what's changed in the folder since your previous query.
has_more boolean If true, then there are more entries available. Pass the cursor to list_folder/continue to retrieve the rest.

FilesListRevisionsArg

Type:
  • Object
Properties:
Name Type Description
path string The path to the file you want to see the revisions of.
mode FilesListRevisionsMode Determines the behavior of the API in listing the revisions for a given file path or id.
limit number The maximum number of revision entries returned.

FilesListRevisionsError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

FilesListRevisionsMode

Type:
  • Object
Properties:
Name Type Description
.tag 'path' | 'id' | 'other' Tag identifying the union variant.

FilesListRevisionsResult

Type:
  • Object
Properties:
Name Type Argument Description
is_deleted boolean If the file identified by the latest revision in the response is either deleted or moved.
entries Array.<FilesFileMetadata> The revisions for the file. Only revisions that are not deleted will show up here.
server_deleted Timestamp <optional>
 The time of deletion if the file was deleted.

FilesLockConflictError

Type:
  • Object
Properties:
Name Type Description
lock FilesFileLock The lock that caused the conflict.

FilesLockFileArg

Type:
  • Object
Properties:
Name Type Description
path string Path in the user's Dropbox to a file.

FilesLockFileBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesLockFileArg> List of 'entries'. Each 'entry' contains a path of the file which will be locked or queried. Duplicate path arguments in the batch are considered only once.

FilesLockFileBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesLockFileResultEntry> Each Entry in the 'entries' will have '.tag' with the operation status (e.g. success), the metadata for the file and the lock state after the operation.

FilesLockFileError

Type:
  • Object
Properties:
Name Type Argument Description
path_lookup FilesLookupError <optional>
 Available if .tag is path_lookup. Could not find the specified resource.
lock_conflict FilesLockConflictError <optional>
 Available if .tag is lock_conflict. The user action conflicts with an existing lock on the file.
.tag 'path_lookup' | 'too_many_write_operations' | 'too_many_files' | 'no_write_permission' | 'cannot_be_locked' | 'file_not_shared' | 'lock_conflict' | 'internal_error' | 'other' Tag identifying the union variant.

FilesLockFileResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the file.
lock FilesFileLock The file lock state after the operation.

FilesLockFileResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesLockFileResult <optional>
 Available if .tag is success.
failure FilesLockFileError <optional>
 Available if .tag is failure.
.tag 'success' | 'failure' Tag identifying the union variant.

FilesLookupError

Type:
  • Object
Properties:
Name Type Argument Description
malformed_path string <optional>
 Available if .tag is malformed_path. The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information.
.tag 'malformed_path' | 'not_found' | 'not_file' | 'not_folder' | 'restricted_content' | 'unsupported_content_type' | 'locked' | 'other' Tag identifying the union variant.

FilesMediaInfo

Type:
  • Object
Properties:
Name Type Argument Description
metadata FilesPhotoMetadata | FilesVideoMetadata <optional>
 Available if .tag is metadata. The metadata for the photo/video.
.tag 'pending' | 'metadata' Tag identifying the union variant.

FilesMediaMetadata

Metadata for a photo or video.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "photo" | "video" Tag identifying the subtype variant.
dimensions FilesDimensions <optional>
 Dimension of the photo/video.
location FilesGpsCoordinates <optional>
 The GPS coordinate of the photo/video.
time_taken Timestamp <optional>
 The timestamp when the photo/video is taken.

FilesMetadata

Metadata for a file or folder.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "file" | "folder" | "deleted" Tag identifying the subtype variant.
name string The last component of the path (including extension). This never contains a slash.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.
path_display string <optional>
 The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by list_folder/continue. This field will be null if the file or folder is not mounted.
parent_shared_folder_id string <optional>
 Please use FileSharingInfo.parent_shared_folder_id or FolderSharingInfo.parent_shared_folder_id instead.
preview_url string <optional>
 The preview URL of the file.

FilesMetadataV2

Metadata for a file, folder or other resource types.
Type:
  • Object
Properties:
Name Type Argument Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata <optional>
 Available if .tag is metadata.
.tag 'metadata' | 'other' Tag identifying the union variant.

FilesMinimalFileLinkMetadata

Type:
  • Object
Properties:
Name Type Argument Description
url string URL of the shared link.
rev string A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.
id string <optional>
 Unique identifier for the linked file.
path string <optional>
 Full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's Dropbox.

FilesMoveBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesRelocationPath> List of entries to be moved or copied. Each entry is RelocationPath.
autorename boolean If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
allow_ownership_transfer boolean Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

FilesMoveIntoFamilyError

Type:
  • Object
Properties:
Name Type Description
.tag 'is_shared_folder' | 'other' Tag identifying the union variant.

FilesMoveIntoVaultError

Type:
  • Object
Properties:
Name Type Description
.tag 'is_shared_folder' | 'other' Tag identifying the union variant.

FilesPaperContentError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'content_malformed' | 'doc_length_exceeded' | 'image_size_exceeded' | 'other' Tag identifying the union variant.

FilesPaperCreateArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
path string The fully qualified path to the location in the user's Dropbox where the Paper Doc should be created. This should include the document's title and end with .paper.
import_format FilesImportFormat The format of the provided data.

FilesPaperCreateError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'content_malformed' | 'doc_length_exceeded' | 'image_size_exceeded' | 'other' | 'invalid_path' | 'email_unverified' | 'invalid_file_extension' | 'paper_disabled' Tag identifying the union variant.

FilesPaperCreateResult

Type:
  • Object
Properties:
Name Type Description
url string URL to open the Paper Doc.
result_path string The fully qualified path the Paper Doc was actually created at.
file_id string The id to use in Dropbox APIs when referencing the Paper Doc.
paper_revision number The current doc revision.

FilesPaperDocUpdatePolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'update' | 'overwrite' | 'prepend' | 'append' | 'other' Tag identifying the union variant.

FilesPaperUpdateArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
path string Path in the user's Dropbox to update. The path must correspond to a Paper doc or an error will be returned.
import_format FilesImportFormat The format of the provided data.
doc_update_policy FilesPaperDocUpdatePolicy How the provided content should be applied to the doc.
paper_revision number <optional>
 The latest doc revision. Required when doc_update_policy is update. This value must match the current revision of the doc or error revision_mismatch will be returned.

FilesPaperUpdateError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'insufficient_permissions' | 'content_malformed' | 'doc_length_exceeded' | 'image_size_exceeded' | 'other' | 'path' | 'revision_mismatch' | 'doc_archived' | 'doc_deleted' Tag identifying the union variant.

FilesPaperUpdateResult

Type:
  • Object
Properties:
Name Type Description
paper_revision number The current doc revision.
Type:
  • Object
Properties:
Name Type Argument Description
path string <optional>
 Available if .tag is path.
link FilesSharedLinkFileInfo <optional>
 Available if .tag is link.
.tag 'path' | 'link' | 'other' Tag identifying the union variant.

FilesPathToTags

Type:
  • Object
Properties:
Name Type Description
path string Path of the item.
tags Array.<FilesTag> Tags assigned to this item.

FilesPhotoMetadata

Metadata for a photo.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'photo' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
dimensions FilesDimensions <optional>
 Dimension of the photo/video.
location FilesGpsCoordinates <optional>
 The GPS coordinate of the photo/video.
time_taken Timestamp <optional>
 The timestamp when the photo/video is taken.

FilesPreviewArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path of the file to preview.
rev string <optional>
 Please specify revision in path instead.

FilesPreviewError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path. An error occurs when downloading metadata for the file.
.tag 'path' | 'in_progress' | 'unsupported_extension' | 'unsupported_content' Tag identifying the union variant.

FilesPreviewResult

Type:
  • Object
Properties:
Name Type Argument Description
file_metadata FilesFileMetadata <optional>
 Metadata corresponding to the file received as an argument. Will be populated if the endpoint is called with a path (ReadPath).
link_metadata FilesMinimalFileLinkMetadata <optional>
 Minimal metadata corresponding to the file received as an argument. Will be populated if the endpoint is called using a shared link (SharedLinkFileInfo).

FilesRelocationArg

Type:
  • Object
Properties:
Name Type Description
from_path string Path in the user's Dropbox to be copied or moved.
to_path string Path in the user's Dropbox that is the destination.
allow_shared_folder boolean This flag has no effect.
autorename boolean If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
allow_ownership_transfer boolean Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

FilesRelocationBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesRelocationPath> List of entries to be moved or copied. Each entry is RelocationPath.
autorename boolean If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
allow_shared_folder boolean This flag has no effect.
allow_ownership_transfer boolean Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

FilesRelocationBatchArgBase

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesRelocationPath> List of entries to be moved or copied. Each entry is RelocationPath.
autorename boolean If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.

FilesRelocationBatchError

Type:
  • Object
Properties:
Name Type Argument Description
from_lookup FilesLookupError <optional>
 Available if .tag is from_lookup.
from_write FilesWriteError <optional>
 Available if .tag is from_write.
to FilesWriteError <optional>
 Available if .tag is to.
cant_move_into_vault FilesMoveIntoVaultError <optional>
 Available if .tag is cant_move_into_vault. Some content cannot be moved into Vault under certain circumstances, see detailed error.
cant_move_into_family FilesMoveIntoFamilyError <optional>
 Available if .tag is cant_move_into_family. Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.
.tag 'from_lookup' | 'from_write' | 'to' | 'cant_copy_shared_folder' | 'cant_nest_shared_folder' | 'cant_move_folder_into_itself' | 'too_many_files' | 'duplicated_or_nested_paths' | 'cant_transfer_ownership' | 'insufficient_quota' | 'internal_error' | 'cant_move_shared_folder' | 'cant_move_into_vault' | 'cant_move_into_family' | 'other' | 'too_many_write_operations' Tag identifying the union variant.

FilesRelocationBatchErrorEntry

Type:
  • Object
Properties:
Name Type Argument Description
relocation_error FilesRelocationError <optional>
 Available if .tag is relocation_error. User errors that retry won't help.
.tag 'relocation_error' | 'internal_error' | 'too_many_write_operations' | 'other' Tag identifying the union variant.

FilesRelocationBatchJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete FilesRelocationBatchResult <optional>
 Available if .tag is complete. The copy or move batch job has finished.
failed FilesRelocationBatchError <optional>
 Available if .tag is failed. The copy or move batch job has failed with exception.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

FilesRelocationBatchLaunch

Result returned by copy_batch or move_batch that may either launch an asynchronous job or complete synchronously.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
complete FilesRelocationBatchResult <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' | 'other' Tag identifying the union variant.

FilesRelocationBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesRelocationBatchResultData>

FilesRelocationBatchResultData

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the relocated object.

FilesRelocationBatchResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata <optional>
 Available if .tag is success.
failure FilesRelocationBatchErrorEntry <optional>
 Available if .tag is failure.
.tag 'success' | 'failure' | 'other' Tag identifying the union variant.

FilesRelocationBatchV2JobStatus

Result returned by copy_batch/check:2 or move_batch/check:2 that may either be in progress or completed with result for each entry.
Type:
  • Object
Properties:
Name Type Argument Description
complete FilesRelocationBatchV2Result <optional>
 Available if .tag is complete. The copy or move batch job has finished.
.tag 'in_progress' | 'complete' Tag identifying the union variant.

FilesRelocationBatchV2Launch

Result returned by copy_batch:2 or move_batch:2 that may either launch an asynchronous job or complete synchronously.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
complete FilesRelocationBatchV2Result <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' Tag identifying the union variant.

FilesRelocationBatchV2Result

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesRelocationBatchResultEntry> Each entry in CopyBatchArg.entries or MoveBatchArg.entries will appear at the same position inside RelocationBatchV2Result.entries.

FilesRelocationError

Type:
  • Object
Properties:
Name Type Argument Description
from_lookup FilesLookupError <optional>
 Available if .tag is from_lookup.
from_write FilesWriteError <optional>
 Available if .tag is from_write.
to FilesWriteError <optional>
 Available if .tag is to.
cant_move_into_vault FilesMoveIntoVaultError <optional>
 Available if .tag is cant_move_into_vault. Some content cannot be moved into Vault under certain circumstances, see detailed error.
cant_move_into_family FilesMoveIntoFamilyError <optional>
 Available if .tag is cant_move_into_family. Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.
.tag 'from_lookup' | 'from_write' | 'to' | 'cant_copy_shared_folder' | 'cant_nest_shared_folder' | 'cant_move_folder_into_itself' | 'too_many_files' | 'duplicated_or_nested_paths' | 'cant_transfer_ownership' | 'insufficient_quota' | 'internal_error' | 'cant_move_shared_folder' | 'cant_move_into_vault' | 'cant_move_into_family' | 'other' Tag identifying the union variant.

FilesRelocationPath

Type:
  • Object
Properties:
Name Type Description
from_path string Path in the user's Dropbox to be copied or moved.
to_path string Path in the user's Dropbox that is the destination.

FilesRelocationResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the relocated object.

FilesRemoveTagArg

Type:
  • Object
Properties:
Name Type Description
path string Path to the item to tag.
tag_text string The tag to remove. Will be automatically converted to lowercase letters.

FilesRemoveTagError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' | 'tag_not_present' Tag identifying the union variant.

FilesRestoreArg

Type:
  • Object
Properties:
Name Type Description
path string The path to save the restored file.
rev string The revision to restore.

FilesRestoreError

Type:
  • Object
Properties:
Name Type Argument Description
path_lookup FilesLookupError <optional>
 Available if .tag is path_lookup. An error occurs when downloading metadata for the file.
path_write FilesWriteError <optional>
 Available if .tag is path_write. An error occurs when trying to restore the file to that path.
.tag 'path_lookup' | 'path_write' | 'invalid_revision' | 'in_progress' | 'other' Tag identifying the union variant.

FilesSaveCopyReferenceArg

Type:
  • Object
Properties:
Name Type Description
copy_reference string A copy reference returned by copy_reference/get.
path string Path in the user's Dropbox that is the destination.

FilesSaveCopyReferenceError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesWriteError <optional>
 Available if .tag is path.
.tag 'path' | 'invalid_copy_reference' | 'no_permission' | 'not_found' | 'too_many_files' | 'other' Tag identifying the union variant.

FilesSaveCopyReferenceResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata The metadata of the saved file or folder in the user's Dropbox.

FilesSaveUrlArg

Type:
  • Object
Properties:
Name Type Description
path string The path in Dropbox where the URL will be saved to.
url string The URL to be saved.

FilesSaveUrlError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesWriteError <optional>
 Available if .tag is path.
.tag 'path' | 'download_failed' | 'invalid_url' | 'not_found' | 'other' Tag identifying the union variant.

FilesSaveUrlJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete FilesFileMetadata <optional>
 Available if .tag is complete. Metadata of the file where the URL is saved to.
failed FilesSaveUrlError <optional>
 Available if .tag is failed.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

FilesSaveUrlResult

Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
complete FilesFileMetadata <optional>
 Available if .tag is complete. Metadata of the file where the URL is saved to.
.tag 'async_job_id' | 'complete' Tag identifying the union variant.

FilesSearchArg

Type:
  • Object
Properties:
Name Type Description
path string The path in the user's Dropbox to search. Should probably be a folder.
query string The string to search for. Query string may be rewritten to improve relevance of results. The string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. "bat c" matches "bat cave" but not "batman car").
start number The starting index within the search results (used for paging).
max_results number The maximum number of search results to return.
mode FilesSearchMode The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts.

FilesSearchError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
invalid_argument string <optional>
 Available if .tag is invalid_argument.
.tag 'path' | 'invalid_argument' | 'internal_error' | 'other' Tag identifying the union variant.

FilesSearchMatch

Type:
  • Object
Properties:
Name Type Description
match_type FilesSearchMatchType The type of the match.
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata The metadata for the matched file or folder.

FilesSearchMatchFieldOptions

Type:
  • Object
Properties:
Name Type Description
include_highlights boolean Whether to include highlight span from file title.

FilesSearchMatchType

Indicates what type of match was found for a given item.
Type:
  • Object
Properties:
Name Type Description
.tag 'filename' | 'content' | 'both' Tag identifying the union variant.

FilesSearchMatchTypeV2

Indicates what type of match was found for a given item.
Type:
  • Object
Properties:
Name Type Description
.tag 'filename' | 'file_content' | 'filename_and_content' | 'image_content' | 'other' Tag identifying the union variant.

FilesSearchMatchV2

Type:
  • Object
Properties:
Name Type Argument Description
metadata FilesMetadataV2 The metadata for the matched file or folder.
match_type FilesSearchMatchTypeV2 <optional>
 The type of the match.
highlight_spans Array.<FilesHighlightSpan> <optional>
 The list of HighlightSpan determines which parts of the file title should be highlighted.

FilesSearchMode

Type:
  • Object
Properties:
Name Type Description
.tag 'filename' | 'filename_and_content' | 'deleted_filename' Tag identifying the union variant.

FilesSearchOptions

Type:
  • Object
Properties:
Name Type Argument Description
path string <optional>
 Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified.
max_results number The maximum number of search results to return.
order_by FilesSearchOrderBy <optional>
 Specified property of the order of search results. By default, results are sorted by relevance.
file_status FilesFileStatus Restricts search to the given file status.
filename_only boolean Restricts search to only match on filenames.
file_extensions Array.<string> <optional>
 Restricts search to only the extensions specified. Only supported for active file search.
file_categories Array.<FilesFileCategory> <optional>
 Restricts search to only the file categories specified. Only supported for active file search.
account_id string <optional>
 Restricts results to the given account id.

FilesSearchOrderBy

Type:
  • Object
Properties:
Name Type Description
.tag 'relevance' | 'last_modified_time' | 'other' Tag identifying the union variant.

FilesSearchResult

Type:
  • Object
Properties:
Name Type Description
matches Array.<FilesSearchMatch> A list (possibly empty) of matches for the query.
more boolean Used for paging. If true, indicates there is another page of results available that can be fetched by calling search again.
start number Used for paging. Value to set the start argument to when calling search to fetch the next page of results.

FilesSearchV2Arg

Type:
  • Object
Properties:
Name Type Argument Description
query string The string to search for. May match across multiple fields based on the request arguments.
options FilesSearchOptions <optional>
 Options for more targeted search results.
match_field_options FilesSearchMatchFieldOptions <optional>
 Options for search results match fields.
include_highlights boolean <optional>
 Deprecated and moved this option to SearchMatchFieldOptions.

FilesSearchV2ContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by your last call to search:2. Used to fetch the next page of results.

FilesSearchV2Result

Type:
  • Object
Properties:
Name Type Argument Description
matches Array.<FilesSearchMatchV2> A list (possibly empty) of matches for the query.
has_more boolean Used for paging. If true, indicates there is another page of results available that can be fetched by calling search/continue:2 with the cursor.
cursor string <optional>
 Pass the cursor into search/continue:2 to fetch the next page of results.
Type:
  • Object
Properties:
Name Type Argument Description
url string Shared link url.
password string <optional>
 Password for the shared link.

FilesSharedLinkFileInfo

Type:
  • Object
Properties:
Name Type Argument Description
url string The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for.
path string <optional>
 The path corresponding to a file in a shared link to a folder. Required for shared links to folders.
password string <optional>
 Password for the shared link. Required for password-protected shared links to files unless it can be read from a cookie.

FilesSharingInfo

Sharing info for a file or folder.
Type:
  • Object
Properties:
Name Type Description
read_only boolean True if the file or folder is inside a read-only shared folder.

FilesSingleUserLock

Type:
  • Object
Properties:
Name Type Argument Description
created Timestamp The time the lock was created.
lock_holder_account_id string The account ID of the lock holder if known.
lock_holder_team_id string <optional>
 The id of the team of the account holder if it exists.

FilesSymlinkInfo

Type:
  • Object
Properties:
Name Type Description
target string The target this symlink points to.

FilesSyncSetting

Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'not_synced' | 'not_synced_inactive' | 'other' Tag identifying the union variant.

FilesSyncSettingArg

Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'not_synced' | 'other' Tag identifying the union variant.

FilesSyncSettingsError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'unsupported_combination' | 'unsupported_configuration' | 'other' Tag identifying the union variant.

FilesTag

Tag that can be added in multiple ways.
Type:
  • Object
Properties:
Name Type Argument Description
user_generated_tag FilesUserGeneratedTag <optional>
 Available if .tag is user_generated_tag. Tag generated by the user.
.tag 'user_generated_tag' | 'other' Tag identifying the union variant.

FilesThumbnailArg

Type:
  • Object
Properties:
Name Type Description
path string The path to the image file you want to thumbnail.
format FilesThumbnailFormat The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts.
size FilesThumbnailSize The size for the thumbnail image.
mode FilesThumbnailMode How to resize and crop the image to achieve the desired size.

FilesThumbnailError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path. An error occurs when downloading metadata for the image.
.tag 'path' | 'unsupported_extension' | 'unsupported_image' | 'conversion_error' Tag identifying the union variant.

FilesThumbnailFormat

Type:
  • Object
Properties:
Name Type Description
.tag 'jpeg' | 'png' Tag identifying the union variant.

FilesThumbnailMode

Type:
  • Object
Properties:
Name Type Description
.tag 'strict' | 'bestfit' | 'fitone_bestfit' Tag identifying the union variant.

FilesThumbnailSize

Type:
  • Object
Properties:
Name Type Description
.tag 'w32h32' | 'w64h64' | 'w128h128' | 'w256h256' | 'w480h320' | 'w640h480' | 'w960h640' | 'w1024h768' | 'w2048h1536' Tag identifying the union variant.

FilesThumbnailV2Arg

Type:
  • Object
Properties:
Name Type Description
resource FilesPathOrLink Information specifying which file to preview. This could be a path to a file, a shared link pointing to a file, or a shared link pointing to a folder, with a relative path.
format FilesThumbnailFormat The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts.
size FilesThumbnailSize The size for the thumbnail image.
mode FilesThumbnailMode How to resize and crop the image to achieve the desired size.

FilesThumbnailV2Error

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path. An error occurred when downloading metadata for the image.
.tag 'path' | 'unsupported_extension' | 'unsupported_image' | 'conversion_error' | 'access_denied' | 'not_found' | 'other' Tag identifying the union variant.

FilesUnlockFileArg

Type:
  • Object
Properties:
Name Type Description
path string Path in the user's Dropbox to a file.

FilesUnlockFileBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesUnlockFileArg> List of 'entries'. Each 'entry' contains a path of the file which will be unlocked. Duplicate path arguments in the batch are considered only once.

FilesUploadArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
path string Path in the user's Dropbox to save the file.
mode FilesWriteMode Selects what to do if the file already exists.
autorename boolean If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
client_modified Timestamp <optional>
 The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
mute boolean Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification.
property_groups Array.<FilePropertiesPropertyGroup> <optional>
 List of custom properties to add to file.
strict_conflict boolean Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.
content_hash string <optional>
 A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

FilesUploadError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesUploadWriteFailed <optional>
 Available if .tag is path. Unable to save the uploaded contents to a file.
properties_error FilePropertiesInvalidPropertyGroupError <optional>
 Available if .tag is properties_error. The supplied property group is invalid. The file has uploaded without property groups.
.tag 'path' | 'properties_error' | 'payload_too_large' | 'content_hash_mismatch' | 'other' Tag identifying the union variant.

FilesUploadSessionAppendArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
cursor FilesUploadSessionCursor Contains the upload session ID and the offset.
close boolean If true, the current session will be closed, at which point you won't be able to call upload_session/append:2 anymore with the current session.
content_hash string <optional>
 A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

FilesUploadSessionAppendError

Type:
  • Object
Properties:
Name Type Argument Description
incorrect_offset FilesUploadSessionOffsetError <optional>
 Available if .tag is incorrect_offset. The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error.
.tag 'not_found' | 'incorrect_offset' | 'closed' | 'not_closed' | 'too_large' | 'concurrent_session_invalid_offset' | 'concurrent_session_invalid_data_size' | 'payload_too_large' | 'other' | 'content_hash_mismatch' Tag identifying the union variant.

FilesUploadSessionCursor

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
session_id string The upload session ID (returned by upload_session/start).
offset number Offset in bytes at which data should be appended. We use this to make sure upload data isn't lost or duplicated in the event of a network error.

FilesUploadSessionFinishArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
cursor FilesUploadSessionCursor Contains the upload session ID and the offset.
commit FilesCommitInfo Contains the path and other optional modifiers for the commit.
content_hash string <optional>
 A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

FilesUploadSessionFinishBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesUploadSessionFinishArg> Commit information for each file in the batch.

FilesUploadSessionFinishBatchJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete FilesUploadSessionFinishBatchResult <optional>
 Available if .tag is complete. The :route:`upload_session/finish_batch` has finished.
.tag 'in_progress' | 'complete' Tag identifying the union variant.

FilesUploadSessionFinishBatchLaunch

Result returned by upload_session/finish_batch that may either launch an asynchronous job or complete synchronously.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
complete FilesUploadSessionFinishBatchResult <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' | 'other' Tag identifying the union variant.

FilesUploadSessionFinishBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesUploadSessionFinishBatchResultEntry> Each entry in UploadSessionFinishBatchArg.entries will appear at the same position inside UploadSessionFinishBatchResult.entries.

FilesUploadSessionFinishBatchResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesFileMetadata <optional>
 Available if .tag is success.
failure FilesUploadSessionFinishError <optional>
 Available if .tag is failure.
.tag 'success' | 'failure' Tag identifying the union variant.

FilesUploadSessionFinishError

Type:
  • Object
Properties:
Name Type Argument Description
lookup_failed FilesUploadSessionLookupError <optional>
 Available if .tag is lookup_failed. The session arguments are incorrect; the value explains the reason.
path FilesWriteError <optional>
 Available if .tag is path. Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset.
properties_error FilePropertiesInvalidPropertyGroupError <optional>
 Available if .tag is properties_error. The supplied property group is invalid. The file has uploaded without property groups.
.tag 'lookup_failed' | 'path' | 'properties_error' | 'too_many_shared_folder_targets' | 'too_many_write_operations' | 'concurrent_session_data_not_allowed' | 'concurrent_session_not_closed' | 'concurrent_session_missing_data' | 'payload_too_large' | 'content_hash_mismatch' | 'other' Tag identifying the union variant.

FilesUploadSessionLookupError

Type:
  • Object
Properties:
Name Type Argument Description
incorrect_offset FilesUploadSessionOffsetError <optional>
 Available if .tag is incorrect_offset. The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error.
.tag 'not_found' | 'incorrect_offset' | 'closed' | 'not_closed' | 'too_large' | 'concurrent_session_invalid_offset' | 'concurrent_session_invalid_data_size' | 'payload_too_large' | 'other' Tag identifying the union variant.

FilesUploadSessionOffsetError

Type:
  • Object
Properties:
Name Type Description
correct_offset number The offset up to which data has been collected.

FilesUploadSessionStartArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
close boolean If true, the current session will be closed, at which point you won't be able to call upload_session/append:2 anymore with the current session.
session_type FilesUploadSessionType <optional>
 Type of upload session you want to start. If not specified, default is UploadSessionType.sequential.
content_hash string <optional>
 A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

FilesUploadSessionStartBatchArg

Type:
  • Object
Properties:
Name Type Argument Description
num_sessions number The number of upload sessions to start.
session_type FilesUploadSessionType <optional>
 Type of upload session you want to start. If not specified, default is UploadSessionType.sequential.

FilesUploadSessionStartBatchResult

Type:
  • Object
Properties:
Name Type Description
session_ids Array.<string> A List of unique identifiers for the upload session. Pass each session_id to upload_session/append:2 and upload_session/finish.

FilesUploadSessionStartError

Type:
  • Object
Properties:
Name Type Description
.tag 'concurrent_session_data_not_allowed' | 'concurrent_session_close_not_allowed' | 'payload_too_large' | 'content_hash_mismatch' | 'other' Tag identifying the union variant.

FilesUploadSessionStartResult

Type:
  • Object
Properties:
Name Type Description
session_id string A unique identifier for the upload session. Pass this to upload_session/append:2 and upload_session/finish.

FilesUploadSessionType

Type:
  • Object
Properties:
Name Type Description
.tag 'sequential' | 'concurrent' | 'other' Tag identifying the union variant.

FilesUploadWriteFailed

Type:
  • Object
Properties:
Name Type Description
reason FilesWriteError The reason why the file couldn't be saved.
upload_session_id string The upload session ID; data has already been uploaded to the corresponding upload session and this ID may be used to retry the commit with upload_session/finish.

FilesUserGeneratedTag

Type:
  • Object
Properties:
Name Type Description
tag_text string

FilesVideoMetadata

Metadata for a video.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'video' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
dimensions FilesDimensions <optional>
 Dimension of the photo/video.
location FilesGpsCoordinates <optional>
 The GPS coordinate of the photo/video.
time_taken Timestamp <optional>
 The timestamp when the photo/video is taken.
duration number <optional>
 The duration of the video in milliseconds.

FilesWriteConflictError

Type:
  • Object
Properties:
Name Type Description
.tag 'file' | 'folder' | 'file_ancestor' | 'other' Tag identifying the union variant.

FilesWriteError

Type:
  • Object
Properties:
Name Type Argument Description
malformed_path string <optional>
 Available if .tag is malformed_path. The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information.
conflict FilesWriteConflictError <optional>
 Available if .tag is conflict. Couldn't write to the target path because there was something in the way.
.tag 'malformed_path' | 'conflict' | 'no_write_permission' | 'insufficient_space' | 'disallowed_name' | 'team_folder' | 'operation_suppressed' | 'too_many_write_operations' | 'other' Tag identifying the union variant.

FilesWriteMode

Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is. In some situations, the conflict behavior is identical: (a) If the target path doesn't refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it's always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict. The conflict checking differs in the case where there's a file at the target path with contents different from the contents you're trying to write.
Type:
  • Object
Properties:
Name Type Argument Description
update string <optional>
 Available if .tag is update. Overwrite if the given "rev" matches the existing file's "rev". The supplied value should be the latest known "rev" of the file, for example, from :type:`FileMetadata`, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given "rev" matches the existing file's current "rev" on the Dropbox servers. The autorename strategy is to append the string "conflicted copy" to the file name. For example, "document.txt" might become "document (conflicted copy).txt" or "document (Panda's conflicted copy).txt".
.tag 'add' | 'overwrite' | 'update' Tag identifying the union variant.

OpenidOpenIdError

Type:
  • Object
Properties:
Name Type Description
.tag 'incorrect_openid_scopes' | 'other' Tag identifying the union variant.

OpenidUserInfoArgs

No Parameters
Type:
  • Object

OpenidUserInfoError

Type:
  • Object
Properties:
Name Type Argument Description
openid_error OpenidOpenIdError <optional>
 Available if .tag is openid_error.
.tag 'openid_error' | 'other' Tag identifying the union variant.

OpenidUserInfoResult

Type:
  • Object
Properties:
Name Type Argument Description
family_name string <optional>
 Last name of user.
given_name string <optional>
 First name of user.
email string <optional>
 Email address of user.
email_verified boolean <optional>
 If user is email verified.
iss string Issuer of token (in this case Dropbox).
sub string An identifier for the user. This is the Dropbox account_id, a string value such as dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc.

PaperAddMember

Type:
  • Object
Properties:
Name Type Description
member SharingMemberSelector User which should be added to the Paper doc. Specify only email address or Dropbox account ID.
permission_level PaperPaperDocPermissionLevel Permission for the user.

PaperAddPaperDocUser

Type:
  • Object
Properties:
Name Type Argument Description
doc_id string The Paper doc ID.
members Array.<PaperAddMember> User which should be added to the Paper doc. Specify only email address or Dropbox account ID.
custom_message string <optional>
 A personal message that will be emailed to each successfully added member.
quiet boolean Clients should set this to true if no email message shall be sent to added users.

PaperAddPaperDocUserMemberResult

Per-member result for docs/users/add.
Type:
  • Object
Properties:
Name Type Description
member SharingMemberSelector One of specified input members.
result PaperAddPaperDocUserResult The outcome of the action on this member.

PaperAddPaperDocUserResult

Type:
  • Object
Properties:
Name Type Description
.tag 'success' | 'unknown_error' | 'sharing_outside_team_disabled' | 'daily_limit_reached' | 'user_is_owner' | 'failed_user_data_retrieval' | 'permission_already_granted' | 'other' Tag identifying the union variant.

PaperCursor

Type:
  • Object
Properties:
Name Type Argument Description
value string The actual cursor value.
expiration Timestamp <optional>
 Expiration time of value. Some cursors might have expiration time assigned. This is a UTC value after which the cursor is no longer valid and the API starts returning an error. If cursor expires a new one needs to be obtained and pagination needs to be restarted. Some cursors might be short-lived some cursors might be long-lived. This really depends on the sorting type and order, e.g.: 1. on one hand, listing docs created by the user, sorted by the created time ascending will have undefinite expiration because the results cannot change while the iteration is happening. This cursor would be suitable for long term polling. 2. on the other hand, listing docs sorted by the last modified time will have a very short expiration as docs do get modified very often and the modified time can be changed while the iteration is happening thus altering the results.

PaperDocLookupError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'other' | 'doc_not_found' Tag identifying the union variant.

PaperDocSubscriptionLevel

The subscription level of a Paper doc.
Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'ignore' | 'every' | 'no_email' Tag identifying the union variant.

PaperExportFormat

The desired export format of the Paper doc.
Type:
  • Object
Properties:
Name Type Description
.tag 'html' | 'markdown' | 'other' Tag identifying the union variant.

PaperFolder

Data structure representing a Paper folder.
Type:
  • Object
Properties:
Name Type Description
id string Paper folder ID. This ID uniquely identifies the folder.
name string Paper folder name.

PaperFoldersContainingPaperDoc

Metadata about Paper folders containing the specififed Paper doc.
Type:
  • Object
Properties:
Name Type Argument Description
folder_sharing_policy_type PaperFolderSharingPolicyType <optional>
 The sharing policy of the folder containing the Paper doc.
folders Array.<PaperFolder> <optional>
 The folder path. If present the first folder is the root folder.

PaperFolderSharingPolicyType

The sharing policy of a Paper folder. The sharing policy of subfolders is inherited from the root folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'team' | 'invite_only' Tag identifying the union variant.

PaperFolderSubscriptionLevel

The subscription level of a Paper folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'none' | 'activity_only' | 'daily_emails' | 'weekly_emails' Tag identifying the union variant.

PaperImportFormat

The import format of the incoming data.
Type:
  • Object
Properties:
Name Type Description
.tag 'html' | 'markdown' | 'plain_text' | 'other' Tag identifying the union variant.

PaperInviteeInfoWithPermissionLevel

Type:
  • Object
Properties:
Name Type Description
invitee SharingInviteeInfo Email address invited to the Paper doc.
permission_level PaperPaperDocPermissionLevel Permission level for the invitee.

PaperListDocsCursorError

Type:
  • Object
Properties:
Name Type Argument Description
cursor_error PaperPaperApiCursorError <optional>
 Available if .tag is cursor_error.
.tag 'cursor_error' | 'other' Tag identifying the union variant.

PaperListPaperDocsArgs

Type:
  • Object
Properties:
Name Type Description
filter_by PaperListPaperDocsFilterBy Allows user to specify how the Paper docs should be filtered.
sort_by PaperListPaperDocsSortBy Allows user to specify how the Paper docs should be sorted.
sort_order PaperListPaperDocsSortOrder Allows user to specify the sort order of the result.
limit number Size limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error.

PaperListPaperDocsContinueArgs

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor obtained from docs/list or docs/list/continue. Allows for pagination.

PaperListPaperDocsFilterBy

Type:
  • Object
Properties:
Name Type Description
.tag 'docs_accessed' | 'docs_created' | 'other' Tag identifying the union variant.

PaperListPaperDocsResponse

Type:
  • Object
Properties:
Name Type Description
doc_ids Array.<Object> The list of Paper doc IDs that can be used to access the given Paper docs or supplied to other API methods. The list is sorted in the order specified by the initial call to docs/list.
cursor PaperCursor Pass the cursor into docs/list/continue to paginate through all files. The cursor preserves all properties as specified in the original call to docs/list.
has_more boolean Will be set to True if a subsequent call with the provided cursor to docs/list/continue returns immediately with some results. If set to False please allow some delay before making another call to docs/list/continue.

PaperListPaperDocsSortBy

Type:
  • Object
Properties:
Name Type Description
.tag 'accessed' | 'modified' | 'created' | 'other' Tag identifying the union variant.

PaperListPaperDocsSortOrder

Type:
  • Object
Properties:
Name Type Description
.tag 'ascending' | 'descending' | 'other' Tag identifying the union variant.

PaperListUsersCursorError

Type:
  • Object
Properties:
Name Type Argument Description
cursor_error PaperPaperApiCursorError <optional>
 Available if .tag is cursor_error.
.tag 'insufficient_permissions' | 'other' | 'doc_not_found' | 'cursor_error' Tag identifying the union variant.

PaperListUsersOnFolderArgs

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
limit number Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.

PaperListUsersOnFolderContinueArgs

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
cursor string The cursor obtained from docs/folder_users/list or docs/folder_users/list/continue. Allows for pagination.

PaperListUsersOnFolderResponse

Type:
  • Object
Properties:
Name Type Description
invitees Array.<SharingInviteeInfo> List of email addresses that are invited on the Paper folder.
users Array.<SharingUserInfo> List of users that are invited on the Paper folder.
cursor PaperCursor Pass the cursor into docs/folder_users/list/continue to paginate through all users. The cursor preserves all properties as specified in the original call to docs/folder_users/list.
has_more boolean Will be set to True if a subsequent call with the provided cursor to docs/folder_users/list/continue returns immediately with some results. If set to False please allow some delay before making another call to docs/folder_users/list/continue.

PaperListUsersOnPaperDocArgs

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
limit number Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.
filter_by PaperUserOnPaperDocFilter Specify this attribute if you want to obtain users that have already accessed the Paper doc.

PaperListUsersOnPaperDocContinueArgs

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
cursor string The cursor obtained from docs/users/list or docs/users/list/continue. Allows for pagination.

PaperListUsersOnPaperDocResponse

Type:
  • Object
Properties:
Name Type Description
invitees Array.<PaperInviteeInfoWithPermissionLevel> List of email addresses with their respective permission levels that are invited on the Paper doc.
users Array.<PaperUserInfoWithPermissionLevel> List of users with their respective permission levels that are invited on the Paper folder.
doc_owner SharingUserInfo The Paper doc owner. This field is populated on every single response.
cursor PaperCursor Pass the cursor into docs/users/list/continue to paginate through all users. The cursor preserves all properties as specified in the original call to docs/users/list.
has_more boolean Will be set to True if a subsequent call with the provided cursor to docs/users/list/continue returns immediately with some results. If set to False please allow some delay before making another call to docs/users/list/continue.

PaperPaperApiBaseError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'other' Tag identifying the union variant.

PaperPaperApiCursorError

Type:
  • Object
Properties:
Name Type Description
.tag 'expired_cursor' | 'invalid_cursor' | 'wrong_user_in_cursor' | 'reset' | 'other' Tag identifying the union variant.

PaperPaperDocCreateArgs

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
import_format PaperImportFormat The format of provided data.
parent_folder_id string <optional>
 The Paper folder ID where the Paper document should be created. The API user has to have write access to this folder or error is thrown.

PaperPaperDocCreateError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'other' | 'content_malformed' | 'folder_not_found' | 'doc_length_exceeded' | 'image_size_exceeded' Tag identifying the union variant.

PaperPaperDocCreateUpdateResult

Type:
  • Object
Properties:
Name Type Description
doc_id string Doc ID of the newly created doc.
revision number The Paper doc revision. Simply an ever increasing number.
title string The Paper doc title.

PaperPaperDocExport

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
export_format PaperExportFormat

PaperPaperDocExportResult

Type:
  • Object
Properties:
Name Type Description
owner string The Paper doc owner's email address.
title string The Paper doc title.
revision number The Paper doc revision. Simply an ever increasing number.
mime_type string MIME type of the export. This corresponds to ExportFormat specified in the request.

PaperPaperDocPermissionLevel

Type:
  • Object
Properties:
Name Type Description
.tag 'edit' | 'view_and_comment' | 'other' Tag identifying the union variant.

PaperPaperDocSharingPolicy

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
sharing_policy PaperSharingPolicy The default sharing policy to be set for the Paper doc.

PaperPaperDocUpdateArgs

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
doc_id string The Paper doc ID.
doc_update_policy PaperPaperDocUpdatePolicy The policy used for the current update call.
revision number The latest doc revision. This value must match the head revision or an error code will be returned. This is to prevent colliding writes.
import_format PaperImportFormat The format of provided data.

PaperPaperDocUpdateError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'other' | 'doc_not_found' | 'content_malformed' | 'revision_mismatch' | 'doc_length_exceeded' | 'image_size_exceeded' | 'doc_archived' | 'doc_deleted' Tag identifying the union variant.

PaperPaperDocUpdatePolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'append' | 'prepend' | 'overwrite_all' | 'other' Tag identifying the union variant.

PaperPaperFolderCreateArg

Type:
  • Object
Properties:
Name Type Argument Description
name string The name of the new Paper folder.
parent_folder_id string <optional>
 The encrypted Paper folder Id where the new Paper folder should be created. The API user has to have write access to this folder or error is thrown. If not supplied, the new folder will be created at top level.
is_team_folder boolean <optional>
 Whether the folder to be created should be a team folder. This value will be ignored if parent_folder_id is supplied, as the new folder will inherit the type (private or team folder) from its parent. We will by default create a top-level private folder if both parent_folder_id and is_team_folder are not supplied.

PaperPaperFolderCreateError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'other' | 'folder_not_found' | 'invalid_folder_id' Tag identifying the union variant.

PaperPaperFolderCreateResult

Type:
  • Object
Properties:
Name Type Description
folder_id string Folder ID of the newly created folder.

PaperRefPaperDoc

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.

PaperRemovePaperDocUser

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
member SharingMemberSelector User which should be removed from the Paper doc. Specify only email address or Dropbox account ID.

PaperSharingPolicy

Sharing policy of Paper doc.
Type:
  • Object
Properties:
Name Type Argument Description
public_sharing_policy PaperSharingPublicPolicyType <optional>
 This value applies to the non-team members.
team_sharing_policy PaperSharingTeamPolicyType <optional>
 This value applies to the team members only. The value is null for all personal accounts.

PaperSharingPublicPolicyType

Type:
  • Object
Properties:
Name Type Description
.tag 'people_with_link_can_edit' | 'people_with_link_can_view_and_comment' | 'invite_only' | 'disabled' Tag identifying the union variant.

PaperSharingTeamPolicyType

The sharing policy type of the Paper doc.
Type:
  • Object
Properties:
Name Type Description
.tag 'people_with_link_can_edit' | 'people_with_link_can_view_and_comment' | 'invite_only' Tag identifying the union variant.

PaperUserInfoWithPermissionLevel

Type:
  • Object
Properties:
Name Type Description
user SharingUserInfo User shared on the Paper doc.
permission_level PaperPaperDocPermissionLevel Permission level for the user.

PaperUserOnPaperDocFilter

Type:
  • Object
Properties:
Name Type Description
.tag 'visited' | 'shared' | 'other' Tag identifying the union variant.

SecondaryEmailsSecondaryEmail

Type:
  • Object
Properties:
Name Type Description
email string Secondary email address.
is_verified boolean Whether or not the secondary email address is verified to be owned by a user.

SeenStatePlatformType

Possible platforms on which a user may view content.
Type:
  • Object
Properties:
Name Type Description
.tag 'web' | 'desktop' | 'mobile_ios' | 'mobile_android' | 'api' | 'unknown' | 'mobile' | 'other' Tag identifying the union variant.

SharingAccessInheritance

Information about the inheritance policy of a shared folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'inherit' | 'no_inherit' | 'other' Tag identifying the union variant.

SharingAccessLevel

Defines the access levels for collaborators.
Type:
  • Object
Properties:
Name Type Description
.tag 'owner' | 'editor' | 'viewer' | 'viewer_no_comment' | 'traverse' | 'other' Tag identifying the union variant.

SharingAclUpdatePolicy

Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.
Type:
  • Object
Properties:
Name Type Description
.tag 'owner' | 'editors' | 'other' Tag identifying the union variant.

SharingAddFileMemberArgs

Arguments for add_file_member.
Type:
  • Object
Properties:
Name Type Argument Description
file string File to which to add members.
members Array.<SharingMemberSelector> Members to add. Note that even an email address is given, this may result in a user being directly added to the membership if that email is the user's main account email.
custom_message string <optional>
 Message to send to added members in their invitation.
quiet boolean Whether added members should be notified via email and device notifications of their invitation.
access_level SharingAccessLevel AccessLevel union object, describing what access level we want to give new members.
add_message_as_comment boolean If the custom message should be added as a comment on the file.

SharingAddFileMemberError

Errors for add_file_member.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'user_error' | 'access_error' | 'rate_limit' | 'invalid_comment' | 'other' Tag identifying the union variant.

SharingAddFolderMemberArg

Type:
  • Object
Properties:
Name Type Argument Description
shared_folder_id string The ID for the shared folder.
members Array.<SharingAddMember> The intended list of members to add. Added members will receive invites to join the shared folder.
quiet boolean Whether added members should be notified via email and device notifications of their invite.
custom_message string <optional>
 Optional message to display to added members in their invitation.

SharingAddFolderMemberError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error. Unable to access shared folder.
bad_member SharingAddMemberSelectorError <optional>
 Available if .tag is bad_member. :field:`AddFolderMemberArg.members` contains a bad invitation recipient.
too_many_members number <optional>
 Available if .tag is too_many_members. The value is the member limit that was reached.
too_many_pending_invites number <optional>
 Available if .tag is too_many_pending_invites. The value is the pending invite limit that was reached.
.tag 'access_error' | 'email_unverified' | 'banned_member' | 'bad_member' | 'cant_share_outside_team' | 'too_many_members' | 'too_many_pending_invites' | 'rate_limit' | 'too_many_invitees' | 'insufficient_plan' | 'team_folder' | 'no_permission' | 'invalid_shared_folder' | 'other' Tag identifying the union variant.

SharingAddMember

The member and type of access the member should have when added to a shared folder.
Type:
  • Object
Properties:
Name Type Description
member SharingMemberSelector The member to add to the shared folder.
access_level SharingAccessLevel The access level to grant member to the shared folder. AccessLevel.owner is disallowed.

SharingAddMemberSelectorError

Type:
  • Object
Properties:
Name Type Argument Description
invalid_dropbox_id string <optional>
 Available if .tag is invalid_dropbox_id. The value is the ID that could not be identified.
invalid_email string <optional>
 Available if .tag is invalid_email. The value is the e-email address that is malformed.
unverified_dropbox_id string <optional>
 Available if .tag is unverified_dropbox_id. The value is the ID of the Dropbox user with an unverified email address. Invite unverified users by email address instead of by their Dropbox ID.
.tag 'automatic_group' | 'invalid_dropbox_id' | 'invalid_email' | 'unverified_dropbox_id' | 'group_deleted' | 'group_not_on_team' | 'other' Tag identifying the union variant.

SharingAlphaResolvedVisibility

check documentation for ResolvedVisibility.
Type:
  • Object
Properties:
Name Type Description
.tag 'public' | 'team_only' | 'password' | 'team_and_password' | 'shared_folder_only' | 'no_one' | 'only_you' | 'other' Tag identifying the union variant.

SharingAudienceExceptionContentInfo

Information about the content that has a link audience different than that of this folder.
Type:
  • Object
Properties:
Name Type Description
name string The name of the content, which is either a file or a folder.

SharingAudienceExceptions

The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.
Type:
  • Object
Properties:
Name Type Description
count number
exceptions Array.<SharingAudienceExceptionContentInfo> A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.

SharingAudienceRestrictingSharedFolder

Information about the shared folder that prevents the link audience for this link from being more restrictive.
Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID of the shared folder.
name string The name of the shared folder.
audience SharingLinkAudience The link audience of the shared folder.

SharingCollectionLinkMetadata

Metadata for a collection-based shared link.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'collection' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
url string URL of the shared link.
visibility SharingVisibility Who can access the link.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.

SharingCreateSharedLinkArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path to share.
short_url boolean
pending_upload SharingPendingUploadMode <optional>
 If it's okay to share a path that does not yet exist, set this to either PendingUploadMode.file or PendingUploadMode.folder to indicate whether to assume it's a file or folder.

SharingCreateSharedLinkError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

SharingCreateSharedLinkWithSettingsArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path to be shared by the shared link.
settings SharingSharedLinkSettings <optional>
 The requested settings for the newly created shared link.

SharingCreateSharedLinkWithSettingsError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
shared_link_already_exists SharingSharedLinkAlreadyExistsMetadata <optional>
 Available if .tag is shared_link_already_exists. The shared link already exists. You can call :route:`list_shared_links` to get the existing link, or use the provided metadata if it is returned.
settings_error SharingSharedLinkSettingsError <optional>
 Available if .tag is settings_error. There is an error with the given settings.
.tag 'path' | 'email_not_verified' | 'shared_link_already_exists' | 'settings_error' | 'access_denied' Tag identifying the union variant.

SharingExpectedSharedContentLinkMetadata

The expected metadata of a shared link for a file or folder when a link is first created for the content. Absent if the link already exists.
Type:
  • Object
Properties:
Name Type Argument Description
audience_options Array.<SharingLinkAudience> The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.
current_audience SharingLinkAudience The current audience of the link.
link_permissions Array.<SharingLinkPermission> A list of permissions for actions you can perform on the link.
password_protected boolean Whether the link is protected by a password.
access_level SharingAccessLevel <optional>
 The access level on the link for this file.
audience_restricting_shared_folder SharingAudienceRestrictingSharedFolder <optional>
 The shared folder that prevents the link audience for this link from being more restrictive.
expiry Timestamp <optional>
 Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached.

SharingFileAction

Sharing actions that may be taken on files.
Type:
  • Object
Properties:
Name Type Description
.tag 'disable_viewer_info' | 'edit_contents' | 'enable_viewer_info' | 'invite_viewer' | 'invite_viewer_no_comment' | 'invite_editor' | 'unshare' | 'relinquish_membership' | 'share_link' | 'create_link' | 'create_view_link' | 'create_edit_link' | 'other' Tag identifying the union variant.

SharingFileErrorResult

Type:
  • Object
Properties:
Name Type Argument Description
file_not_found_error string <optional>
 Available if .tag is file_not_found_error. File specified by id was not found.
invalid_file_action_error string <optional>
 Available if .tag is invalid_file_action_error. User does not have permission to take the specified action on the file.
permission_denied_error string <optional>
 Available if .tag is permission_denied_error. User does not have permission to access file specified by file.Id.
.tag 'file_not_found_error' | 'invalid_file_action_error' | 'permission_denied_error' | 'other' Tag identifying the union variant.

SharingFileLinkMetadata

The metadata of a file shared link.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'file' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
url string URL of the shared link.
name string The linked file name (including extension). This never contains a slash.
link_permissions SharingLinkPermissions The link's access permissions.
client_modified Timestamp The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not.
server_modified Timestamp The last time the file was modified on Dropbox.
rev string A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.
size number The file size in bytes.
id string <optional>
 A unique identifier for the linked file.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox.
team_member_info SharingTeamMemberInfo <optional>
 The team membership information of the link's owner. This field will only be present if the link's owner is a team member.
content_owner_team_info UsersTeam <optional>
 The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team.

SharingFileMemberActionError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error. Specified file was invalid or user does not have access.
no_explicit_access SharingMemberAccessLevelResult <optional>
 Available if .tag is no_explicit_access. The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.
.tag 'invalid_member' | 'no_permission' | 'access_error' | 'no_explicit_access' | 'other' Tag identifying the union variant.

SharingFileMemberActionIndividualResult

Type:
  • Object
Properties:
Name Type Argument Description
success SharingAccessLevel <optional>
 Available if .tag is success. Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder.
member_error SharingFileMemberActionError <optional>
 Available if .tag is member_error. User was not able to perform this action.
.tag 'success' | 'member_error' Tag identifying the union variant.

SharingFileMemberActionResult

Per-member result for add_file_member.
Type:
  • Object
Properties:
Name Type Argument Description
member SharingMemberSelector One of specified input members.
result SharingFileMemberActionIndividualResult The outcome of the action on this member.
sckey_sha1 string <optional>
 The SHA-1 encrypted shared content key.
invitation_signature Array.<string> <optional>
 The sharing sender-recipient invitation signatures for the input member_id. A member_id can be a group and thus have multiple users and multiple invitation signatures.

SharingFileMemberRemoveActionResult

Type:
  • Object
Properties:
Name Type Argument Description
success SharingMemberAccessLevelResult <optional>
 Available if .tag is success. Member was successfully removed from this file.
member_error SharingFileMemberActionError <optional>
 Available if .tag is member_error. User was not able to remove this member.
.tag 'success' | 'member_error' | 'other' Tag identifying the union variant.

SharingFilePermission

Whether the user is allowed to take the sharing action on the file.
Type:
  • Object
Properties:
Name Type Argument Description
action SharingFileAction The action that the user may wish to take on the file.
allow boolean True if the user is allowed to take the action.
reason SharingPermissionDeniedReason <optional>
 The reason why the user is denied the permission. Not present if the action is allowed.

SharingFolderAction

Actions that may be taken on shared folders.
Type:
  • Object
Properties:
Name Type Description
.tag 'change_options' | 'disable_viewer_info' | 'edit_contents' | 'enable_viewer_info' | 'invite_editor' | 'invite_viewer' | 'invite_viewer_no_comment' | 'relinquish_membership' | 'unmount' | 'unshare' | 'leave_a_copy' | 'share_link' | 'create_link' | 'set_access_inheritance' | 'other' Tag identifying the union variant.

SharingFolderLinkMetadata

The metadata of a folder shared link.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'folder' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
url string URL of the shared link.
name string The linked file name (including extension). This never contains a slash.
link_permissions SharingLinkPermissions The link's access permissions.
id string <optional>
 A unique identifier for the linked file.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox.
team_member_info SharingTeamMemberInfo <optional>
 The team membership information of the link's owner. This field will only be present if the link's owner is a team member.
content_owner_team_info UsersTeam <optional>
 The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team.

SharingFolderPermission

Whether the user is allowed to take the action on the shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
action SharingFolderAction The action that the user may wish to take on the folder.
allow boolean True if the user is allowed to take the action.
reason SharingPermissionDeniedReason <optional>
 The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available.

SharingFolderPolicy

A set of policies governing membership and privileges for a shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
acl_update_policy SharingAclUpdatePolicy Who can add and remove members from this shared folder.
shared_link_policy SharingSharedLinkPolicy Who links can be shared with.
member_policy SharingMemberPolicy <optional>
 Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team.
resolved_member_policy SharingMemberPolicy <optional>
 Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team.
viewer_info_policy SharingViewerInfoPolicy <optional>
 Who can enable/disable viewer info for this shared folder.

SharingGetFileMetadataArg

Arguments of get_file_metadata.
Type:
  • Object
Properties:
Name Type Argument Description
file string The file to query.
actions Array.<SharingFileAction> <optional>
 A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

SharingGetFileMetadataBatchArg

Arguments of get_file_metadata/batch.
Type:
  • Object
Properties:
Name Type Argument Description
files Array.<Object> The files to query.
actions Array.<SharingFileAction> <optional>
 A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

SharingGetFileMetadataBatchResult

Per file results of get_file_metadata/batch.
Type:
  • Object
Properties:
Name Type Description
file string This is the input file identifier corresponding to one of GetFileMetadataBatchArg.files.
result SharingGetFileMetadataIndividualResult The result for this particular file.

SharingGetFileMetadataError

Error result for get_file_metadata.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'user_error' | 'access_error' | 'other' Tag identifying the union variant.

SharingGetFileMetadataIndividualResult

Type:
  • Object
Properties:
Name Type Argument Description
metadata SharingSharedFileMetadata <optional>
 Available if .tag is metadata. The result for this file if it was successful.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error. The result for this file if it was an error.
.tag 'metadata' | 'access_error' | 'other' Tag identifying the union variant.

SharingGetMetadataArgs

Type:
  • Object
Properties:
Name Type Argument Description
shared_folder_id string The ID for the shared folder.
actions Array.<SharingFolderAction> <optional>
 A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.

SharingGetSharedLinkFileError

Type:
  • Object
Properties:
Name Type Description
.tag 'shared_link_not_found' | 'shared_link_access_denied' | 'unsupported_link_type' | 'other' | 'shared_link_is_directory' Tag identifying the union variant.

SharingGetSharedLinkMetadataArg

Type:
  • Object
Properties:
Name Type Argument Description
url string URL of the shared link.
path string <optional>
 If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.
link_password string <optional>
 If the shared link has a password, this parameter can be used.

SharingGetSharedLinksArg

Type:
  • Object
Properties:
Name Type Argument Description
path string <optional>
 See get_shared_links description.

SharingGetSharedLinksError

Type:
  • Object
Properties:
Name Type Argument Description
path string <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

SharingGetSharedLinksResult

Type:
  • Object
Properties:
Name Type Description
links Array.<(SharingPathLinkMetadata|SharingCollectionLinkMetadata|SharingLinkMetadata)> Shared links applicable to the path argument.

SharingGroupInfo

The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
group_name string
group_id string
group_management_type TeamCommonGroupManagementType Who is allowed to manage the group.
group_type TeamCommonGroupType The type of group.
is_member boolean If the current user is a member of the group.
is_owner boolean If the current user is an owner of the group.
same_team boolean If the group is owned by the current user's team.
group_external_id string <optional>
 External ID of group. This is an arbitrary ID that an admin can attach to a group.
member_count number <optional>
 The number of members in the group.

SharingGroupMembershipInfo

The information about a group member of the shared content.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.
group SharingGroupInfo The information about the membership group.
permissions Array.<SharingMemberPermission> <optional>
 The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.
initials string <optional>
 Never set.
is_inherited boolean True if the member has access from a parent folder.

SharingInsufficientPlan

Type:
  • Object
Properties:
Name Type Argument Description
message string A message to tell the user to upgrade in order to support expected action.
upsell_url string <optional>
 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.

SharingInsufficientQuotaAmounts

Type:
  • Object
Properties:
Name Type Description
space_needed number The amount of space needed to add the item (the size of the item).
space_shortage number The amount of extra space needed to add the item.
space_left number The amount of space left in the user's Dropbox, less than space_needed.

SharingInviteeInfo

Information about the recipient of a shared content invitation.
Type:
  • Object
Properties:
Name Type Argument Description
email string <optional>
 Available if .tag is email. Email address of invited user.
.tag 'email' | 'other' Tag identifying the union variant.

SharingInviteeMembershipInfo

Information about an invited member of a shared content.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.
invitee SharingInviteeInfo Recipient of the invitation.
permissions Array.<SharingMemberPermission> <optional>
 The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.
initials string <optional>
 Never set.
is_inherited boolean True if the member has access from a parent folder.
user SharingUserInfo <optional>
 The user this invitation is tied to, if available.

SharingJobError

Error occurred while performing an asynchronous job from unshare_folder or remove_folder_member.
Type:
  • Object
Properties:
Name Type Argument Description
unshare_folder_error SharingUnshareFolderError <optional>
 Available if .tag is unshare_folder_error. Error occurred while performing :route:`unshare_folder` action.
remove_folder_member_error SharingRemoveFolderMemberError <optional>
 Available if .tag is remove_folder_member_error. Error occurred while performing :route:`remove_folder_member` action.
relinquish_folder_membership_error SharingRelinquishFolderMembershipError <optional>
 Available if .tag is relinquish_folder_membership_error. Error occurred while performing :route:`relinquish_folder_membership` action.
.tag 'unshare_folder_error' | 'remove_folder_member_error' | 'relinquish_folder_membership_error' | 'other' Tag identifying the union variant.

SharingJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
failed SharingJobError <optional>
 Available if .tag is failed. The asynchronous job returned an error.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

SharingLinkAccessLevel

Type:
  • Object
Properties:
Name Type Description
.tag 'viewer' | 'editor' | 'other' Tag identifying the union variant.

SharingLinkAction

Actions that can be performed on a link.
Type:
  • Object
Properties:
Name Type Description
.tag 'change_access_level' | 'change_audience' | 'remove_expiry' | 'remove_password' | 'set_expiry' | 'set_password' | 'other' Tag identifying the union variant.

SharingLinkAudience

Type:
  • Object
Properties:
Name Type Description
.tag 'public' | 'team' | 'no_one' | 'password' | 'members' | 'other' Tag identifying the union variant.

SharingLinkAudienceDisallowedReason

check documentation for VisibilityPolicyDisallowedReason.
Type:
  • Object
Properties:
Name Type Description
.tag 'delete_and_recreate' | 'restricted_by_shared_folder' | 'restricted_by_team' | 'user_not_on_team' | 'user_account_type' | 'permission_denied' | 'other' Tag identifying the union variant.

SharingLinkAudienceOption

Type:
  • Object
Properties:
Name Type Argument Description
audience SharingLinkAudience Specifies who can access the link.
allowed boolean Whether the user calling this API can select this audience option.
disallowed_reason SharingLinkAudienceDisallowedReason <optional>
 If allowed is false, this will provide the reason that the user is not permitted to set the visibility to this policy.

SharingLinkExpiry

Type:
  • Object
Properties:
Name Type Argument Description
set_expiry Timestamp <optional>
 Available if .tag is set_expiry. Set a new expiry or change an existing expiry.
.tag 'remove_expiry' | 'set_expiry' | 'other' Tag identifying the union variant.

SharingLinkMetadata

Metadata for a shared link. This can be either a PathLinkMetadata or CollectionLinkMetadata.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "path" | "collection" Tag identifying the subtype variant.
url string URL of the shared link.
visibility SharingVisibility Who can access the link.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.

SharingLinkPassword

Type:
  • Object
Properties:
Name Type Argument Description
set_password string <optional>
 Available if .tag is set_password. Set a new password or change an existing password.
.tag 'remove_password' | 'set_password' | 'other' Tag identifying the union variant.

SharingLinkPermission

Permissions for actions that can be performed on a link.
Type:
  • Object
Properties:
Name Type Argument Description
action SharingLinkAction
allow boolean
reason SharingPermissionDeniedReason <optional>

SharingLinkPermissions

Type:
  • Object
Properties:
Name Type Argument Description
can_revoke boolean Whether the caller can revoke the shared link.
visibility_policies Array.<SharingVisibilityPolicy> A list of policies that the user might be able to set for the visibility.
can_set_expiry boolean Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry.
can_remove_expiry boolean Whether the user can remove the expiry of the link.
allow_download boolean Whether the link can be downloaded or not.
can_allow_download boolean Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link.
can_disallow_download boolean Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link.
allow_comments boolean Whether comments are enabled for the linked file. This takes the team commenting policy into account.
team_restricts_comments boolean Whether the team has disabled commenting globally.
resolved_visibility SharingResolvedVisibility <optional>
 The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead.
requested_visibility SharingRequestedVisibility <optional>
 The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in resolved_visibility. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience.
revoke_failure_reason SharingSharedLinkAccessFailureReason <optional>
 The failure reason for revoking the link. This field will only be present if the can_revoke is false.
effective_audience SharingLinkAudience <optional>
 The type of audience who can benefit from the access level specified by the `link_access_level` field.
link_access_level SharingLinkAccessLevel <optional>
 The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content.
audience_options Array.<SharingLinkAudienceOption> <optional>
 A list of link audience options the user might be able to set as the new audience.
can_set_password boolean <optional>
 Whether the user can set a password for the link.
can_remove_password boolean <optional>
 Whether the user can remove the password of the link.
require_password boolean <optional>
 Whether the user is required to provide a password to view the link.
can_use_extended_sharing_controls boolean <optional>
 Whether the user can use extended sharing controls, based on their account type.

SharingLinkSettings

Settings that apply to a link.
Type:
  • Object
Properties:
Name Type Argument Description
access_level SharingAccessLevel <optional>
 The access level on the link for this file. Currently, it only accepts 'viewer' and 'viewer_no_comment'.
audience SharingLinkAudience <optional>
 The type of audience on the link for this file.
expiry SharingLinkExpiry <optional>
 An expiry timestamp to set on a link.
password SharingLinkPassword <optional>
 The password for the link.

SharingListFileMembersArg

Arguments for list_file_members.
Type:
  • Object
Properties:
Name Type Argument Description
file string The file for which you want to see members.
actions Array.<SharingMemberAction> <optional>
 The actions for which to return permissions on a member.
include_inherited boolean Whether to include members who only have access from a parent shared folder.
limit number Number of members to return max per query. Defaults to 100 if no limit is specified.

SharingListFileMembersBatchArg

Arguments for list_file_members/batch.
Type:
  • Object
Properties:
Name Type Description
files Array.<Object> Files for which to return members.
limit number Number of members to return max per query. Defaults to 10 if no limit is specified.

SharingListFileMembersBatchResult

Per-file result for list_file_members/batch.
Type:
  • Object
Properties:
Name Type Description
file string This is the input file identifier, whether an ID or a path.
result SharingListFileMembersIndividualResult The result for this particular file.

SharingListFileMembersContinueArg

Arguments for list_file_members/continue.
Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by your last call to list_file_members, list_file_members/continue, or list_file_members/batch.

SharingListFileMembersContinueError

Error for list_file_members/continue.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'user_error' | 'access_error' | 'invalid_cursor' | 'other' Tag identifying the union variant.

SharingListFileMembersCountResult

Type:
  • Object
Properties:
Name Type Description
members SharingSharedFileMembers A list of members on this file.
member_count number The number of members on this file. This does not include inherited members.

SharingListFileMembersError

Error for list_file_members.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'user_error' | 'access_error' | 'other' Tag identifying the union variant.

SharingListFileMembersIndividualResult

Type:
  • Object
Properties:
Name Type Argument Description
result SharingListFileMembersCountResult <optional>
 Available if .tag is result. The results of the query for this file if it was successful.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error. The result of the query for this file if it was an error.
.tag 'result' | 'access_error' | 'other' Tag identifying the union variant.

SharingListFilesArg

Arguments for list_received_files.
Type:
  • Object
Properties:
Name Type Argument Description
limit number Number of files to return max per query. Defaults to 100 if no limit is specified.
actions Array.<SharingFileAction> <optional>
 A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

SharingListFilesContinueArg

Arguments for list_received_files/continue.
Type:
  • Object
Properties:
Name Type Description
cursor string Cursor in ListFilesResult.cursor.

SharingListFilesContinueError

Error results for list_received_files/continue.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error. User account had a problem.
.tag 'user_error' | 'invalid_cursor' | 'other' Tag identifying the union variant.

SharingListFilesResult

Success results for list_received_files.
Type:
  • Object
Properties:
Name Type Argument Description
entries Array.<SharingSharedFileMetadata> Information about the files shared with current user.
cursor string <optional>
 Cursor used to obtain additional shared files.

SharingListFolderMembersArgs

Type:
  • Object
Properties:
Name Type Argument Description
shared_folder_id string The ID for the shared folder.
actions Array.<SharingMemberAction> <optional>
 This is a list indicating whether each returned member will include a boolean value MemberPermission.allow that describes whether the current user can perform the MemberAction on the member.
limit number The maximum number of results that include members, groups and invitees to return per request.

SharingListFolderMembersContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by your last call to list_folder_members or list_folder_members/continue.

SharingListFolderMembersContinueError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
.tag 'access_error' | 'invalid_cursor' | 'other' Tag identifying the union variant.

SharingListFolderMembersCursorArg

Type:
  • Object
Properties:
Name Type Argument Description
actions Array.<SharingMemberAction> <optional>
 This is a list indicating whether each returned member will include a boolean value MemberPermission.allow that describes whether the current user can perform the MemberAction on the member.
limit number The maximum number of results that include members, groups and invitees to return per request.

SharingListFoldersArgs

Type:
  • Object
Properties:
Name Type Argument Description
limit number The maximum number of results to return per request.
actions Array.<SharingFolderAction> <optional>
 A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.

SharingListFoldersContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by the previous API call specified in the endpoint description.

SharingListFoldersContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_cursor' | 'other' Tag identifying the union variant.

SharingListFoldersResult

Result for list_folders or list_mountable_folders, depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of SharedFolderMetadata.path_lower.
Type:
  • Object
Properties:
Name Type Argument Description
entries Array.<SharingSharedFolderMetadata> List of all shared folders the authenticated user has access to.
cursor string <optional>
 Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either list_folders/continue or list_mountable_folders/continue) to list additional folders.

SharingListSharedLinksArg

Type:
  • Object
Properties:
Name Type Argument Description
path string <optional>
 See list_shared_links description.
cursor string <optional>
 The cursor returned by your last call to list_shared_links.
direct_only boolean <optional>
 See list_shared_links description.

SharingListSharedLinksError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'reset' | 'other' Tag identifying the union variant.

SharingListSharedLinksResult

Type:
  • Object
Properties:
Name Type Argument Description
links Array.<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)> Shared links applicable to the path argument.
has_more boolean Is true if there are additional shared links that have not been returned yet. Pass the cursor into list_shared_links to retrieve them.
cursor string <optional>
 Pass the cursor into list_shared_links to obtain the additional links. Cursor is returned only if no path is given.

SharingMemberAccessLevelResult

Contains information about a member's access level to content after an operation.
Type:
  • Object
Properties:
Name Type Argument Description
access_level SharingAccessLevel <optional>
 The member still has this level of access to the content through a parent folder.
warning string <optional>
 A localized string with additional information about why the user has this access level to the content.
access_details Array.<SharingParentFolderAccessInfo> <optional>
 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.

SharingMemberAction

Actions that may be taken on members of a shared folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'leave_a_copy' | 'make_editor' | 'make_owner' | 'make_viewer' | 'make_viewer_no_comment' | 'remove' | 'other' Tag identifying the union variant.

SharingMemberPermission

Whether the user is allowed to take the action on the associated member.
Type:
  • Object
Properties:
Name Type Argument Description
action SharingMemberAction The action that the user may wish to take on the member.
allow boolean True if the user is allowed to take the action.
reason SharingPermissionDeniedReason <optional>
 The reason why the user is denied the permission. Not present if the action is allowed.

SharingMemberPolicy

Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.
Type:
  • Object
Properties:
Name Type Description
.tag 'team' | 'anyone' | 'other' Tag identifying the union variant.

SharingMemberSelector

Includes different ways to identify a member of a shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
dropbox_id string <optional>
 Available if .tag is dropbox_id. Dropbox account, team member, or group ID of member.
email string <optional>
 Available if .tag is email. Email address of member.
.tag 'dropbox_id' | 'email' | 'other' Tag identifying the union variant.

SharingMembershipInfo

The information about a member of the shared content.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.
permissions Array.<SharingMemberPermission> <optional>
 The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.
initials string <optional>
 Never set.
is_inherited boolean True if the member has access from a parent folder.

SharingModifySharedLinkSettingsArgs

Type:
  • Object
Properties:
Name Type Description
url string URL of the shared link to change its settings.
settings SharingSharedLinkSettings Set of settings for the shared link.
remove_expiration boolean If set to true, removes the expiration of the shared link.

SharingModifySharedLinkSettingsError

Type:
  • Object
Properties:
Name Type Argument Description
settings_error SharingSharedLinkSettingsError <optional>
 Available if .tag is settings_error. There is an error with the given settings.
.tag 'shared_link_not_found' | 'shared_link_access_denied' | 'unsupported_link_type' | 'other' | 'settings_error' | 'email_not_verified' Tag identifying the union variant.

SharingMountFolderArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID of the shared folder to mount.

SharingMountFolderError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
insufficient_quota SharingInsufficientQuotaAmounts <optional>
 Available if .tag is insufficient_quota. The current user does not have enough space to mount the shared folder.
.tag 'access_error' | 'inside_shared_folder' | 'insufficient_quota' | 'already_mounted' | 'no_permission' | 'not_mountable' | 'other' Tag identifying the union variant.

SharingParentFolderAccessInfo

Contains information about a parent folder that a member has access to.
Type:
  • Object
Properties:
Name Type Description
folder_name string Display name for the folder.
shared_folder_id string The identifier of the parent shared folder.
permissions Array.<SharingMemberPermission> The user's permissions for the parent shared folder.
path string The full path to the parent shared folder relative to the acting user's root.

SharingPathLinkMetadata

Metadata for a path-based shared link.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'path' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
url string URL of the shared link.
visibility SharingVisibility Who can access the link.
path string Path in user's Dropbox.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.

SharingPendingUploadMode

Flag to indicate pending upload default (for linking to not-yet-existing paths).
Type:
  • Object
Properties:
Name Type Description
.tag 'file' | 'folder' Tag identifying the union variant.

SharingPermissionDeniedReason

Possible reasons the user is denied a permission.
Type:
  • Object
Properties:
Name Type Argument Description
insufficient_plan SharingInsufficientPlan <optional>
 Available if .tag is insufficient_plan.
.tag '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' Tag identifying the union variant.

SharingRelinquishFileMembershipArg

Type:
  • Object
Properties:
Name Type Description
file string The path or id for the file.

SharingRelinquishFileMembershipError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'access_error' | 'group_access' | 'no_permission' | 'other' Tag identifying the union variant.

SharingRelinquishFolderMembershipArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID for the shared folder.
leave_a_copy boolean Keep a copy of the folder's contents upon relinquishing membership. This must be set to false when the folder is within a team folder or another shared folder.

SharingRelinquishFolderMembershipError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
.tag 'access_error' | 'folder_owner' | 'mounted' | 'group_access' | 'team_folder' | 'no_permission' | 'no_explicit_access' | 'other' Tag identifying the union variant.

SharingRemoveFileMemberArg

Arguments for remove_file_member_2.
Type:
  • Object
Properties:
Name Type Description
file string File from which to remove members.
member SharingMemberSelector Member to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address.

SharingRemoveFileMemberError

Errors for remove_file_member_2.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
no_explicit_access SharingMemberAccessLevelResult <optional>
 Available if .tag is no_explicit_access. This member does not have explicit access to the file and therefore cannot be removed. The return value is the access that a user might have to the file from a parent folder.
.tag 'user_error' | 'access_error' | 'no_explicit_access' | 'other' Tag identifying the union variant.

SharingRemoveFolderMemberArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID for the shared folder.
member SharingMemberSelector The member to remove from the folder.
leave_a_copy boolean If true, the removed user will keep their copy of the folder after it's unshared, assuming it was mounted. Otherwise, it will be removed from their Dropbox. This must be set to false when removing a group, or when the folder is within a team folder or another shared folder.

SharingRemoveFolderMemberError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
member_error SharingSharedFolderMemberError <optional>
 Available if .tag is member_error.
.tag 'access_error' | 'member_error' | 'folder_owner' | 'group_access' | 'team_folder' | 'no_permission' | 'too_many_files' | 'other' Tag identifying the union variant.

SharingRemoveMemberJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete SharingMemberAccessLevelResult <optional>
 Available if .tag is complete. Removing the folder member has finished. The value is information about whether the member has another form of access.
failed SharingRemoveFolderMemberError <optional>
 Available if .tag is failed.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

SharingRequestedLinkAccessLevel

Type:
  • Object
Properties:
Name Type Description
.tag 'viewer' | 'editor' | 'max' | 'default' | 'other' Tag identifying the union variant.

SharingRequestedVisibility

The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the ResolvedVisibility for more info on the possible resolved visibility values of shared links.
Type:
  • Object
Properties:
Name Type Description
.tag 'public' | 'team_only' | 'password' Tag identifying the union variant.

SharingResolvedVisibility

The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the RequestedVisibility for more info on the possible visibility values that can be set by the shared link's owner.
Type:
  • Object
Properties:
Name Type Description
.tag 'public' | 'team_only' | 'password' | 'team_and_password' | 'shared_folder_only' | 'no_one' | 'only_you' | 'other' Tag identifying the union variant.

SharingRevokeSharedLinkArg

Type:
  • Object
Properties:
Name Type Description
url string URL of the shared link.

SharingRevokeSharedLinkError

Type:
  • Object
Properties:
Name Type Description
.tag 'shared_link_not_found' | 'shared_link_access_denied' | 'unsupported_link_type' | 'other' | 'shared_link_malformed' Tag identifying the union variant.

SharingSetAccessInheritanceArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID for the shared folder.
access_inheritance SharingAccessInheritance The access inheritance settings for the folder.

SharingSetAccessInheritanceError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error. Unable to access shared folder.
.tag 'access_error' | 'no_permission' | 'other' Tag identifying the union variant.

SharingSharedContentLinkMetadata

Metadata of a shared link for a file or folder.
Type:
  • Object
Properties:
Name Type Argument Description
audience_options Array.<SharingLinkAudience> The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.
current_audience SharingLinkAudience The current audience of the link.
link_permissions Array.<SharingLinkPermission> A list of permissions for actions you can perform on the link.
password_protected boolean Whether the link is protected by a password.
url string The URL of the link.
access_level SharingAccessLevel <optional>
 The access level on the link for this file.
audience_restricting_shared_folder SharingAudienceRestrictingSharedFolder <optional>
 The shared folder that prevents the link audience for this link from being more restrictive.
expiry Timestamp <optional>
 Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached.
audience_exceptions SharingAudienceExceptions <optional>
 The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata.

SharingSharedContentLinkMetadataBase

Type:
  • Object
Properties:
Name Type Argument Description
audience_options Array.<SharingLinkAudience> The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.
current_audience SharingLinkAudience The current audience of the link.
link_permissions Array.<SharingLinkPermission> A list of permissions for actions you can perform on the link.
password_protected boolean Whether the link is protected by a password.
access_level SharingAccessLevel <optional>
 The access level on the link for this file.
audience_restricting_shared_folder SharingAudienceRestrictingSharedFolder <optional>
 The shared folder that prevents the link audience for this link from being more restrictive.
expiry Timestamp <optional>
 Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached.

SharingSharedFileMembers

Shared file user, group, and invitee membership. Used for the results of list_file_members and list_file_members/continue, and used as part of the results for list_file_members/batch.
Type:
  • Object
Properties:
Name Type Argument Description
users Array.<SharingUserFileMembershipInfo> The list of user members of the shared file.
groups Array.<SharingGroupMembershipInfo> The list of group members of the shared file.
invitees Array.<SharingInviteeMembershipInfo> The list of invited members of a file, but have not logged in and claimed this.
cursor string <optional>
 Present if there are additional shared file members that have not been returned yet. Pass the cursor into list_file_members/continue to list additional members.

SharingSharedFileMetadata

Properties of the shared file.
Type:
  • Object
Properties:
Name Type Argument Description
id string The ID of the file.
name string The name of this file.
policy SharingFolderPolicy Policies governing this shared file.
preview_url string URL for displaying a web preview of the shared file.
access_type SharingAccessLevel <optional>
 The current user's access level for this shared file.
expected_link_metadata SharingExpectedSharedContentLinkMetadata <optional>
 - The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet.
link_metadata SharingSharedContentLinkMetadata <optional>
 The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet.
owner_display_names Array.<string> <optional>
 The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.
owner_team UsersTeam <optional>
 The team that owns the file. This field is not present if the file is not owned by a team.
parent_shared_folder_id string <optional>
 The ID of the parent shared folder. This field is present only if the file is contained within a shared folder.
path_display string <optional>
 The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files.
path_lower string <optional>
 The lower-case full path of this file. Absent for unmounted files.
permissions Array.<SharingFilePermission> <optional>
 The sharing permissions that requesting user has on this file. This corresponds to the entries given in GetFileMetadataBatchArg.actions or GetFileMetadataArg.actions.
time_invited Timestamp <optional>
 Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

SharingSharedFolderAccessError

There is an error accessing the shared folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_id' | 'not_a_member' | 'email_unverified' | 'unmounted' | 'other' Tag identifying the union variant.

SharingSharedFolderMemberError

Type:
  • Object
Properties:
Name Type Argument Description
no_explicit_access SharingMemberAccessLevelResult <optional>
 Available if .tag is no_explicit_access. The target member only has inherited access to the shared folder.
.tag 'invalid_dropbox_id' | 'not_a_member' | 'no_explicit_access' | 'other' Tag identifying the union variant.

SharingSharedFolderMembers

Shared folder user and group membership.
Type:
  • Object
Properties:
Name Type Argument Description
users Array.<SharingUserMembershipInfo> The list of user members of the shared folder.
groups Array.<SharingGroupMembershipInfo> The list of group members of the shared folder.
invitees Array.<SharingInviteeMembershipInfo> The list of invitees to the shared folder.
cursor string <optional>
 Present if there are additional shared folder members that have not been returned yet. Pass the cursor into list_folder_members/continue to list additional members.

SharingSharedFolderMetadata

The metadata which includes basic information about the shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The current user's access level for this shared folder.
is_inside_team_folder boolean Whether this folder is inside of a team folder.
is_team_folder boolean Whether this folder is a team folder https://www.dropbox.com/en/help/986.
name string The name of the this shared folder.
policy SharingFolderPolicy Policies governing this shared folder.
preview_url string URL for displaying a web preview of the shared folder.
shared_folder_id string The ID of the shared folder.
time_invited Timestamp Timestamp indicating when the current user was invited to this shared folder.
owner_display_names Array.<string> <optional>
 The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.
owner_team UsersTeam <optional>
 The team that owns the folder. This field is not present if the folder is not owned by a team.
parent_shared_folder_id string <optional>
 The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.
path_lower string <optional>
 The lower-cased full path of this shared folder. Absent for unmounted folders.
parent_folder_name string <optional>
 Display name for the parent folder.
link_metadata SharingSharedContentLinkMetadata <optional>
 The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet.
permissions Array.<SharingFolderPermission> <optional>
 Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request.
access_inheritance SharingAccessInheritance Whether the folder inherits its members from its parent.

SharingSharedFolderMetadataBase

Properties of the shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The current user's access level for this shared folder.
is_inside_team_folder boolean Whether this folder is inside of a team folder.
is_team_folder boolean Whether this folder is a team folder https://www.dropbox.com/en/help/986.
owner_display_names Array.<string> <optional>
 The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.
owner_team UsersTeam <optional>
 The team that owns the folder. This field is not present if the folder is not owned by a team.
parent_shared_folder_id string <optional>
 The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.
path_lower string <optional>
 The lower-cased full path of this shared folder. Absent for unmounted folders.
parent_folder_name string <optional>
 Display name for the parent folder.

SharingSharedLinkAccessFailureReason

Type:
  • Object
Properties:
Name Type Description
.tag 'login_required' | 'email_verify_required' | 'password_required' | 'team_only' | 'owner_only' | 'other' Tag identifying the union variant.

SharingSharedLinkAlreadyExistsMetadata

Type:
  • Object
Properties:
Name Type Argument Description
metadata SharingFileLinkMetadata | SharingFolderLinkMetadata | SharingSharedLinkMetadata <optional>
 Available if .tag is metadata. Metadata of the shared link that already exists.
.tag 'metadata' | 'other' Tag identifying the union variant.

SharingSharedLinkError

Type:
  • Object
Properties:
Name Type Description
.tag 'shared_link_not_found' | 'shared_link_access_denied' | 'unsupported_link_type' | 'other' Tag identifying the union variant.

SharingSharedLinkMetadata

The metadata of a shared link.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "file" | "folder" Tag identifying the subtype variant.
url string URL of the shared link.
name string The linked file name (including extension). This never contains a slash.
link_permissions SharingLinkPermissions The link's access permissions.
id string <optional>
 A unique identifier for the linked file.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox.
team_member_info SharingTeamMemberInfo <optional>
 The team membership information of the link's owner. This field will only be present if the link's owner is a team member.
content_owner_team_info UsersTeam <optional>
 The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team.

SharingSharedLinkPolicy

Who can view shared links in this folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'anyone' | 'team' | 'members' | 'other' Tag identifying the union variant.

SharingSharedLinkSettings

Type:
  • Object
Properties:
Name Type Argument Description
require_password boolean <optional>
 Boolean flag to enable or disable password protection.
link_password string <optional>
 If require_password is true, this is needed to specify the password to access the link.
expires Timestamp <optional>
 Expiration time of the shared link. By default the link won't expire.
audience SharingLinkAudience <optional>
 The new audience who can benefit from the access level specified by the link's access level specified in the `link_access_level` field of `LinkPermissions`. This is used in conjunction with team policies and shared folder policies to determine the final effective audience type in the `effective_audience` field of `LinkPermissions.
access SharingRequestedLinkAccessLevel <optional>
 Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.
requested_visibility SharingRequestedVisibility <optional>
 Use audience instead. The requested access for this shared link.
allow_download boolean <optional>
 Boolean flag to allow or not download capabilities for shared links.

SharingSharedLinkSettingsError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_settings' | 'not_authorized' Tag identifying the union variant.

SharingShareFolderArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path to the folder to share. If it does not exist, then a new one is created.
acl_update_policy SharingAclUpdatePolicy <optional>
 Who can add and remove members of this shared folder.
force_async boolean Whether to force the share to happen asynchronously.
member_policy SharingMemberPolicy <optional>
 Who can be a member of this shared folder. Only applicable if the current user is on a team.
shared_link_policy SharingSharedLinkPolicy <optional>
 The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members.
viewer_info_policy SharingViewerInfoPolicy <optional>
 Who can enable/disable viewer info for this shared folder.
access_inheritance SharingAccessInheritance The access inheritance settings for the folder.
actions Array.<SharingFolderAction> <optional>
 A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.
link_settings SharingLinkSettings <optional>
 Settings on the link for this folder.

SharingShareFolderArgBase

Type:
  • Object
Properties:
Name Type Argument Description
path string The path to the folder to share. If it does not exist, then a new one is created.
acl_update_policy SharingAclUpdatePolicy <optional>
 Who can add and remove members of this shared folder.
force_async boolean Whether to force the share to happen asynchronously.
member_policy SharingMemberPolicy <optional>
 Who can be a member of this shared folder. Only applicable if the current user is on a team.
shared_link_policy SharingSharedLinkPolicy <optional>
 The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members.
viewer_info_policy SharingViewerInfoPolicy <optional>
 Who can enable/disable viewer info for this shared folder.
access_inheritance SharingAccessInheritance The access inheritance settings for the folder.

SharingShareFolderError

Type:
  • Object
Properties:
Name Type Argument Description
bad_path SharingSharePathError <optional>
 Available if .tag is bad_path. :field:`ShareFolderArg.path` is invalid.
.tag 'email_unverified' | 'bad_path' | 'team_policy_disallows_member_policy' | 'disallowed_shared_link_policy' | 'other' | 'no_permission' Tag identifying the union variant.

SharingShareFolderErrorBase

Type:
  • Object
Properties:
Name Type Argument Description
bad_path SharingSharePathError <optional>
 Available if .tag is bad_path. :field:`ShareFolderArg.path` is invalid.
.tag 'email_unverified' | 'bad_path' | 'team_policy_disallows_member_policy' | 'disallowed_shared_link_policy' | 'other' Tag identifying the union variant.

SharingShareFolderJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete SharingSharedFolderMetadata <optional>
 Available if .tag is complete. The share job has finished. The value is the metadata for the folder.
failed SharingShareFolderError <optional>
 Available if .tag is failed.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

SharingShareFolderLaunch

Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
complete SharingSharedFolderMetadata <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' Tag identifying the union variant.

SharingSharePathError

Type:
  • Object
Properties:
Name Type Argument Description
already_shared SharingSharedFolderMetadata <optional>
 Available if .tag is already_shared. Folder is already shared. Contains metadata about the existing shared folder.
.tag 'is_file' | 'inside_shared_folder' | 'contains_shared_folder' | 'contains_app_folder' | 'contains_team_folder' | 'is_app_folder' | 'inside_app_folder' | 'is_public_folder' | 'inside_public_folder' | 'already_shared' | 'invalid_path' | 'is_osx_package' | 'inside_osx_package' | 'is_vault' | 'is_vault_locked' | 'is_family' | 'other' Tag identifying the union variant.

SharingSharingFileAccessError

User could not access this file.
Type:
  • Object
Properties:
Name Type Description
.tag 'no_permission' | 'invalid_file' | 'is_folder' | 'inside_public_folder' | 'inside_osx_package' | 'other' Tag identifying the union variant.

SharingSharingUserError

User account had a problem preventing this action.
Type:
  • Object
Properties:
Name Type Description
.tag 'email_unverified' | 'other' Tag identifying the union variant.

SharingTeamMemberInfo

Information about a team member.
Type:
  • Object
Properties:
Name Type Argument Description
team_info UsersTeam Information about the member's team.
display_name string The display name of the user.
member_id string <optional>
 ID of user as a member of a team. This field will only be present if the member is in the same team as current user.

SharingTransferFolderArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID for the shared folder.
to_dropbox_id string A account or team member ID to transfer ownership to.

SharingTransferFolderError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
.tag 'access_error' | 'invalid_dropbox_id' | 'new_owner_not_a_member' | 'new_owner_unmounted' | 'new_owner_email_unverified' | 'team_folder' | 'no_permission' | 'other' Tag identifying the union variant.

SharingUnmountFolderArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID for the shared folder.

SharingUnmountFolderError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
.tag 'access_error' | 'no_permission' | 'not_unmountable' | 'other' Tag identifying the union variant.

SharingUnshareFileArg

Arguments for unshare_file.
Type:
  • Object
Properties:
Name Type Description
file string The file to unshare.

SharingUnshareFileError

Error result for unshare_file.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'user_error' | 'access_error' | 'other' Tag identifying the union variant.

SharingUnshareFolderArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID for the shared folder.
leave_a_copy boolean If true, members of this shared folder will get a copy of this folder after it's unshared. Otherwise, it will be removed from their Dropbox. The current user, who is an owner, will always retain their copy.

SharingUnshareFolderError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
.tag 'access_error' | 'team_folder' | 'no_permission' | 'too_many_files' | 'other' Tag identifying the union variant.

SharingUpdateFileMemberArgs

Arguments for update_file_member.
Type:
  • Object
Properties:
Name Type Description
file string File for which we are changing a member's access.
member SharingMemberSelector The member whose access we are changing.
access_level SharingAccessLevel The new access level for the member.

SharingUpdateFolderMemberArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID for the shared folder.
member SharingMemberSelector The member of the shared folder to update. Only the MemberSelector.dropbox_id may be set at this time.
access_level SharingAccessLevel The new access level for member. AccessLevel.owner is disallowed.

SharingUpdateFolderMemberError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
member_error SharingSharedFolderMemberError <optional>
 Available if .tag is member_error.
no_explicit_access SharingAddFolderMemberError <optional>
 Available if .tag is no_explicit_access. If updating the access type required the member to be added to the shared folder and there was an error when adding the member.
.tag 'access_error' | 'member_error' | 'no_explicit_access' | 'insufficient_plan' | 'no_permission' | 'other' Tag identifying the union variant.

SharingUpdateFolderPolicyArg

If any of the policies are unset, then they retain their current setting.
Type:
  • Object
Properties:
Name Type Argument Description
shared_folder_id string The ID for the shared folder.
member_policy SharingMemberPolicy <optional>
 Who can be a member of this shared folder. Only applicable if the current user is on a team.
acl_update_policy SharingAclUpdatePolicy <optional>
 Who can add and remove members of this shared folder.
viewer_info_policy SharingViewerInfoPolicy <optional>
 Who can enable/disable viewer info for this shared folder.
shared_link_policy SharingSharedLinkPolicy <optional>
 The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members.
link_settings SharingLinkSettings <optional>
 Settings on the link for this folder.
actions Array.<SharingFolderAction> <optional>
 A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.

SharingUpdateFolderPolicyError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
.tag 'access_error' | 'not_on_team' | 'team_policy_disallows_member_policy' | 'disallowed_shared_link_policy' | 'no_permission' | 'team_folder' | 'other' Tag identifying the union variant.

SharingUserFileMembershipInfo

The information about a user member of the shared content with an appended last seen timestamp.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.
user SharingUserInfo The account information for the membership user.
permissions Array.<SharingMemberPermission> <optional>
 The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.
initials string <optional>
 Never set.
is_inherited boolean True if the member has access from a parent folder.
time_last_seen Timestamp <optional>
 The UTC timestamp of when the user has last seen the content. Only populated if the user has seen the content and the caller has a plan that includes viewer history.
platform_type SeenStatePlatformType <optional>
 The platform on which the user has last seen the content, or unknown.

SharingUserInfo

Basic information about a user. Use users.get_account and users.get_account_batch to obtain more detailed information.
Type:
  • Object
Properties:
Name Type Argument Description
account_id string The account ID of the user.
email string Email address of user.
display_name string The display name of the user.
same_team boolean If the user is in the same team as current user.
team_member_id string <optional>
 The team member ID of the shared folder member. Only present if same_team is true.

SharingUserMembershipInfo

The information about a user member of the shared content.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.
user SharingUserInfo The account information for the membership user.
permissions Array.<SharingMemberPermission> <optional>
 The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.
initials string <optional>
 Never set.
is_inherited boolean True if the member has access from a parent folder.

SharingViewerInfoPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'enabled' | 'disabled' | 'other' Tag identifying the union variant.

SharingVisibility

Who can access a shared link. The most open visibility is public. The default depends on many aspects, such as team and user preferences and shared folder settings.
Type:
  • Object
Properties:
Name Type Description
.tag 'public' | 'team_only' | 'password' | 'team_and_password' | 'shared_folder_only' | 'other' Tag identifying the union variant.

SharingVisibilityPolicy

Type:
  • Object
Properties:
Name Type Argument Description
policy SharingRequestedVisibility This is the value to submit when saving the visibility setting.
resolved_policy SharingAlphaResolvedVisibility This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided.
allowed boolean Whether the user is permitted to set the visibility to this policy.
disallowed_reason SharingVisibilityPolicyDisallowedReason <optional>
 If allowed is false, this will provide the reason that the user is not permitted to set the visibility to this policy.

SharingVisibilityPolicyDisallowedReason

Type:
  • Object
Properties:
Name Type Description
.tag 'delete_and_recreate' | 'restricted_by_shared_folder' | 'restricted_by_team' | 'user_not_on_team' | 'user_account_type' | 'permission_denied' | 'other' Tag identifying the union variant.

TeamActiveWebSession

Information on active web sessions.
Type:
  • Object
Properties:
Name Type Argument Description
session_id string The session id.
user_agent string Information on the hosting device.
os string Information on the hosting operating system.
browser string Information on the browser used for this web session.
ip_address string <optional>
 The IP address of the last activity from this session.
country string <optional>
 The country from which the last activity from this session was made.
created Timestamp <optional>
 The time this session was created.
updated Timestamp <optional>
 The time of the last activity from this session.
expires Timestamp <optional>
 The time this session expires.

TeamAddSecondaryEmailResult

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.
Type:
  • Object
Properties:
Name Type Argument Description
success SecondaryEmailsSecondaryEmail <optional>
 Available if .tag is success. Describes a secondary email that was successfully added to a user.
unavailable string <optional>
 Available if .tag is unavailable. Secondary email is not available to be claimed by the user.
already_pending string <optional>
 Available if .tag is already_pending. Secondary email is already a pending email for the user.
already_owned_by_user string <optional>
 Available if .tag is already_owned_by_user. Secondary email is already a verified email for the user.
reached_limit string <optional>
 Available if .tag is reached_limit. User already has the maximum number of secondary emails allowed.
transient_error string <optional>
 Available if .tag is transient_error. A transient error occurred. Please try again later.
too_many_updates string <optional>
 Available if .tag is too_many_updates. An error occurred due to conflicting updates. Please try again later.
unknown_error string <optional>
 Available if .tag is unknown_error. An unknown error occurred.
rate_limited string <optional>
 Available if .tag is rate_limited. Too many emails are being sent to this email address. Please try again later.
.tag 'success' | 'unavailable' | 'already_pending' | 'already_owned_by_user' | 'reached_limit' | 'transient_error' | 'too_many_updates' | 'unknown_error' | 'rate_limited' | 'other' Tag identifying the union variant.

TeamAddSecondaryEmailsArg

Type:
  • Object
Properties:
Name Type Description
new_secondary_emails Array.<TeamUserSecondaryEmailsArg> List of users and secondary emails to add.

TeamAddSecondaryEmailsError

Error returned when adding secondary emails fails.
Type:
  • Object
Properties:
Name Type Description
.tag 'secondary_emails_disabled' | 'too_many_emails' | 'other' Tag identifying the union variant.

TeamAddSecondaryEmailsResult

Type:
  • Object
Properties:
Name Type Description
results Array.<TeamUserAddResult> List of users and secondary email results.

TeamAdminTier

Describes which team-related admin permissions a user has.
Type:
  • Object
Properties:
Name Type Description
.tag 'team_admin' | 'user_management_admin' | 'support_admin' | 'member_only' Tag identifying the union variant.

TeamApiApp

Information on linked third party applications.
Type:
  • Object
Properties:
Name Type Argument Description
app_id string The application unique id.
app_name string The application name.
is_app_folder boolean Whether the linked application uses a dedicated folder.
publisher string <optional>
 The application publisher name.
publisher_url string <optional>
 The publisher's URL.
linked Timestamp <optional>
 The time this application was linked.

TeamBaseDfbReport

Base report structure.
Type:
  • Object
Properties:
Name Type Description
start_date string First date present in the results as 'YYYY-MM-DD' or None.

TeamBaseTeamFolderError

Base error that all errors for existing team folders should extend.
Type:
  • Object
Properties:
Name Type Argument Description
access_error TeamTeamFolderAccessError <optional>
 Available if .tag is access_error.
status_error TeamTeamFolderInvalidStatusError <optional>
 Available if .tag is status_error.
team_shared_dropbox_error TeamTeamFolderTeamSharedDropboxError <optional>
 - Available if .tag is team_shared_dropbox_error.
.tag 'access_error' | 'status_error' | 'team_shared_dropbox_error' | 'other' Tag identifying the union variant.

TeamCommonGroupManagementType

The group type determines how a group is managed.
Type:
  • Object
Properties:
Name Type Description
.tag 'user_managed' | 'company_managed' | 'system_managed' | 'other' Tag identifying the union variant.

TeamCommonGroupSummary

Information about a group.
Type:
  • Object
Properties:
Name Type Argument Description
group_name string
group_id string
group_management_type TeamCommonGroupManagementType Who is allowed to manage the group.
group_external_id string <optional>
 External ID of group. This is an arbitrary ID that an admin can attach to a group.
member_count number <optional>
 The number of members in the group.

TeamCommonGroupType

The group type determines how a group is created and managed.
Type:
  • Object
Properties:
Name Type Description
.tag 'team' | 'user_managed' | 'other' Tag identifying the union variant.

TeamCommonMemberSpaceLimitType

The type of the space limit imposed on a team member.
Type:
  • Object
Properties:
Name Type Description
.tag 'off' | 'alert_only' | 'stop_sync' | 'other' Tag identifying the union variant.

TeamCommonTimeRange

Time range.
Type:
  • Object
Properties:
Name Type Argument Description
start_time Timestamp <optional>
 Optional starting time (inclusive).
end_time Timestamp <optional>
 Optional ending time (exclusive).

TeamCustomQuotaError

Error returned when getting member custom quota.
Type:
  • Object
Properties:
Name Type Description
.tag 'too_many_users' | 'other' Tag identifying the union variant.

TeamCustomQuotaResult

User custom quota.
Type:
  • Object
Properties:
Name Type Argument Description
success TeamUserCustomQuotaResult <optional>
 Available if .tag is success. User's custom quota.
invalid_user TeamUserSelectorArg <optional>
 Available if .tag is invalid_user. Invalid user (not in team).
.tag 'success' | 'invalid_user' | 'other' Tag identifying the union variant.

TeamCustomQuotaUsersArg

Type:
  • Object
Properties:
Name Type Description
users Array.<TeamUserSelectorArg> List of users.

TeamDateRange

Input arguments that can be provided for most reports.
Type:
  • Object
Properties:
Name Type Argument Description
start_date Timestamp <optional>
 Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago.
end_date Timestamp <optional>
 Optional ending date (exclusive).

TeamDateRangeError

Errors that can originate from problems in input arguments to reports.
Type:
  • Object
Properties:
Name Type Description
.tag 'other' Tag identifying the union variant.

TeamDeleteSecondaryEmailResult

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.
Type:
  • Object
Properties:
Name Type Argument Description
success string <optional>
 Available if .tag is success. The secondary email was successfully deleted.
not_found string <optional>
 Available if .tag is not_found. The email address was not found for the user.
cannot_remove_primary string <optional>
 Available if .tag is cannot_remove_primary. The email address is the primary email address of the user, and cannot be removed.
.tag 'success' | 'not_found' | 'cannot_remove_primary' | 'other' Tag identifying the union variant.

TeamDeleteSecondaryEmailsArg

Type:
  • Object
Properties:
Name Type Description
emails_to_delete Array.<TeamUserSecondaryEmailsArg> List of users and their secondary emails to delete.

TeamDeleteSecondaryEmailsResult

Type:
  • Object
Properties:
Name Type Description
results Array.<TeamUserDeleteResult>

TeamDesktopClientSession

Information about linked Dropbox desktop client sessions.
Type:
  • Object
Properties:
Name Type Argument Description
session_id string The session id.
host_name string Name of the hosting desktop.
client_type TeamDesktopPlatform The Dropbox desktop client type.
client_version string The Dropbox client version.
platform string Information on the hosting platform.
is_delete_on_unlink_supported boolean Whether it's possible to delete all of the account files upon unlinking.
ip_address string <optional>
 The IP address of the last activity from this session.
country string <optional>
 The country from which the last activity from this session was made.
created Timestamp <optional>
 The time this session was created.
updated Timestamp <optional>
 The time of the last activity from this session.

TeamDesktopPlatform

Type:
  • Object
Properties:
Name Type Description
.tag 'windows' | 'mac' | 'linux' | 'other' Tag identifying the union variant.

TeamDevicesActive

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.
Type:
  • Object
Properties:
Name Type Description
windows Array.<Object> Array of number of linked windows (desktop) clients with activity.
macos Array.<Object> Array of number of linked mac (desktop) clients with activity.
linux Array.<Object> Array of number of linked linus (desktop) clients with activity.
ios Array.<Object> Array of number of linked ios devices with activity.
android Array.<Object> Array of number of linked android devices with activity.
other Array.<Object> Array of number of other linked devices (blackberry, windows phone, etc) with activity.
total Array.<Object> Array of total number of linked clients with activity.

TeamDeviceSession

Type:
  • Object
Properties:
Name Type Argument Description
session_id string The session id.
ip_address string <optional>
 The IP address of the last activity from this session.
country string <optional>
 The country from which the last activity from this session was made.
created Timestamp <optional>
 The time this session was created.
updated Timestamp <optional>
 The time of the last activity from this session.

TeamDeviceSessionArg

Type:
  • Object
Properties:
Name Type Description
session_id string The session id.
team_member_id string The unique id of the member owning the device.

TeamExcludedUsersListArg

Excluded users list argument.
Type:
  • Object
Properties:
Name Type Description
limit number Number of results to return per call.

TeamExcludedUsersListContinueArg

Excluded users list continue argument.
Type:
  • Object
Properties:
Name Type Description
cursor string Indicates from what point to get the next set of users.

TeamExcludedUsersListContinueError

Excluded users list continue error.
Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_cursor' | 'other' Tag identifying the union variant.

TeamExcludedUsersListError

Excluded users list error.
Type:
  • Object
Properties:
Name Type Description
.tag 'list_error' | 'other' Tag identifying the union variant.

TeamExcludedUsersListResult

Excluded users list result.
Type:
  • Object
Properties:
Name Type Argument Description
users Array.<TeamMemberProfile>
has_more boolean Is true if there are additional excluded users that have not been returned yet. An additional call to member_space_limits/excluded_users/list/continue can retrieve them.
cursor string <optional>
 Pass the cursor into member_space_limits/excluded_users/list/continue to obtain additional excluded users.

TeamExcludedUsersUpdateArg

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.
Type:
  • Object
Properties:
Name Type Argument Description
users Array.<TeamUserSelectorArg> <optional>
 List of users to be added/removed.

TeamExcludedUsersUpdateError

Excluded users update error.
Type:
  • Object
Properties:
Name Type Description
.tag 'users_not_in_team' | 'too_many_users' | 'other' Tag identifying the union variant.

TeamExcludedUsersUpdateResult

Excluded users update result.
Type:
  • Object
Properties:
Name Type Description
status TeamExcludedUsersUpdateStatus Update status.

TeamExcludedUsersUpdateStatus

Excluded users update operation status.
Type:
  • Object
Properties:
Name Type Description
.tag 'success' | 'other' Tag identifying the union variant.

TeamFeature

A set of features that a Dropbox Business account may support.
Type:
  • Object
Properties:
Name Type Description
.tag 'upload_api_rate_limit' | 'has_team_shared_dropbox' | 'has_team_file_events' | 'has_team_selective_sync' | 'other' Tag identifying the union variant.

TeamFeaturesGetValuesBatchArg

Type:
  • Object
Properties:
Name Type Description
features Array.<TeamFeature> A list of features in Feature. If the list is empty, this route will return FeaturesGetValuesBatchError.

TeamFeaturesGetValuesBatchError

Type:
  • Object
Properties:
Name Type Description
.tag 'empty_features_list' | 'other' Tag identifying the union variant.

TeamFeaturesGetValuesBatchResult

Type:
  • Object
Properties:
Name Type Description
values Array.<TeamFeatureValue>

TeamFeatureValue

The values correspond to entries in Feature. You may get different value according to your Dropbox Business plan.
Type:
  • Object
Properties:
Name Type Argument Description
upload_api_rate_limit TeamUploadApiRateLimitValue <optional>
 Available if .tag is upload_api_rate_limit.
has_team_shared_dropbox TeamHasTeamSharedDropboxValue <optional>
 Available if .tag is has_team_shared_dropbox.
has_team_file_events TeamHasTeamFileEventsValue <optional>
 Available if .tag is has_team_file_events.
has_team_selective_sync TeamHasTeamSelectiveSyncValue <optional>
 Available if .tag is has_team_selective_sync.
.tag 'upload_api_rate_limit' | 'has_team_shared_dropbox' | 'has_team_file_events' | 'has_team_selective_sync' | 'other' Tag identifying the union variant.

TeamGetActivityReport

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.
Type:
  • Object
Properties:
Name Type Description
start_date string First date present in the results as 'YYYY-MM-DD' or None.
adds Array.<Object> Array of total number of adds by team members.
edits Array.<Object> Array of number of edits by team members. If the same user edits the same file multiple times this is counted as a single edit.
deletes Array.<Object> Array of total number of deletes by team members.
active_users_28_day Array.<Object> Array of the number of users who have been active in the last 28 days.
active_users_7_day Array.<Object> Array of the number of users who have been active in the last week.
active_users_1_day Array.<Object> Array of the number of users who have been active in the last day.
active_shared_folders_28_day Array.<Object> Array of the number of shared folders with some activity in the last 28 days.
active_shared_folders_7_day Array.<Object> Array of the number of shared folders with some activity in the last week.
active_shared_folders_1_day Array.<Object> Array of the number of shared folders with some activity in the last day.
shared_links_created Array.<Object> Array of the number of shared links created.
shared_links_viewed_by_team Array.<Object> Array of the number of views by team users to shared links created by the team.
shared_links_viewed_by_outside_user Array.<Object> Array of the number of views by users outside of the team to shared links created by the team.
shared_links_viewed_by_not_logged_in Array.<Object> Array of the number of views by non-logged-in users to shared links created by the team.
shared_links_viewed_total Array.<Object> Array of the total number of views to shared links created by the team.

TeamGetDevicesReport

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.
Type:
  • Object
Properties:
Name Type Description
start_date string First date present in the results as 'YYYY-MM-DD' or None.
active_1_day TeamDevicesActive Report of the number of devices active in the last day.
active_7_day TeamDevicesActive Report of the number of devices active in the last 7 days.
active_28_day TeamDevicesActive Report of the number of devices active in the last 28 days.

TeamGetMembershipReport

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.
Type:
  • Object
Properties:
Name Type Description
start_date string First date present in the results as 'YYYY-MM-DD' or None.
team_size Array.<Object> Team size, for each day.
pending_invites Array.<Object> The number of pending invites to the team, for each day.
members_joined Array.<Object> The number of members that joined the team, for each day.
suspended_members Array.<Object> The number of suspended team members, for each day.
licenses Array.<Object> The total number of licenses the team has, for each day.

TeamGetStorageReport

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.
Type:
  • Object
Properties:
Name Type Description
start_date string First date present in the results as 'YYYY-MM-DD' or None.
total_usage Array.<Object> Sum of the shared, unshared, and datastore usages, for each day.
shared_usage Array.<Object> Array of the combined size (bytes) of team members' shared folders, for each day.
unshared_usage Array.<Object> Array of the combined size (bytes) of team members' root namespaces, for each day.
shared_folders Array.<Object> Array of the number of shared folders owned by team members, for each day.
member_storage_map Array.<Array.<TeamStorageBucket>> Array of storage summaries of team members' account sizes. Each storage summary is an array of key, value pairs, where each pair describes a storage bucket. The key indicates the upper bound of the bucket and the value is the number of users in that bucket. There is one such summary per day. If there is no data for a day, the storage summary will be empty.

TeamGroupAccessType

Role of a user in group.
Type:
  • Object
Properties:
Name Type Description
.tag 'member' | 'owner' Tag identifying the union variant.

TeamGroupCreateArg

Type:
  • Object
Properties:
Name Type Argument Description
group_name string Group name.
add_creator_as_owner boolean Automatically add the creator of the group.
group_external_id string <optional>
 The creator of a team can associate an arbitrary external ID to the group.
group_management_type TeamCommonGroupManagementType <optional>
 Whether the team can be managed by selected users, or only by team admins.

TeamGroupCreateError

Type:
  • Object
Properties:
Name Type Description
.tag 'group_name_already_used' | 'group_name_invalid' | 'external_id_already_in_use' | 'system_managed_group_disallowed' | 'other' Tag identifying the union variant.

TeamGroupDeleteError

Type:
  • Object
Properties:
Name Type Description
.tag 'group_not_found' | 'other' | 'system_managed_group_disallowed' | 'group_already_deleted' Tag identifying the union variant.

TeamGroupFullInfo

Full description of a group.
Type:
  • Object
Properties:
Name Type Argument Description
group_name string
group_id string
group_management_type TeamCommonGroupManagementType Who is allowed to manage the group.
created number The group creation time as a UTC timestamp in milliseconds since the Unix epoch.
group_external_id string <optional>
 External ID of group. This is an arbitrary ID that an admin can attach to a group.
member_count number <optional>
 The number of members in the group.
members Array.<TeamGroupMemberInfo> <optional>
 List of group members.

TeamGroupMemberInfo

Profile of group member, and role in group.
Type:
  • Object
Properties:
Name Type Description
profile TeamMemberProfile Profile of group member.
access_type TeamGroupAccessType The role that the user has in the group.

TeamGroupMembersAddArg

Type:
  • Object
Properties:
Name Type Description
group TeamGroupSelector Group to which users will be added.
members Array.<TeamMemberAccess> List of users to be added to the group.
return_members boolean 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.

TeamGroupMembersAddError

Type:
  • Object
Properties:
Name Type Argument Description
members_not_in_team Array.<string> <optional>
 Available if .tag is members_not_in_team. 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 :route:`members/add` endpoint.
users_not_found Array.<string> <optional>
 Available if .tag is users_not_found. These users were not found in Dropbox.
user_cannot_be_manager_of_company_managed_group Array.<string> <optional>
 - Available if .tag is user_cannot_be_manager_of_company_managed_group. A company-managed group cannot be managed by a user.
.tag 'group_not_found' | 'other' | 'system_managed_group_disallowed' | 'duplicate_user' | 'group_not_in_team' | 'members_not_in_team' | 'users_not_found' | 'user_must_be_active_to_be_owner' | 'user_cannot_be_manager_of_company_managed_group' Tag identifying the union variant.

TeamGroupMembersChangeResult

Result returned by groups/members/add and groups/members/remove.
Type:
  • Object
Properties:
Name Type Description
group_info TeamGroupFullInfo The group info after member change operation has been performed.
async_job_id string For legacy purposes async_job_id will always return one space ' '. Formerly, it was an ID that was used to obtain the status of granting/revoking group-owned resources. It's no longer necessary because the async processing now happens automatically.

TeamGroupMemberSelector

Argument for selecting a group and a single user.
Type:
  • Object
Properties:
Name Type Description
group TeamGroupSelector Specify a group.
user TeamUserSelectorArg Identity of a user that is a member of group.

TeamGroupMemberSelectorError

Error that can be raised when GroupMemberSelector is used, and the user is required to be a member of the specified group.
Type:
  • Object
Properties:
Name Type Description
.tag 'group_not_found' | 'other' | 'system_managed_group_disallowed' | 'member_not_in_group' Tag identifying the union variant.

TeamGroupMemberSetAccessTypeError

Type:
  • Object
Properties:
Name Type Description
.tag 'group_not_found' | 'other' | 'system_managed_group_disallowed' | 'member_not_in_group' | 'user_cannot_be_manager_of_company_managed_group' Tag identifying the union variant.

TeamGroupMembersRemoveArg

Type:
  • Object
Properties:
Name Type Description
group TeamGroupSelector Group from which users will be removed.
users Array.<TeamUserSelectorArg> List of users to be removed from the group.
return_members boolean 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.

TeamGroupMembersRemoveError

Type:
  • Object
Properties:
Name Type Argument Description
members_not_in_team Array.<string> <optional>
 Available if .tag is members_not_in_team. These members are not part of your team.
users_not_found Array.<string> <optional>
 Available if .tag is users_not_found. These users were not found in Dropbox.
.tag 'group_not_found' | 'other' | 'system_managed_group_disallowed' | 'member_not_in_group' | 'group_not_in_team' | 'members_not_in_team' | 'users_not_found' Tag identifying the union variant.

TeamGroupMembersSelector

Argument for selecting a group and a list of users.
Type:
  • Object
Properties:
Name Type Description
group TeamGroupSelector Specify a group.
users TeamUsersSelectorArg A list of users that are members of group.

TeamGroupMembersSelectorError

Error that can be raised when GroupMembersSelector is used, and the users are required to be members of the specified group.
Type:
  • Object
Properties:
Name Type Description
.tag 'group_not_found' | 'other' | 'system_managed_group_disallowed' | 'member_not_in_group' Tag identifying the union variant.

TeamGroupMembersSetAccessTypeArg

Type:
  • Object
Properties:
Name Type Description
group TeamGroupSelector Specify a group.
user TeamUserSelectorArg Identity of a user that is a member of group.
access_type TeamGroupAccessType New group access type the user will have.
return_members boolean 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.

TeamGroupSelector

Argument for selecting a single group, either by group_id or by external group ID.
Type:
  • Object
Properties:
Name Type Argument Description
group_id string <optional>
 Available if .tag is group_id. Group ID.
group_external_id string <optional>
 Available if .tag is group_external_id. External ID of the group.
.tag 'group_id' | 'group_external_id' Tag identifying the union variant.

TeamGroupSelectorError

Error that can be raised when GroupSelector is used.
Type:
  • Object
Properties:
Name Type Description
.tag 'group_not_found' | 'other' Tag identifying the union variant.

TeamGroupSelectorWithTeamGroupError

Error that can be raised when GroupSelector is used and team groups are disallowed from being used.
Type:
  • Object
Properties:
Name Type Description
.tag 'group_not_found' | 'other' | 'system_managed_group_disallowed' Tag identifying the union variant.

TeamGroupsGetInfoError

Type:
  • Object
Properties:
Name Type Description
.tag 'group_not_on_team' | 'other' Tag identifying the union variant.

TeamGroupsGetInfoItem

Type:
  • Object
Properties:
Name Type Argument Description
id_not_found string <optional>
 Available if .tag is id_not_found. An ID that was provided as a parameter to :route:`groups/get_info`, 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.
group_info TeamGroupFullInfo <optional>
 Available if .tag is group_info. Info about a group.
.tag 'id_not_found' | 'group_info' Tag identifying the union variant.

TeamGroupsListArg

Type:
  • Object
Properties:
Name Type Description
limit number Number of results to return per call.

TeamGroupsListContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string Indicates from what point to get the next set of groups.

TeamGroupsListContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_cursor' | 'other' Tag identifying the union variant.

TeamGroupsListResult

Type:
  • Object
Properties:
Name Type Description
groups Array.<TeamCommonGroupSummary>
cursor string Pass the cursor into groups/list/continue to obtain the additional groups.
has_more boolean Is true if there are additional groups that have not been returned yet. An additional call to groups/list/continue can retrieve them.

TeamGroupsMembersListArg

Type:
  • Object
Properties:
Name Type Description
group TeamGroupSelector The group whose members are to be listed.
limit number Number of results to return per call.

TeamGroupsMembersListContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string Indicates from what point to get the next set of groups.

TeamGroupsMembersListContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_cursor' | 'other' Tag identifying the union variant.

TeamGroupsMembersListResult

Type:
  • Object
Properties:
Name Type Description
members Array.<TeamGroupMemberInfo>
cursor string Pass the cursor into groups/members/list/continue to obtain additional group members.
has_more boolean Is true if there are additional group members that have not been returned yet. An additional call to groups/members/list/continue can retrieve them.

TeamGroupsPollError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_async_job_id' | 'internal_error' | 'other' | 'access_denied' Tag identifying the union variant.

TeamGroupsSelector

Argument for selecting a list of groups, either by group_ids, or external group IDs.
Type:
  • Object
Properties:
Name Type Argument Description
group_ids Array.<Object> <optional>
 Available if .tag is group_ids. List of group IDs.
group_external_ids Array.<string> <optional>
 Available if .tag is group_external_ids. List of external IDs of groups.
.tag 'group_ids' | 'group_external_ids' Tag identifying the union variant.

TeamGroupUpdateArgs

Type:
  • Object
Properties:
Name Type Argument Description
group TeamGroupSelector Specify a group.
return_members boolean 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.
new_group_name string <optional>
 Optional argument. Set group name to this if provided.
new_group_external_id string <optional>
 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.
new_group_management_type TeamCommonGroupManagementType <optional>
 Set new group management type, if provided.

TeamGroupUpdateError

Type:
  • Object
Properties:
Name Type Description
.tag 'group_not_found' | 'other' | 'system_managed_group_disallowed' | 'group_name_already_used' | 'group_name_invalid' | 'external_id_already_in_use' Tag identifying the union variant.

TeamHasTeamFileEventsValue

The value for Feature.has_team_file_events.
Type:
  • Object
Properties:
Name Type Argument Description
enabled boolean <optional>
 Available if .tag is enabled. Does this team have file events.
.tag 'enabled' | 'other' Tag identifying the union variant.

TeamHasTeamSelectiveSyncValue

The value for Feature.has_team_selective_sync.
Type:
  • Object
Properties:
Name Type Argument Description
has_team_selective_sync boolean <optional>
 Available if .tag is has_team_selective_sync. Does this team have team selective sync enabled.
.tag 'has_team_selective_sync' | 'other' Tag identifying the union variant.

TeamHasTeamSharedDropboxValue

The value for Feature.has_team_shared_dropbox.
Type:
  • Object
Properties:
Name Type Argument Description
has_team_shared_dropbox boolean <optional>
 Available if .tag is has_team_shared_dropbox. Does this team have a shared team root.
.tag 'has_team_shared_dropbox' | 'other' Tag identifying the union variant.

TeamIncludeMembersArg

Type:
  • Object
Properties:
Name Type Description
return_members boolean 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.

TeamLegalHoldHeldRevisionMetadata

Type:
  • Object
Properties:
Name Type Description
new_filename string The held revision filename.
original_revision_id string The id of the held revision.
original_file_path string The original path of the held revision.
server_modified Timestamp The last time the file was modified on Dropbox.
author_member_id string The member id of the revision's author.
author_member_status TeamTeamMemberStatus The member status of the revision's author.
author_email string The email address of the held revision author.
file_type string The type of the held revision's file.
size number The file size in bytes.
content_hash string A hash of the file content. This field can be used to verify data integrity. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

TeamLegalHoldPolicy

Type:
  • Object
Properties:
Name Type Argument Description
id string The legal hold id.
name string Policy name.
members TeamMembersInfo Team members IDs and number of permanently deleted members under hold.
status TeamLegalHoldStatus The current state of the hold.
start_date Timestamp Start date of the legal hold policy.
description string <optional>
 A description of the legal hold policy.
activation_time Timestamp <optional>
 The time at which the legal hold was activated.
end_date Timestamp <optional>
 End date of the legal hold policy.

TeamLegalHoldsError

Type:
  • Object
Properties:
Name Type Description
.tag 'unknown_legal_hold_error' | 'insufficient_permissions' | 'other' Tag identifying the union variant.

TeamLegalHoldsGetPolicyArg

Type:
  • Object
Properties:
Name Type Description
id string The legal hold Id.

TeamLegalHoldsGetPolicyError

Type:
  • Object
Properties:
Name Type Description
.tag 'unknown_legal_hold_error' | 'insufficient_permissions' | 'other' | 'legal_hold_policy_not_found' Tag identifying the union variant.

TeamLegalHoldsListHeldRevisionResult

Type:
  • Object
Properties:
Name Type Argument Description
entries Array.<TeamLegalHoldHeldRevisionMetadata> List of file entries that under the hold.
has_more boolean True if there are more file entries that haven't been returned. You can retrieve them with a call to /legal_holds/list_held_revisions_continue.
cursor string <optional>
 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. Pass the cursor into /2/team/legal_holds/list_held_revisions/continue.

TeamLegalHoldsListHeldRevisionsArg

Type:
  • Object
Properties:
Name Type Description
id string The legal hold Id.

TeamLegalHoldsListHeldRevisionsContinueArg

Type:
  • Object
Properties:
Name Type Argument Description
id string The legal hold Id.
cursor string <optional>
 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.

TeamLegalHoldsListHeldRevisionsContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'unknown_legal_hold_error' | 'transient_error' | 'reset' | 'other' Tag identifying the union variant.

TeamLegalHoldsListHeldRevisionsError

Type:
  • Object
Properties:
Name Type Description
.tag 'unknown_legal_hold_error' | 'insufficient_permissions' | 'other' | 'transient_error' | 'legal_hold_still_empty' | 'inactive_legal_hold' Tag identifying the union variant.

TeamLegalHoldsListPoliciesArg

Type:
  • Object
Properties:
Name Type Description
include_released boolean Whether to return holds that were released.

TeamLegalHoldsListPoliciesError

Type:
  • Object
Properties:
Name Type Description
.tag 'unknown_legal_hold_error' | 'insufficient_permissions' | 'other' | 'transient_error' Tag identifying the union variant.

TeamLegalHoldsListPoliciesResult

Type:
  • Object
Properties:
Name Type Description
policies Array.<TeamLegalHoldPolicy>

TeamLegalHoldsPolicyCreateArg

Type:
  • Object
Properties:
Name Type Argument Description
name string Policy name.
members Array.<Object> List of team member IDs added to the hold.
description string <optional>
 A description of the legal hold policy.
start_date Timestamp <optional>
 start date of the legal hold policy.
end_date Timestamp <optional>
 end date of the legal hold policy.

TeamLegalHoldsPolicyCreateError

Type:
  • Object
Properties:
Name Type Description
.tag 'unknown_legal_hold_error' | 'insufficient_permissions' | 'other' | 'start_date_is_later_than_end_date' | 'empty_members_list' | 'invalid_members' | 'number_of_users_on_hold_is_greater_than_hold_limitation' | 'transient_error' | 'name_must_be_unique' | 'team_exceeded_legal_hold_quota' | 'invalid_date' Tag identifying the union variant.

TeamLegalHoldsPolicyReleaseArg

Type:
  • Object
Properties:
Name Type Description
id string The legal hold Id.

TeamLegalHoldsPolicyReleaseError

Type:
  • Object
Properties:
Name Type Description
.tag 'unknown_legal_hold_error' | 'insufficient_permissions' | 'other' | 'legal_hold_performing_another_operation' | 'legal_hold_already_releasing' | 'legal_hold_policy_not_found' Tag identifying the union variant.

TeamLegalHoldsPolicyUpdateArg

Type:
  • Object
Properties:
Name Type Argument Description
id string The legal hold Id.
name string <optional>
 Policy new name.
description string <optional>
 Policy new description.
members Array.<Object> <optional>
 List of team member IDs to apply the policy on.

TeamLegalHoldsPolicyUpdateError

Type:
  • Object
Properties:
Name Type Description
.tag 'unknown_legal_hold_error' | 'insufficient_permissions' | 'other' | 'transient_error' | 'inactive_legal_hold' | 'legal_hold_performing_another_operation' | 'invalid_members' | 'number_of_users_on_hold_is_greater_than_hold_limitation' | 'empty_members_list' | 'name_must_be_unique' | 'legal_hold_policy_not_found' Tag identifying the union variant.

TeamLegalHoldStatus

Type:
  • Object
Properties:
Name Type Description
.tag 'active' | 'released' | 'activating' | 'updating' | 'exporting' | 'releasing' | 'other' Tag identifying the union variant.

TeamListMemberAppsArg

Type:
  • Object
Properties:
Name Type Description
team_member_id string The team member id.

TeamListMemberAppsError

Error returned by linked_apps/list_member_linked_apps.
Type:
  • Object
Properties:
Name Type Description
.tag 'member_not_found' | 'other' Tag identifying the union variant.

TeamListMemberAppsResult

Type:
  • Object
Properties:
Name Type Description
linked_api_apps Array.<TeamApiApp> List of third party applications linked by this team member.

TeamListMemberDevicesArg

Type:
  • Object
Properties:
Name Type Description
team_member_id string The team's member id.
include_web_sessions boolean Whether to list web sessions of the team's member.
include_desktop_clients boolean Whether to list linked desktop devices of the team's member.
include_mobile_clients boolean Whether to list linked mobile devices of the team's member.

TeamListMemberDevicesError

Type:
  • Object
Properties:
Name Type Description
.tag 'member_not_found' | 'other' Tag identifying the union variant.

TeamListMemberDevicesResult

Type:
  • Object
Properties:
Name Type Argument Description
active_web_sessions Array.<TeamActiveWebSession> <optional>
 List of web sessions made by this team member.
desktop_client_sessions Array.<TeamDesktopClientSession> <optional>
 List of desktop clients used by this team member.
mobile_client_sessions Array.<TeamMobileClientSession> <optional>
 List of mobile client used by this team member.

TeamListMembersAppsArg

Arguments for linked_apps/list_members_linked_apps.
Type:
  • Object
Properties:
Name Type Argument Description
cursor string <optional>
 At the first call to the 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.

TeamListMembersAppsError

Error returned by linked_apps/list_members_linked_apps.
Type:
  • Object
Properties:
Name Type Description
.tag 'reset' | 'other' Tag identifying the union variant.

TeamListMembersAppsResult

Information returned by linked_apps/list_members_linked_apps.
Type:
  • Object
Properties:
Name Type Argument Description
apps Array.<TeamMemberLinkedApps> The linked applications of each member of the team.
has_more boolean If true, then there are more apps available. Pass the cursor to linked_apps/list_members_linked_apps to retrieve the rest.
cursor string <optional>
 Pass the cursor into linked_apps/list_members_linked_apps to receive the next sub list of team's applications.

TeamListMembersDevicesArg

Type:
  • Object
Properties:
Name Type Argument Description
cursor string <optional>
 At the first call to the 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.
include_web_sessions boolean Whether to list web sessions of the team members.
include_desktop_clients boolean Whether to list desktop clients of the team members.
include_mobile_clients boolean Whether to list mobile clients of the team members.

TeamListMembersDevicesError

Type:
  • Object
Properties:
Name Type Description
.tag 'reset' | 'other' Tag identifying the union variant.

TeamListMembersDevicesResult

Type:
  • Object
Properties:
Name Type Argument Description
devices Array.<TeamMemberDevices> The devices of each member of the team.
has_more boolean If true, then there are more devices available. Pass the cursor to devices/list_members_devices to retrieve the rest.
cursor string <optional>
 Pass the cursor into devices/list_members_devices to receive the next sub list of team's devices.

TeamListTeamAppsArg

Arguments for linked_apps/list_team_linked_apps.
Type:
  • Object
Properties:
Name Type Argument Description
cursor string <optional>
 At the first call to the 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.

TeamListTeamAppsError

Error returned by linked_apps/list_team_linked_apps.
Type:
  • Object
Properties:
Name Type Description
.tag 'reset' | 'other' Tag identifying the union variant.

TeamListTeamAppsResult

Information returned by linked_apps/list_team_linked_apps.
Type:
  • Object
Properties:
Name Type Argument Description
apps Array.<TeamMemberLinkedApps> The linked applications of each member of the team.
has_more boolean If true, then there are more apps available. Pass the cursor to linked_apps/list_team_linked_apps to retrieve the rest.
cursor string <optional>
 Pass the cursor into linked_apps/list_team_linked_apps to receive the next sub list of team's applications.

TeamListTeamDevicesArg

Type:
  • Object
Properties:
Name Type Argument Description
cursor string <optional>
 At the first call to the 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.
include_web_sessions boolean Whether to list web sessions of the team members.
include_desktop_clients boolean Whether to list desktop clients of the team members.
include_mobile_clients boolean Whether to list mobile clients of the team members.

TeamListTeamDevicesError

Type:
  • Object
Properties:
Name Type Description
.tag 'reset' | 'other' Tag identifying the union variant.

TeamListTeamDevicesResult

Type:
  • Object
Properties:
Name Type Argument Description
devices Array.<TeamMemberDevices> The devices of each member of the team.
has_more boolean If true, then there are more devices available. Pass the cursor to devices/list_team_devices to retrieve the rest.
cursor string <optional>
 Pass the cursor into devices/list_team_devices to receive the next sub list of team's devices.

TeamLogAccessMethodLogInfo

Indicates the method in which the action was performed.
Type:
  • Object
Properties:
Name Type Argument Description
admin_console TeamLogWebSessionLogInfo <optional>
 Available if .tag is admin_console. Admin console session details.
api TeamLogApiSessionLogInfo <optional>
 Available if .tag is api. Api session details.
content_manager TeamLogWebSessionLogInfo <optional>
 Available if .tag is content_manager. Content manager session details.
end_user TeamLogWebSessionLogInfo | TeamLogDesktopSessionLogInfo | TeamLogMobileSessionLogInfo | TeamLogSessionLogInfo <optional>
 Available if .tag is end_user. End user session details.
enterprise_console TeamLogWebSessionLogInfo <optional>
 Available if .tag is enterprise_console. Enterprise console session details.
sign_in_as TeamLogWebSessionLogInfo <optional>
 Available if .tag is sign_in_as. Sign in as session details.
.tag 'admin_console' | 'api' | 'content_manager' | 'end_user' | 'enterprise_console' | 'sign_in_as' | 'other' Tag identifying the union variant.

TeamLogAccountCaptureAvailability

Type:
  • Object
Properties:
Name Type Description
.tag 'available' | 'unavailable' | 'other' Tag identifying the union variant.

TeamLogAccountCaptureChangeAvailabilityDetails

Granted/revoked option to enable account capture on team domains.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogAccountCaptureAvailability New account capture availabilty value.
previous_value TeamLogAccountCaptureAvailability <optional>
 Previous account capture availabilty value. Might be missing due to historical data gap.

TeamLogAccountCaptureChangeAvailabilityType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAccountCaptureChangePolicyDetails

Changed account capture setting on team domain.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogAccountCapturePolicy New account capture policy.
previous_value TeamLogAccountCapturePolicy <optional>
 Previous account capture policy. Might be missing due to historical data gap.

TeamLogAccountCaptureChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAccountCaptureMigrateAccountDetails

Account-captured user migrated account to team.
Type:
  • Object
Properties:
Name Type Description
domain_name string Domain name.

TeamLogAccountCaptureMigrateAccountType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAccountCaptureNotificationEmailsSentDetails

Sent account capture email to all unmanaged members.
Type:
  • Object
Properties:
Name Type Argument Description
domain_name string Domain name.
notification_type TeamLogAccountCaptureNotificationType <optional>
 Account-capture email notification type.

TeamLogAccountCaptureNotificationEmailsSentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAccountCaptureNotificationType

Type:
  • Object
Properties:
Name Type Description
.tag 'actionable_notification' | 'proactive_warning_notification' | 'other' Tag identifying the union variant.

TeamLogAccountCapturePolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'all_users' | 'disabled' | 'invited_users' | 'other' Tag identifying the union variant.

TeamLogAccountCaptureRelinquishAccountDetails

Account-captured user changed account email to personal email.
Type:
  • Object
Properties:
Name Type Description
domain_name string Domain name.

TeamLogAccountCaptureRelinquishAccountType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAccountLockOrUnlockedDetails

Unlocked/locked account after failed sign in attempts.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogAccountState The previous account status.
new_value TeamLogAccountState The new account status.

TeamLogAccountLockOrUnlockedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAccountState

Type:
  • Object
Properties:
Name Type Description
.tag 'locked' | 'unlocked' | 'other' Tag identifying the union variant.

TeamLogActionDetails

Additional information indicating the action taken that caused status change.
Type:
  • Object
Properties:
Name Type Argument Description
remove_action TeamLogMemberRemoveActionType <optional>
 Available if .tag is remove_action. Define how the user was removed from the team.
team_invite_details TeamLogTeamInviteDetails <optional>
 Available if .tag is team_invite_details. Additional information relevant when someone is invited to the team.
team_join_details TeamLogJoinTeamDetails <optional>
 Available if .tag is team_join_details. Additional information relevant when a new member joins the team.
.tag 'remove_action' | 'team_invite_details' | 'team_join_details' | 'other' Tag identifying the union variant.

TeamLogActorLogInfo

The entity who performed the action.
Type:
  • Object
Properties:
Name Type Argument Description
admin TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 Available if .tag is admin. The admin who did the action.
app TeamLogUserOrTeamLinkedAppLogInfo | TeamLogUserLinkedAppLogInfo | TeamLogTeamLinkedAppLogInfo | TeamLogAppLogInfo <optional>
 Available if .tag is app. The application who did the action.
reseller TeamLogResellerLogInfo <optional>
 Available if .tag is reseller. Action done by reseller.
user TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 Available if .tag is user. The user who did the action.
.tag 'admin' | 'anonymous' | 'app' | 'dropbox' | 'reseller' | 'user' | 'other' Tag identifying the union variant.

TeamLogAdminAlertCategoryEnum

Alert category
Type:
  • Object
Properties:
Name Type Description
.tag 'account_takeover' | 'data_loss_protection' | 'information_governance' | 'malware_sharing' | 'massive_file_operation' | 'na' | 'threat_management' | 'other' Tag identifying the union variant.

TeamLogAdminAlertGeneralStateEnum

Alert state
Type:
  • Object
Properties:
Name Type Description
.tag 'active' | 'dismissed' | 'in_progress' | 'na' | 'resolved' | 'other' Tag identifying the union variant.

TeamLogAdminAlertingAlertConfiguration

Alert configurations
Type:
  • Object
Properties:
Name Type Argument Description
alert_state TeamLogAdminAlertingAlertStatePolicy <optional>
 Alert state.
sensitivity_level TeamLogAdminAlertingAlertSensitivity <optional>
 Sensitivity level.
recipients_settings TeamLogRecipientsConfiguration <optional>
 Recipient settings.
text string <optional>
 Text.
excluded_file_extensions string <optional>
 Excluded file extensions.

TeamLogAdminAlertingAlertSensitivity

Alert sensitivity
Type:
  • Object
Properties:
Name Type Description
.tag 'high' | 'highest' | 'invalid' | 'low' | 'lowest' | 'medium' | 'other' Tag identifying the union variant.

TeamLogAdminAlertingAlertStateChangedDetails

Changed an alert state.
Type:
  • Object
Properties:
Name Type Description
alert_name string Alert name.
alert_severity TeamLogAdminAlertSeverityEnum Alert severity.
alert_category TeamLogAdminAlertCategoryEnum Alert category.
alert_instance_id string Alert ID.
previous_value TeamLogAdminAlertGeneralStateEnum Alert state before the change.
new_value TeamLogAdminAlertGeneralStateEnum Alert state after the change.

TeamLogAdminAlertingAlertStateChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAdminAlertingAlertStatePolicy

Policy for controlling whether an alert can be triggered or not
Type:
  • Object
Properties:
Name Type Description
.tag 'off' | 'on' | 'other' Tag identifying the union variant.

TeamLogAdminAlertingChangedAlertConfigDetails

Changed an alert setting.
Type:
  • Object
Properties:
Name Type Description
alert_name string Alert Name.
previous_alert_config TeamLogAdminAlertingAlertConfiguration Previous alert configuration.
new_alert_config TeamLogAdminAlertingAlertConfiguration New alert configuration.

TeamLogAdminAlertingChangedAlertConfigType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAdminAlertingTriggeredAlertDetails

Triggered security alert.
Type:
  • Object
Properties:
Name Type Description
alert_name string Alert name.
alert_severity TeamLogAdminAlertSeverityEnum Alert severity.
alert_category TeamLogAdminAlertCategoryEnum Alert category.
alert_instance_id string Alert ID.

TeamLogAdminAlertingTriggeredAlertType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAdminAlertSeverityEnum

Alert severity
Type:
  • Object
Properties:
Name Type Description
.tag 'high' | 'info' | 'low' | 'medium' | 'na' | 'other' Tag identifying the union variant.

TeamLogAdminConsoleAppPermission

Type:
  • Object
Properties:
Name Type Description
.tag 'default_for_listed_apps' | 'default_for_unlisted_apps' | 'other' Tag identifying the union variant.

TeamLogAdminConsoleAppPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'allow' | 'block' | 'default' | 'other' Tag identifying the union variant.

TeamLogAdminEmailRemindersChangedDetails

Changed admin reminder settings for requests to join the team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogAdminEmailRemindersPolicy To.
previous_value TeamLogAdminEmailRemindersPolicy From.

TeamLogAdminEmailRemindersChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAdminEmailRemindersPolicy

Policy for deciding whether team admins receive reminder emails for requests to join the team
Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogAdminRole

Type:
  • Object
Properties:
Name Type Description
.tag 'billing_admin' | 'compliance_admin' | 'content_admin' | 'limited_admin' | 'member_only' | 'reporting_admin' | 'security_admin' | 'support_admin' | 'team_admin' | 'user_management_admin' | 'other' Tag identifying the union variant.

TeamLogAlertRecipientsSettingType

Alert recipients setting type
Type:
  • Object
Properties:
Name Type Description
.tag 'custom_list' | 'invalid' | 'none' | 'team_admins' | 'other' Tag identifying the union variant.

TeamLogAllowDownloadDisabledDetails

Disabled downloads.
Type:
  • Object

TeamLogAllowDownloadDisabledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAllowDownloadEnabledDetails

Enabled downloads.
Type:
  • Object

TeamLogAllowDownloadEnabledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogApiSessionLogInfo

Api session.
Type:
  • Object
Properties:
Name Type Description
request_id string Api request ID.

TeamLogAppBlockedByPermissionsDetails

Failed to connect app for member.
Type:
  • Object
Properties:
Name Type Description
app_info TeamLogUserOrTeamLinkedAppLogInfo | TeamLogUserLinkedAppLogInfo | TeamLogTeamLinkedAppLogInfo | TeamLogAppLogInfo Relevant application details.

TeamLogAppBlockedByPermissionsType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAppLinkTeamDetails

Linked app for team.
Type:
  • Object
Properties:
Name Type Description
app_info TeamLogUserOrTeamLinkedAppLogInfo | TeamLogUserLinkedAppLogInfo | TeamLogTeamLinkedAppLogInfo | TeamLogAppLogInfo Relevant application details.

TeamLogAppLinkTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAppLinkUserDetails

Linked app for member.
Type:
  • Object
Properties:
Name Type Description
app_info TeamLogUserOrTeamLinkedAppLogInfo | TeamLogUserLinkedAppLogInfo | TeamLogTeamLinkedAppLogInfo | TeamLogAppLogInfo Relevant application details.

TeamLogAppLinkUserType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAppLogInfo

App's logged information.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "user_or_team_linked_app" | "user_linked_app" | "team_linked_app" - Tag identifying the subtype variant.
app_id string <optional>
 App unique ID.
display_name string <optional>
 App display name.

TeamLogApplyNamingConventionDetails

Applied naming convention.
Type:
  • Object

TeamLogApplyNamingConventionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAppPermissionsChangedDetails

Changed app permissions.
Type:
  • Object
Properties:
Name Type Argument Description
previous_value TeamLogAdminConsoleAppPolicy Previous policy.
new_value TeamLogAdminConsoleAppPolicy New policy.
app_name string <optional>
 Name of the app.
permission TeamLogAdminConsoleAppPermission <optional>
 Permission that was changed.

TeamLogAppPermissionsChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAppUnlinkTeamDetails

Unlinked app for team.
Type:
  • Object
Properties:
Name Type Description
app_info TeamLogUserOrTeamLinkedAppLogInfo | TeamLogUserLinkedAppLogInfo | TeamLogTeamLinkedAppLogInfo | TeamLogAppLogInfo Relevant application details.

TeamLogAppUnlinkTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAppUnlinkUserDetails

Unlinked app for member.
Type:
  • Object
Properties:
Name Type Description
app_info TeamLogUserOrTeamLinkedAppLogInfo | TeamLogUserLinkedAppLogInfo | TeamLogTeamLinkedAppLogInfo | TeamLogAppLogInfo Relevant application details.

TeamLogAppUnlinkUserType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogAssetLogInfo

Asset details.
Type:
  • Object
Properties:
Name Type Argument Description
file TeamLogFileLogInfo <optional>
 Available if .tag is file. File's details.
folder TeamLogFolderLogInfo <optional>
 Available if .tag is folder. Folder's details.
paper_document TeamLogPaperDocumentLogInfo <optional>
 Available if .tag is paper_document. Paper document's details.
paper_folder TeamLogPaperFolderLogInfo <optional>
 Available if .tag is paper_folder. Paper folder's details.
showcase_document TeamLogShowcaseDocumentLogInfo <optional>
 Available if .tag is showcase_document. Showcase document's details.
.tag 'file' | 'folder' | 'paper_document' | 'paper_folder' | 'showcase_document' | 'other' Tag identifying the union variant.

TeamLogBackupStatus

Backup status
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogBinderAddPageDetails

Added Binder page.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
doc_title string Title of the Binder doc.
binder_item_name string Name of the Binder page/section.

TeamLogBinderAddPageType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogBinderAddSectionDetails

Added Binder section.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
doc_title string Title of the Binder doc.
binder_item_name string Name of the Binder page/section.

TeamLogBinderAddSectionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogBinderRemovePageDetails

Removed Binder page.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
doc_title string Title of the Binder doc.
binder_item_name string Name of the Binder page/section.

TeamLogBinderRemovePageType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogBinderRemoveSectionDetails

Removed Binder section.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
doc_title string Title of the Binder doc.
binder_item_name string Name of the Binder page/section.

TeamLogBinderRemoveSectionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogBinderRenamePageDetails

Renamed Binder page.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
doc_title string Title of the Binder doc.
binder_item_name string Name of the Binder page/section.
previous_binder_item_name string <optional>
 Previous name of the Binder page/section.

TeamLogBinderRenamePageType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogBinderRenameSectionDetails

Renamed Binder section.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
doc_title string Title of the Binder doc.
binder_item_name string Name of the Binder page/section.
previous_binder_item_name string <optional>
 Previous name of the Binder page/section.

TeamLogBinderRenameSectionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogBinderReorderPageDetails

Reordered Binder page.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
doc_title string Title of the Binder doc.
binder_item_name string Name of the Binder page/section.

TeamLogBinderReorderPageType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogBinderReorderSectionDetails

Reordered Binder section.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
doc_title string Title of the Binder doc.
binder_item_name string Name of the Binder page/section.

TeamLogBinderReorderSectionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogCameraUploadsPolicy

Policy for controlling if team members can activate camera uploads
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogCameraUploadsPolicyChangedDetails

Changed camera uploads setting for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogCameraUploadsPolicy New camera uploads setting.
previous_value TeamLogCameraUploadsPolicy Previous camera uploads setting.

TeamLogCameraUploadsPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogCaptureTranscriptPolicy

Policy for deciding whether team users can transcription in Capture
Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogCaptureTranscriptPolicyChangedDetails

Changed Capture transcription policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogCaptureTranscriptPolicy To.
previous_value TeamLogCaptureTranscriptPolicy From.

TeamLogCaptureTranscriptPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogCertificate

Certificate details.
Type:
  • Object
Properties:
Name Type Argument Description
subject string Certificate subject.
issuer string Certificate issuer.
issue_date string Certificate issue date.
expiration_date string Certificate expiration date.
serial_number string Certificate serial number.
sha1_fingerprint string Certificate sha1 fingerprint.
common_name string <optional>
 Certificate common name.

TeamLogChangedEnterpriseAdminRoleDetails

Changed enterprise admin role.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogFedAdminRole The member’s previous enterprise admin role.
new_value TeamLogFedAdminRole The member’s new enterprise admin role.
team_name string The name of the member’s team.

TeamLogChangedEnterpriseAdminRoleType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogChangedEnterpriseConnectedTeamStatusDetails

Changed enterprise-connected team status.
Type:
  • Object
Properties:
Name Type Description
action TeamLogFedHandshakeAction The preformed change in the team’s connection status.
additional_info TeamLogFederationStatusChangeAdditionalInfo Additional information about the organization or team.
previous_value TeamLogTrustedTeamsRequestState Previous request state.
new_value TeamLogTrustedTeamsRequestState New request state.

TeamLogChangedEnterpriseConnectedTeamStatusType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogChangeLinkExpirationPolicy

Policy for deciding whether the team's default expiration days policy must be enforced when an externally shared link is updated
Type:
  • Object
Properties:
Name Type Description
.tag 'allowed' | 'not_allowed' | 'other' Tag identifying the union variant.

TeamLogClassificationChangePolicyDetails

Changed classification policy for team.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogClassificationPolicyEnumWrapper Previous classification policy.
new_value TeamLogClassificationPolicyEnumWrapper New classification policy.
classification_type TeamLogClassificationType Policy type.

TeamLogClassificationChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogClassificationCreateReportDetails

Created Classification report.
Type:
  • Object

TeamLogClassificationCreateReportFailDetails

Couldn't create Classification report.
Type:
  • Object
Properties:
Name Type Description
failure_reason TeamTeamReportFailureReason Failure reason.

TeamLogClassificationCreateReportFailType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogClassificationCreateReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogClassificationPolicyEnumWrapper

Policy for controlling team access to the classification feature
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'member_and_team_folders' | 'team_folders' | 'other' Tag identifying the union variant.

TeamLogClassificationType

The type of classification (currently only personal information)
Type:
  • Object
Properties:
Name Type Description
.tag 'personal_information' | 'pii' | 'other' Tag identifying the union variant.

TeamLogCollectionShareDetails

Shared album.
Type:
  • Object
Properties:
Name Type Description
album_name string Album name.

TeamLogCollectionShareType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogComputerBackupPolicy

Policy for controlling team access to computer backup feature
Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogComputerBackupPolicyChangedDetails

Changed computer backup policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogComputerBackupPolicy New computer backup policy.
previous_value TeamLogComputerBackupPolicy Previous computer backup policy.

TeamLogComputerBackupPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogConnectedTeamName

The name of the team
Type:
  • Object
Properties:
Name Type Description
team string The name of the team.

TeamLogContentAdministrationPolicyChangedDetails

Changed content management setting.
Type:
  • Object
Properties:
Name Type Description
new_value string New content administration policy.
previous_value string Previous content administration policy.

TeamLogContentAdministrationPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogContentPermanentDeletePolicy

Policy for pemanent content deletion
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogContextLogInfo

The primary entity on which the action was done.
Type:
  • Object
Properties:
Name Type Argument Description
non_team_member TeamLogNonTeamMemberLogInfo <optional>
 Available if .tag is non_team_member. Action was done on behalf of a non team member.
organization_team TeamLogTeamLogInfo <optional>
 Available if .tag is organization_team. Action was done on behalf of a team that's part of an organization.
team_member TeamLogTeamMemberLogInfo <optional>
 Available if .tag is team_member. Action was done on behalf of a team member.
trusted_non_team_member TeamLogTrustedNonTeamMemberLogInfo <optional>
 Available if .tag is trusted_non_team_member. Action was done on behalf of a trusted non team member.
.tag 'anonymous' | 'non_team_member' | 'organization_team' | 'team' | 'team_member' | 'trusted_non_team_member' | 'other' Tag identifying the union variant.

TeamLogCreateFolderDetails

Created folders.
Type:
  • Object

TeamLogCreateFolderType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogCreateTeamInviteLinkDetails

Created team invite link.
Type:
  • Object
Properties:
Name Type Description
link_url string The invite link url that was created.
expiry_date string The expiration date of the invite link.

TeamLogCreateTeamInviteLinkType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDataPlacementRestrictionChangePolicyDetails

Set restrictions on data center locations where team data resides.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogPlacementRestriction Previous placement restriction.
new_value TeamLogPlacementRestriction New placement restriction.

TeamLogDataPlacementRestrictionChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDataPlacementRestrictionSatisfyPolicyDetails

Completed restrictions on data center locations where team data resides.
Type:
  • Object
Properties:
Name Type Description
placement_restriction TeamLogPlacementRestriction Placement restriction.

TeamLogDataPlacementRestrictionSatisfyPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDataResidencyMigrationRequestSuccessfulDetails

Requested data residency migration for team data.
Type:
  • Object

TeamLogDataResidencyMigrationRequestSuccessfulType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDataResidencyMigrationRequestUnsuccessfulDetails

Request for data residency migration for team data has failed.
Type:
  • Object

TeamLogDataResidencyMigrationRequestUnsuccessfulType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDefaultLinkExpirationDaysPolicy

Policy for the default number of days until an externally shared link expires
Type:
  • Object
Properties:
Name Type Description
.tag 'day_1' | 'day_180' | 'day_3' | 'day_30' | 'day_7' | 'day_90' | 'none' | 'year_1' | 'other' Tag identifying the union variant.

TeamLogDeleteTeamInviteLinkDetails

Deleted team invite link.
Type:
  • Object
Properties:
Name Type Description
link_url string The invite link url that was deleted.

TeamLogDeleteTeamInviteLinkType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDesktopDeviceSessionLogInfo

Information about linked Dropbox desktop client sessions
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'desktop_device_session' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
host_name string Name of the hosting desktop.
client_type TeamDesktopPlatform The Dropbox desktop client type.
platform string Information on the hosting platform.
is_delete_on_unlink_supported boolean Whether itu2019s possible to delete all of the account files upon unlinking.
ip_address string <optional>
 The IP address of the last activity from this session.
created Timestamp <optional>
 The time this session was created.
updated Timestamp <optional>
 The time of the last activity from this session.
session_info TeamLogDesktopSessionLogInfo <optional>
 Desktop session unique id.
client_version string <optional>
 The Dropbox client version.

TeamLogDesktopSessionLogInfo

Desktop session.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'desktop' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
session_id string <optional>
 Session ID.

TeamLogDeviceApprovalsAddExceptionDetails

Added members to device approvals exception list.
Type:
  • Object

TeamLogDeviceApprovalsAddExceptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceApprovalsChangeDesktopPolicyDetails

Set/removed limit on number of computers member can link to team Dropbox account.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogDeviceApprovalsPolicy <optional>
 New desktop device approvals policy. Might be missing due to historical data gap.
previous_value TeamLogDeviceApprovalsPolicy <optional>
 Previous desktop device approvals policy. Might be missing due to historical data gap.

TeamLogDeviceApprovalsChangeDesktopPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceApprovalsChangeMobilePolicyDetails

Set/removed limit on number of mobile devices member can link to team Dropbox account.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogDeviceApprovalsPolicy <optional>
 New mobile device approvals policy. Might be missing due to historical data gap.
previous_value TeamLogDeviceApprovalsPolicy <optional>
 Previous mobile device approvals policy. Might be missing due to historical data gap.

TeamLogDeviceApprovalsChangeMobilePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceApprovalsChangeOverageActionDetails

Changed device approvals setting when member is over limit.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamPoliciesRolloutMethod <optional>
 New over the limits policy. Might be missing due to historical data gap.
previous_value TeamPoliciesRolloutMethod <optional>
 Previous over the limit policy. Might be missing due to historical data gap.

TeamLogDeviceApprovalsChangeOverageActionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceApprovalsChangeUnlinkActionDetails

Changed device approvals setting when member unlinks approved device.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogDeviceUnlinkPolicy <optional>
 New device unlink policy. Might be missing due to historical data gap.
previous_value TeamLogDeviceUnlinkPolicy <optional>
 Previous device unlink policy. Might be missing due to historical data gap.

TeamLogDeviceApprovalsChangeUnlinkActionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceApprovalsPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'limited' | 'unlimited' | 'other' Tag identifying the union variant.

TeamLogDeviceApprovalsRemoveExceptionDetails

Removed members from device approvals exception list.
Type:
  • Object

TeamLogDeviceApprovalsRemoveExceptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceChangeIpDesktopDetails

Changed IP address associated with active desktop session.
Type:
  • Object
Properties:
Name Type Description
device_session_info TeamLogDesktopDeviceSessionLogInfo | TeamLogMobileDeviceSessionLogInfo | TeamLogWebDeviceSessionLogInfo | TeamLogLegacyDeviceSessionLogInfo | TeamLogDeviceSessionLogInfo Device's session logged information.

TeamLogDeviceChangeIpDesktopType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceChangeIpMobileDetails

Changed IP address associated with active mobile session.
Type:
  • Object
Properties:
Name Type Argument Description
device_session_info TeamLogDesktopDeviceSessionLogInfo | TeamLogMobileDeviceSessionLogInfo | TeamLogWebDeviceSessionLogInfo | TeamLogLegacyDeviceSessionLogInfo | TeamLogDeviceSessionLogInfo <optional>
 Device's session logged information.

TeamLogDeviceChangeIpMobileType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceChangeIpWebDetails

Changed IP address associated with active web session.
Type:
  • Object
Properties:
Name Type Description
user_agent string Web browser name.

TeamLogDeviceChangeIpWebType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceDeleteOnUnlinkFailDetails

Failed to delete all files from unlinked device.
Type:
  • Object
Properties:
Name Type Argument Description
num_failures number The number of times that remote file deletion failed.
session_info TeamLogWebSessionLogInfo | TeamLogDesktopSessionLogInfo | TeamLogMobileSessionLogInfo | TeamLogSessionLogInfo <optional>
 Session unique id.
display_name string <optional>
 The device name. Might be missing due to historical data gap.

TeamLogDeviceDeleteOnUnlinkFailType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceDeleteOnUnlinkSuccessDetails

Deleted all files from unlinked device.
Type:
  • Object
Properties:
Name Type Argument Description
session_info TeamLogWebSessionLogInfo | TeamLogDesktopSessionLogInfo | TeamLogMobileSessionLogInfo | TeamLogSessionLogInfo <optional>
 Session unique id.
display_name string <optional>
 The device name. Might be missing due to historical data gap.

TeamLogDeviceDeleteOnUnlinkSuccessType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceLinkFailDetails

Failed to link device.
Type:
  • Object
Properties:
Name Type Argument Description
device_type TeamLogDeviceType A description of the device used while user approval blocked.
ip_address string <optional>
 IP address. Might be missing due to historical data gap.

TeamLogDeviceLinkFailType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceLinkSuccessDetails

Linked device.
Type:
  • Object
Properties:
Name Type Argument Description
device_session_info TeamLogDesktopDeviceSessionLogInfo | TeamLogMobileDeviceSessionLogInfo | TeamLogWebDeviceSessionLogInfo | TeamLogLegacyDeviceSessionLogInfo | TeamLogDeviceSessionLogInfo <optional>
 Device's session logged information.

TeamLogDeviceLinkSuccessType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceManagementDisabledDetails

Disabled device management.
Type:
  • Object

TeamLogDeviceManagementDisabledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceManagementEnabledDetails

Enabled device management.
Type:
  • Object

TeamLogDeviceManagementEnabledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceSessionLogInfo

Device's session logged information.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "desktop_device_session" | "mobile_device_session" | "web_device_session" | "legacy_device_session" Tag identifying the subtype variant.
ip_address string <optional>
 The IP address of the last activity from this session.
created Timestamp <optional>
 The time this session was created.
updated Timestamp <optional>
 The time of the last activity from this session.

TeamLogDeviceSyncBackupStatusChangedDetails

Enabled/disabled backup for computer.
Type:
  • Object
Properties:
Name Type Description
desktop_device_session_info TeamLogDesktopDeviceSessionLogInfo Device's session logged information.
previous_value TeamLogBackupStatus Previous status of computer backup on the device.
new_value TeamLogBackupStatus Next status of computer backup on the device.

TeamLogDeviceSyncBackupStatusChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDeviceType

Type:
  • Object
Properties:
Name Type Description
.tag 'desktop' | 'mobile' | 'other' Tag identifying the union variant.

TeamLogDeviceUnlinkDetails

Disconnected device.
Type:
  • Object
Properties:
Name Type Argument Description
delete_data boolean True if the user requested to delete data after device unlink, false otherwise.
session_info TeamLogWebSessionLogInfo | TeamLogDesktopSessionLogInfo | TeamLogMobileSessionLogInfo | TeamLogSessionLogInfo <optional>
 Session unique id.
display_name string <optional>
 The device name. Might be missing due to historical data gap.

TeamLogDeviceUnlinkPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'keep' | 'remove' | 'other' Tag identifying the union variant.

TeamLogDeviceUnlinkType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDirectoryRestrictionsAddMembersDetails

Added members to directory restrictions list.
Type:
  • Object

TeamLogDirectoryRestrictionsAddMembersType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDirectoryRestrictionsRemoveMembersDetails

Removed members from directory restrictions list.
Type:
  • Object

TeamLogDirectoryRestrictionsRemoveMembersType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDisabledDomainInvitesDetails

Disabled domain invites.
Type:
  • Object

TeamLogDisabledDomainInvitesType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDispositionActionType

Type:
  • Object
Properties:
Name Type Description
.tag 'automatic_delete' | 'automatic_permanently_delete' | 'other' Tag identifying the union variant.

TeamLogDomainInvitesApproveRequestToJoinTeamDetails

Approved user's request to join team.
Type:
  • Object

TeamLogDomainInvitesApproveRequestToJoinTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDomainInvitesDeclineRequestToJoinTeamDetails

Declined user's request to join team.
Type:
  • Object

TeamLogDomainInvitesDeclineRequestToJoinTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDomainInvitesEmailExistingUsersDetails

Sent domain invites to existing domain accounts.
Type:
  • Object
Properties:
Name Type Description
domain_name string Domain names.
num_recipients number Number of recipients.

TeamLogDomainInvitesEmailExistingUsersType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDomainInvitesRequestToJoinTeamDetails

Requested to join team.
Type:
  • Object

TeamLogDomainInvitesRequestToJoinTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDomainInvitesSetInviteNewUserPrefToNoDetails

Disabled "Automatically invite new users".
Type:
  • Object

TeamLogDomainInvitesSetInviteNewUserPrefToNoType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDomainInvitesSetInviteNewUserPrefToYesDetails

Enabled "Automatically invite new users".
Type:
  • Object

TeamLogDomainInvitesSetInviteNewUserPrefToYesType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDomainVerificationAddDomainFailDetails

Failed to verify team domain.
Type:
  • Object
Properties:
Name Type Argument Description
domain_name string Domain name.
verification_method string <optional>
 Domain name verification method. Might be missing due to historical data gap.

TeamLogDomainVerificationAddDomainFailType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDomainVerificationAddDomainSuccessDetails

Verified team domain.
Type:
  • Object
Properties:
Name Type Argument Description
domain_names Array.<string> Domain names.
verification_method string <optional>
 Domain name verification method. Might be missing due to historical data gap.

TeamLogDomainVerificationAddDomainSuccessType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDomainVerificationRemoveDomainDetails

Removed domain from list of verified team domains.
Type:
  • Object
Properties:
Name Type Description
domain_names Array.<string> Domain names.

TeamLogDomainVerificationRemoveDomainType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDownloadPolicyType

Shared content downloads policy
Type:
  • Object
Properties:
Name Type Description
.tag 'allow' | 'disallow' | 'other' Tag identifying the union variant.

TeamLogDropboxPasswordsExportedDetails

Exported passwords.
Type:
  • Object
Properties:
Name Type Description
platform string The platform the device runs export.

TeamLogDropboxPasswordsExportedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDropboxPasswordsNewDeviceEnrolledDetails

Enrolled new Dropbox Passwords device.
Type:
  • Object
Properties:
Name Type Description
is_first_device boolean Whether it's a first device enrolled.
platform string The platform the device is enrolled.

TeamLogDropboxPasswordsNewDeviceEnrolledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDropboxPasswordsPolicy

Policy for deciding whether team users can use Dropbox Passwords
Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogDropboxPasswordsPolicyChangedDetails

Changed Dropbox Passwords policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogDropboxPasswordsPolicy To.
previous_value TeamLogDropboxPasswordsPolicy From.

TeamLogDropboxPasswordsPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogDurationLogInfo

Represents a time duration: unit and amount
Type:
  • Object
Properties:
Name Type Description
unit TeamLogTimeUnit Time unit.
amount number Amount of time.

TeamLogEmailIngestPolicy

Policy for deciding whether a team can use Email to Dropbox feature
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogEmailIngestPolicyChangedDetails

Changed email to Dropbox policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogEmailIngestPolicy To.
previous_value TeamLogEmailIngestPolicy From.

TeamLogEmailIngestPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEmailIngestReceiveFileDetails

Received files via Email to Dropbox.
Type:
  • Object
Properties:
Name Type Argument Description
inbox_name string Inbox name.
attachment_names Array.<string> Submitted file names.
subject string <optional>
 Subject of the email.
from_name string <optional>
 The name as provided by the submitter.
from_email string <optional>
 The email as provided by the submitter.

TeamLogEmailIngestReceiveFileType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEmmAddExceptionDetails

Added members to EMM exception list.
Type:
  • Object

TeamLogEmmAddExceptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEmmChangePolicyDetails

Enabled/disabled enterprise mobility management for members.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamPoliciesEmmState New enterprise mobility management policy.
previous_value TeamPoliciesEmmState <optional>
 Previous enterprise mobility management policy. Might be missing due to historical data gap.

TeamLogEmmChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEmmCreateExceptionsReportDetails

Created EMM-excluded users report.
Type:
  • Object

TeamLogEmmCreateExceptionsReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEmmCreateUsageReportDetails

Created EMM mobile app usage report.
Type:
  • Object

TeamLogEmmCreateUsageReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEmmErrorDetails

Failed to sign in via EMM.
Type:
  • Object
Properties:
Name Type Description
error_details TeamLogFailureDetailsLogInfo Error details.

TeamLogEmmErrorType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEmmRefreshAuthTokenDetails

Refreshed auth token used for setting up EMM.
Type:
  • Object

TeamLogEmmRefreshAuthTokenType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEmmRemoveExceptionDetails

Removed members from EMM exception list.
Type:
  • Object

TeamLogEmmRemoveExceptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEnabledDomainInvitesDetails

Enabled domain invites.
Type:
  • Object

TeamLogEnabledDomainInvitesType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEndedEnterpriseAdminSessionDeprecatedDetails

Ended enterprise admin session.
Type:
  • Object
Properties:
Name Type Description
federation_extra_details TeamLogFedExtraDetails More information about the organization or team.

TeamLogEndedEnterpriseAdminSessionDeprecatedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEndedEnterpriseAdminSessionDetails

Ended enterprise admin session.
Type:
  • Object

TeamLogEndedEnterpriseAdminSessionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEnforceLinkPasswordPolicy

Policy for deciding whether password must be enforced when an externally shared link is updated
Type:
  • Object
Properties:
Name Type Description
.tag 'optional' | 'required' | 'other' Tag identifying the union variant.

TeamLogEnterpriseSettingsLockingDetails

Changed who can update a setting.
Type:
  • Object
Properties:
Name Type Description
team_name string The secondary team name.
settings_page_name string Settings page name.
previous_settings_page_locking_state string Previous locked settings page state.
new_settings_page_locking_state string New locked settings page state.

TeamLogEnterpriseSettingsLockingType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogEventCategory

Category of events in event audit log.
Type:
  • Object
Properties:
Name Type Description
.tag 'admin_alerting' | 'apps' | 'comments' | 'data_governance' | 'devices' | 'domains' | 'file_operations' | 'file_requests' | 'groups' | 'logins' | 'members' | 'paper' | 'passwords' | 'reports' | 'sharing' | 'showcase' | 'sso' | 'team_folders' | 'team_policies' | 'team_profile' | 'tfa' | 'trusted_teams' | 'other' Tag identifying the union variant.

TeamLogEventDetails

Additional fields depending on the event type.
Type:
  • Object
Properties:
Name Type Argument Description
admin_alerting_alert_state_changed_details TeamLogAdminAlertingAlertStateChangedDetails <optional>
 Available if .tag is admin_alerting_alert_state_changed_details.
admin_alerting_changed_alert_config_details TeamLogAdminAlertingChangedAlertConfigDetails <optional>
 Available if .tag is admin_alerting_changed_alert_config_details.
admin_alerting_triggered_alert_details TeamLogAdminAlertingTriggeredAlertDetails <optional>
 Available if .tag is admin_alerting_triggered_alert_details.
app_blocked_by_permissions_details TeamLogAppBlockedByPermissionsDetails <optional>
 Available if .tag is app_blocked_by_permissions_details.
app_link_team_details TeamLogAppLinkTeamDetails <optional>
 Available if .tag is app_link_team_details.
app_link_user_details TeamLogAppLinkUserDetails <optional>
 Available if .tag is app_link_user_details.
app_unlink_team_details TeamLogAppUnlinkTeamDetails <optional>
 Available if .tag is app_unlink_team_details.
app_unlink_user_details TeamLogAppUnlinkUserDetails <optional>
 Available if .tag is app_unlink_user_details.
integration_connected_details TeamLogIntegrationConnectedDetails <optional>
 Available if .tag is integration_connected_details.
integration_disconnected_details TeamLogIntegrationDisconnectedDetails <optional>
 Available if .tag is integration_disconnected_details.
file_add_comment_details TeamLogFileAddCommentDetails <optional>
 Available if .tag is file_add_comment_details.
file_change_comment_subscription_details TeamLogFileChangeCommentSubscriptionDetails <optional>
 Available if .tag is file_change_comment_subscription_details.
file_delete_comment_details TeamLogFileDeleteCommentDetails <optional>
 Available if .tag is file_delete_comment_details.
file_edit_comment_details TeamLogFileEditCommentDetails <optional>
 Available if .tag is file_edit_comment_details.
file_like_comment_details TeamLogFileLikeCommentDetails <optional>
 Available if .tag is file_like_comment_details.
file_resolve_comment_details TeamLogFileResolveCommentDetails <optional>
 Available if .tag is file_resolve_comment_details.
file_unlike_comment_details TeamLogFileUnlikeCommentDetails <optional>
 Available if .tag is file_unlike_comment_details.
file_unresolve_comment_details TeamLogFileUnresolveCommentDetails <optional>
 Available if .tag is file_unresolve_comment_details.
governance_policy_add_folders_details TeamLogGovernancePolicyAddFoldersDetails <optional>
 Available if .tag is governance_policy_add_folders_details.
governance_policy_add_folder_failed_details TeamLogGovernancePolicyAddFolderFailedDetails <optional>
 Available if .tag is governance_policy_add_folder_failed_details.
governance_policy_content_disposed_details TeamLogGovernancePolicyContentDisposedDetails <optional>
 Available if .tag is governance_policy_content_disposed_details.
governance_policy_create_details TeamLogGovernancePolicyCreateDetails <optional>
 Available if .tag is governance_policy_create_details.
governance_policy_delete_details TeamLogGovernancePolicyDeleteDetails <optional>
 Available if .tag is governance_policy_delete_details.
governance_policy_edit_details_details TeamLogGovernancePolicyEditDetailsDetails <optional>
 Available if .tag is governance_policy_edit_details_details.
governance_policy_edit_duration_details TeamLogGovernancePolicyEditDurationDetails <optional>
 Available if .tag is governance_policy_edit_duration_details.
governance_policy_export_created_details TeamLogGovernancePolicyExportCreatedDetails <optional>
 Available if .tag is governance_policy_export_created_details.
governance_policy_export_removed_details TeamLogGovernancePolicyExportRemovedDetails <optional>
 Available if .tag is governance_policy_export_removed_details.
governance_policy_remove_folders_details TeamLogGovernancePolicyRemoveFoldersDetails <optional>
 Available if .tag is governance_policy_remove_folders_details.
governance_policy_report_created_details TeamLogGovernancePolicyReportCreatedDetails <optional>
 Available if .tag is governance_policy_report_created_details.
governance_policy_zip_part_downloaded_details TeamLogGovernancePolicyZipPartDownloadedDetails <optional>
 Available if .tag is governance_policy_zip_part_downloaded_details.
legal_holds_activate_a_hold_details TeamLogLegalHoldsActivateAHoldDetails <optional>
 Available if .tag is legal_holds_activate_a_hold_details.
legal_holds_add_members_details TeamLogLegalHoldsAddMembersDetails <optional>
 Available if .tag is legal_holds_add_members_details.
legal_holds_change_hold_details_details TeamLogLegalHoldsChangeHoldDetailsDetails <optional>
 Available if .tag is legal_holds_change_hold_details_details.
legal_holds_change_hold_name_details TeamLogLegalHoldsChangeHoldNameDetails <optional>
 Available if .tag is legal_holds_change_hold_name_details.
legal_holds_export_a_hold_details TeamLogLegalHoldsExportAHoldDetails <optional>
 Available if .tag is legal_holds_export_a_hold_details.
legal_holds_export_cancelled_details TeamLogLegalHoldsExportCancelledDetails <optional>
 Available if .tag is legal_holds_export_cancelled_details.
legal_holds_export_downloaded_details TeamLogLegalHoldsExportDownloadedDetails <optional>
 Available if .tag is legal_holds_export_downloaded_details.
legal_holds_export_removed_details TeamLogLegalHoldsExportRemovedDetails <optional>
 Available if .tag is legal_holds_export_removed_details.
legal_holds_release_a_hold_details TeamLogLegalHoldsReleaseAHoldDetails <optional>
 Available if .tag is legal_holds_release_a_hold_details.
legal_holds_remove_members_details TeamLogLegalHoldsRemoveMembersDetails <optional>
 Available if .tag is legal_holds_remove_members_details.
legal_holds_report_a_hold_details TeamLogLegalHoldsReportAHoldDetails <optional>
 Available if .tag is legal_holds_report_a_hold_details.
device_change_ip_desktop_details TeamLogDeviceChangeIpDesktopDetails <optional>
 Available if .tag is device_change_ip_desktop_details.
device_change_ip_mobile_details TeamLogDeviceChangeIpMobileDetails <optional>
 Available if .tag is device_change_ip_mobile_details.
device_change_ip_web_details TeamLogDeviceChangeIpWebDetails <optional>
 Available if .tag is device_change_ip_web_details.
device_delete_on_unlink_fail_details TeamLogDeviceDeleteOnUnlinkFailDetails <optional>
 Available if .tag is device_delete_on_unlink_fail_details.
device_delete_on_unlink_success_details TeamLogDeviceDeleteOnUnlinkSuccessDetails <optional>
 Available if .tag is device_delete_on_unlink_success_details.
device_link_fail_details TeamLogDeviceLinkFailDetails <optional>
 Available if .tag is device_link_fail_details.
device_link_success_details TeamLogDeviceLinkSuccessDetails <optional>
 Available if .tag is device_link_success_details.
device_management_disabled_details TeamLogDeviceManagementDisabledDetails <optional>
 Available if .tag is device_management_disabled_details.
device_management_enabled_details TeamLogDeviceManagementEnabledDetails <optional>
 Available if .tag is device_management_enabled_details.
device_sync_backup_status_changed_details TeamLogDeviceSyncBackupStatusChangedDetails <optional>
 Available if .tag is device_sync_backup_status_changed_details.
device_unlink_details TeamLogDeviceUnlinkDetails <optional>
 Available if .tag is device_unlink_details.
dropbox_passwords_exported_details TeamLogDropboxPasswordsExportedDetails <optional>
 Available if .tag is dropbox_passwords_exported_details.
dropbox_passwords_new_device_enrolled_details TeamLogDropboxPasswordsNewDeviceEnrolledDetails <optional>
 Available if .tag is dropbox_passwords_new_device_enrolled_details.
emm_refresh_auth_token_details TeamLogEmmRefreshAuthTokenDetails <optional>
 Available if .tag is emm_refresh_auth_token_details.
external_drive_backup_eligibility_status_checked_details TeamLogExternalDriveBackupEligibilityStatusCheckedDetails <optional>
 Available if .tag is external_drive_backup_eligibility_status_checked_details.
external_drive_backup_status_changed_details TeamLogExternalDriveBackupStatusChangedDetails <optional>
 Available if .tag is external_drive_backup_status_changed_details.
account_capture_change_availability_details TeamLogAccountCaptureChangeAvailabilityDetails <optional>
 Available if .tag is account_capture_change_availability_details.
account_capture_migrate_account_details TeamLogAccountCaptureMigrateAccountDetails <optional>
 Available if .tag is account_capture_migrate_account_details.
account_capture_notification_emails_sent_details TeamLogAccountCaptureNotificationEmailsSentDetails <optional>
 Available if .tag is account_capture_notification_emails_sent_details.
account_capture_relinquish_account_details TeamLogAccountCaptureRelinquishAccountDetails <optional>
 Available if .tag is account_capture_relinquish_account_details.
disabled_domain_invites_details TeamLogDisabledDomainInvitesDetails <optional>
 Available if .tag is disabled_domain_invites_details.
domain_invites_approve_request_to_join_team_details TeamLogDomainInvitesApproveRequestToJoinTeamDetails <optional>
 Available if .tag is domain_invites_approve_request_to_join_team_details.
domain_invites_decline_request_to_join_team_details TeamLogDomainInvitesDeclineRequestToJoinTeamDetails <optional>
 Available if .tag is domain_invites_decline_request_to_join_team_details.
domain_invites_email_existing_users_details TeamLogDomainInvitesEmailExistingUsersDetails <optional>
 Available if .tag is domain_invites_email_existing_users_details.
domain_invites_request_to_join_team_details TeamLogDomainInvitesRequestToJoinTeamDetails <optional>
 Available if .tag is domain_invites_request_to_join_team_details.
domain_invites_set_invite_new_user_pref_to_no_details TeamLogDomainInvitesSetInviteNewUserPrefToNoDetails <optional>
 Available if .tag is domain_invites_set_invite_new_user_pref_to_no_details.
domain_invites_set_invite_new_user_pref_to_yes_details TeamLogDomainInvitesSetInviteNewUserPrefToYesDetails <optional>
 Available if .tag is domain_invites_set_invite_new_user_pref_to_yes_details.
domain_verification_add_domain_fail_details TeamLogDomainVerificationAddDomainFailDetails <optional>
 Available if .tag is domain_verification_add_domain_fail_details.
domain_verification_add_domain_success_details TeamLogDomainVerificationAddDomainSuccessDetails <optional>
 Available if .tag is domain_verification_add_domain_success_details.
domain_verification_remove_domain_details TeamLogDomainVerificationRemoveDomainDetails <optional>
 Available if .tag is domain_verification_remove_domain_details.
enabled_domain_invites_details TeamLogEnabledDomainInvitesDetails <optional>
 Available if .tag is enabled_domain_invites_details.
apply_naming_convention_details TeamLogApplyNamingConventionDetails <optional>
 Available if .tag is apply_naming_convention_details.
create_folder_details TeamLogCreateFolderDetails <optional>
 Available if .tag is create_folder_details.
file_add_details TeamLogFileAddDetails <optional>
 Available if .tag is file_add_details.
file_copy_details TeamLogFileCopyDetails <optional>
 Available if .tag is file_copy_details.
file_delete_details TeamLogFileDeleteDetails <optional>
 Available if .tag is file_delete_details.
file_download_details TeamLogFileDownloadDetails <optional>
 Available if .tag is file_download_details.
file_edit_details TeamLogFileEditDetails <optional>
 Available if .tag is file_edit_details.
file_get_copy_reference_details TeamLogFileGetCopyReferenceDetails <optional>
 Available if .tag is file_get_copy_reference_details.
file_locking_lock_status_changed_details TeamLogFileLockingLockStatusChangedDetails <optional>
 Available if .tag is file_locking_lock_status_changed_details.
file_move_details TeamLogFileMoveDetails <optional>
 Available if .tag is file_move_details.
file_permanently_delete_details TeamLogFilePermanentlyDeleteDetails <optional>
 Available if .tag is file_permanently_delete_details.
file_preview_details TeamLogFilePreviewDetails <optional>
 Available if .tag is file_preview_details.
file_rename_details TeamLogFileRenameDetails <optional>
 Available if .tag is file_rename_details.
file_restore_details TeamLogFileRestoreDetails <optional>
 Available if .tag is file_restore_details.
file_revert_details TeamLogFileRevertDetails <optional>
 Available if .tag is file_revert_details.
file_rollback_changes_details TeamLogFileRollbackChangesDetails <optional>
 - Available if .tag is file_rollback_changes_details.
file_save_copy_reference_details TeamLogFileSaveCopyReferenceDetails <optional>
 Available if .tag is file_save_copy_reference_details.
folder_overview_description_changed_details TeamLogFolderOverviewDescriptionChangedDetails <optional>
 Available if .tag is folder_overview_description_changed_details.
folder_overview_item_pinned_details TeamLogFolderOverviewItemPinnedDetails <optional>
 Available if .tag is folder_overview_item_pinned_details.
folder_overview_item_unpinned_details TeamLogFolderOverviewItemUnpinnedDetails <optional>
 Available if .tag is folder_overview_item_unpinned_details.
object_label_added_details TeamLogObjectLabelAddedDetails <optional>
 Available if .tag is object_label_added_details.
object_label_removed_details TeamLogObjectLabelRemovedDetails <optional>
 Available if .tag is object_label_removed_details.
object_label_updated_value_details TeamLogObjectLabelUpdatedValueDetails <optional>
 Available if .tag is object_label_updated_value_details.
organize_folder_with_tidy_details TeamLogOrganizeFolderWithTidyDetails <optional>
 Available if .tag is organize_folder_with_tidy_details.
rewind_folder_details TeamLogRewindFolderDetails <optional>
 Available if .tag is rewind_folder_details.
undo_naming_convention_details TeamLogUndoNamingConventionDetails <optional>
 Available if .tag is undo_naming_convention_details.
undo_organize_folder_with_tidy_details TeamLogUndoOrganizeFolderWithTidyDetails <optional>
 Available if .tag is undo_organize_folder_with_tidy_details.
user_tags_added_details TeamLogUserTagsAddedDetails <optional>
 Available if .tag is user_tags_added_details.
user_tags_removed_details TeamLogUserTagsRemovedDetails <optional>
 Available if .tag is user_tags_removed_details.
email_ingest_receive_file_details TeamLogEmailIngestReceiveFileDetails <optional>
 Available if .tag is email_ingest_receive_file_details.
file_request_change_details TeamLogFileRequestChangeDetails <optional>
 Available if .tag is file_request_change_details.
file_request_close_details TeamLogFileRequestCloseDetails <optional>
 Available if .tag is file_request_close_details.
file_request_create_details TeamLogFileRequestCreateDetails <optional>
 Available if .tag is file_request_create_details.
file_request_delete_details TeamLogFileRequestDeleteDetails <optional>
 Available if .tag is file_request_delete_details.
file_request_receive_file_details TeamLogFileRequestReceiveFileDetails <optional>
 Available if .tag is file_request_receive_file_details.
group_add_external_id_details TeamLogGroupAddExternalIdDetails <optional>
 - Available if .tag is group_add_external_id_details.
group_add_member_details TeamLogGroupAddMemberDetails <optional>
 Available if .tag is group_add_member_details.
group_change_external_id_details TeamLogGroupChangeExternalIdDetails <optional>
 Available if .tag is group_change_external_id_details.
group_change_management_type_details TeamLogGroupChangeManagementTypeDetails <optional>
 Available if .tag is group_change_management_type_details.
group_change_member_role_details TeamLogGroupChangeMemberRoleDetails <optional>
 Available if .tag is group_change_member_role_details.
group_create_details TeamLogGroupCreateDetails <optional>
 Available if .tag is group_create_details.
group_delete_details TeamLogGroupDeleteDetails <optional>
 Available if .tag is group_delete_details.
group_description_updated_details TeamLogGroupDescriptionUpdatedDetails <optional>
 Available if .tag is group_description_updated_details.
group_join_policy_updated_details TeamLogGroupJoinPolicyUpdatedDetails <optional>
 Available if .tag is group_join_policy_updated_details.
group_moved_details TeamLogGroupMovedDetails <optional>
 Available if .tag is group_moved_details.
group_remove_external_id_details TeamLogGroupRemoveExternalIdDetails <optional>
 Available if .tag is group_remove_external_id_details.
group_remove_member_details TeamLogGroupRemoveMemberDetails <optional>
 Available if .tag is group_remove_member_details.
group_rename_details TeamLogGroupRenameDetails <optional>
 Available if .tag is group_rename_details.
account_lock_or_unlocked_details TeamLogAccountLockOrUnlockedDetails <optional>
 Available if .tag is account_lock_or_unlocked_details.
emm_error_details TeamLogEmmErrorDetails <optional>
 Available if .tag is emm_error_details.
guest_admin_signed_in_via_trusted_teams_details TeamLogGuestAdminSignedInViaTrustedTeamsDetails <optional>
 Available if .tag is guest_admin_signed_in_via_trusted_teams_details.
guest_admin_signed_out_via_trusted_teams_details TeamLogGuestAdminSignedOutViaTrustedTeamsDetails <optional>
 Available if .tag is guest_admin_signed_out_via_trusted_teams_details.
login_fail_details TeamLogLoginFailDetails <optional>
 Available if .tag is login_fail_details.
login_success_details TeamLogLoginSuccessDetails <optional>
 Available if .tag is login_success_details.
logout_details TeamLogLogoutDetails <optional>
 Available if .tag is logout_details.
reseller_support_session_end_details TeamLogResellerSupportSessionEndDetails <optional>
 Available if .tag is reseller_support_session_end_details.
reseller_support_session_start_details TeamLogResellerSupportSessionStartDetails <optional>
 Available if .tag is reseller_support_session_start_details.
sign_in_as_session_end_details TeamLogSignInAsSessionEndDetails <optional>
 - Available if .tag is sign_in_as_session_end_details.
sign_in_as_session_start_details TeamLogSignInAsSessionStartDetails <optional>
 Available if .tag is sign_in_as_session_start_details.
sso_error_details TeamLogSsoErrorDetails <optional>
 Available if .tag is sso_error_details.
create_team_invite_link_details TeamLogCreateTeamInviteLinkDetails <optional>
 Available if .tag is create_team_invite_link_details.
delete_team_invite_link_details TeamLogDeleteTeamInviteLinkDetails <optional>
 Available if .tag is delete_team_invite_link_details.
member_add_external_id_details TeamLogMemberAddExternalIdDetails <optional>
 Available if .tag is member_add_external_id_details.
member_add_name_details TeamLogMemberAddNameDetails <optional>
 Available if .tag is member_add_name_details.
member_change_admin_role_details TeamLogMemberChangeAdminRoleDetails <optional>
 Available if .tag is member_change_admin_role_details.
member_change_email_details TeamLogMemberChangeEmailDetails <optional>
 Available if .tag is member_change_email_details.
member_change_external_id_details TeamLogMemberChangeExternalIdDetails <optional>
 Available if .tag is member_change_external_id_details.
member_change_membership_type_details TeamLogMemberChangeMembershipTypeDetails <optional>
 Available if .tag is member_change_membership_type_details.
member_change_name_details TeamLogMemberChangeNameDetails <optional>
 Available if .tag is member_change_name_details.
member_change_reseller_role_details TeamLogMemberChangeResellerRoleDetails <optional>
 Available if .tag is member_change_reseller_role_details.
member_change_status_details TeamLogMemberChangeStatusDetails <optional>
 Available if .tag is member_change_status_details.
member_delete_manual_contacts_details TeamLogMemberDeleteManualContactsDetails <optional>
 Available if .tag is member_delete_manual_contacts_details.
member_delete_profile_photo_details TeamLogMemberDeleteProfilePhotoDetails <optional>
 Available if .tag is member_delete_profile_photo_details.
member_permanently_delete_account_contents_details TeamLogMemberPermanentlyDeleteAccountContentsDetails <optional>
 Available if .tag is member_permanently_delete_account_contents_details.
member_remove_external_id_details TeamLogMemberRemoveExternalIdDetails <optional>
 Available if .tag is member_remove_external_id_details.
member_set_profile_photo_details TeamLogMemberSetProfilePhotoDetails <optional>
 Available if .tag is member_set_profile_photo_details.
member_space_limits_add_custom_quota_details TeamLogMemberSpaceLimitsAddCustomQuotaDetails <optional>
 Available if .tag is member_space_limits_add_custom_quota_details.
member_space_limits_change_custom_quota_details TeamLogMemberSpaceLimitsChangeCustomQuotaDetails <optional>
 Available if .tag is member_space_limits_change_custom_quota_details.
member_space_limits_change_status_details TeamLogMemberSpaceLimitsChangeStatusDetails <optional>
 Available if .tag is member_space_limits_change_status_details.
member_space_limits_remove_custom_quota_details TeamLogMemberSpaceLimitsRemoveCustomQuotaDetails <optional>
 Available if .tag is member_space_limits_remove_custom_quota_details.
member_suggest_details TeamLogMemberSuggestDetails <optional>
 Available if .tag is member_suggest_details.
member_transfer_account_contents_details TeamLogMemberTransferAccountContentsDetails <optional>
 Available if .tag is member_transfer_account_contents_details.
pending_secondary_email_added_details TeamLogPendingSecondaryEmailAddedDetails <optional>
 Available if .tag is pending_secondary_email_added_details.
secondary_email_deleted_details TeamLogSecondaryEmailDeletedDetails <optional>
 Available if .tag is secondary_email_deleted_details.
secondary_email_verified_details TeamLogSecondaryEmailVerifiedDetails <optional>
 Available if .tag is secondary_email_verified_details.
secondary_mails_policy_changed_details TeamLogSecondaryMailsPolicyChangedDetails <optional>
 Available if .tag is secondary_mails_policy_changed_details.
binder_add_page_details TeamLogBinderAddPageDetails <optional>
 Available if .tag is binder_add_page_details.
binder_add_section_details TeamLogBinderAddSectionDetails <optional>
 Available if .tag is binder_add_section_details.
binder_remove_page_details TeamLogBinderRemovePageDetails <optional>
 Available if .tag is binder_remove_page_details.
binder_remove_section_details TeamLogBinderRemoveSectionDetails <optional>
 - Available if .tag is binder_remove_section_details.
binder_rename_page_details TeamLogBinderRenamePageDetails <optional>
 Available if .tag is binder_rename_page_details.
binder_rename_section_details TeamLogBinderRenameSectionDetails <optional>
 - Available if .tag is binder_rename_section_details.
binder_reorder_page_details TeamLogBinderReorderPageDetails <optional>
 Available if .tag is binder_reorder_page_details.
binder_reorder_section_details TeamLogBinderReorderSectionDetails <optional>
 Available if .tag is binder_reorder_section_details.
paper_content_add_member_details TeamLogPaperContentAddMemberDetails <optional>
 Available if .tag is paper_content_add_member_details.
paper_content_add_to_folder_details TeamLogPaperContentAddToFolderDetails <optional>
 Available if .tag is paper_content_add_to_folder_details.
paper_content_archive_details TeamLogPaperContentArchiveDetails <optional>
 - Available if .tag is paper_content_archive_details.
paper_content_create_details TeamLogPaperContentCreateDetails <optional>
 Available if .tag is paper_content_create_details.
paper_content_permanently_delete_details TeamLogPaperContentPermanentlyDeleteDetails <optional>
 Available if .tag is paper_content_permanently_delete_details.
paper_content_remove_from_folder_details TeamLogPaperContentRemoveFromFolderDetails <optional>
 Available if .tag is paper_content_remove_from_folder_details.
paper_content_remove_member_details TeamLogPaperContentRemoveMemberDetails <optional>
 Available if .tag is paper_content_remove_member_details.
paper_content_rename_details TeamLogPaperContentRenameDetails <optional>
 Available if .tag is paper_content_rename_details.
paper_content_restore_details TeamLogPaperContentRestoreDetails <optional>
 - Available if .tag is paper_content_restore_details.
paper_doc_add_comment_details TeamLogPaperDocAddCommentDetails <optional>
 - Available if .tag is paper_doc_add_comment_details.
paper_doc_change_member_role_details TeamLogPaperDocChangeMemberRoleDetails <optional>
 Available if .tag is paper_doc_change_member_role_details.
paper_doc_change_sharing_policy_details TeamLogPaperDocChangeSharingPolicyDetails <optional>
 Available if .tag is paper_doc_change_sharing_policy_details.
paper_doc_change_subscription_details TeamLogPaperDocChangeSubscriptionDetails <optional>
 Available if .tag is paper_doc_change_subscription_details.
paper_doc_deleted_details TeamLogPaperDocDeletedDetails <optional>
 Available if .tag is paper_doc_deleted_details.
paper_doc_delete_comment_details TeamLogPaperDocDeleteCommentDetails <optional>
 Available if .tag is paper_doc_delete_comment_details.
paper_doc_download_details TeamLogPaperDocDownloadDetails <optional>
 Available if .tag is paper_doc_download_details.
paper_doc_edit_details TeamLogPaperDocEditDetails <optional>
 Available if .tag is paper_doc_edit_details.
paper_doc_edit_comment_details TeamLogPaperDocEditCommentDetails <optional>
 Available if .tag is paper_doc_edit_comment_details.
paper_doc_followed_details TeamLogPaperDocFollowedDetails <optional>
 Available if .tag is paper_doc_followed_details.
paper_doc_mention_details TeamLogPaperDocMentionDetails <optional>
 Available if .tag is paper_doc_mention_details.
paper_doc_ownership_changed_details TeamLogPaperDocOwnershipChangedDetails <optional>
 Available if .tag is paper_doc_ownership_changed_details.
paper_doc_request_access_details TeamLogPaperDocRequestAccessDetails <optional>
 Available if .tag is paper_doc_request_access_details.
paper_doc_resolve_comment_details TeamLogPaperDocResolveCommentDetails <optional>
 Available if .tag is paper_doc_resolve_comment_details.
paper_doc_revert_details TeamLogPaperDocRevertDetails <optional>
 Available if .tag is paper_doc_revert_details.
paper_doc_slack_share_details TeamLogPaperDocSlackShareDetails <optional>
 - Available if .tag is paper_doc_slack_share_details.
paper_doc_team_invite_details TeamLogPaperDocTeamInviteDetails <optional>
 - Available if .tag is paper_doc_team_invite_details.
paper_doc_trashed_details TeamLogPaperDocTrashedDetails <optional>
 Available if .tag is paper_doc_trashed_details.
paper_doc_unresolve_comment_details TeamLogPaperDocUnresolveCommentDetails <optional>
 Available if .tag is paper_doc_unresolve_comment_details.
paper_doc_untrashed_details TeamLogPaperDocUntrashedDetails <optional>
 Available if .tag is paper_doc_untrashed_details.
paper_doc_view_details TeamLogPaperDocViewDetails <optional>
 Available if .tag is paper_doc_view_details.
paper_external_view_allow_details TeamLogPaperExternalViewAllowDetails <optional>
 Available if .tag is paper_external_view_allow_details.
paper_external_view_default_team_details TeamLogPaperExternalViewDefaultTeamDetails <optional>
 Available if .tag is paper_external_view_default_team_details.
paper_external_view_forbid_details TeamLogPaperExternalViewForbidDetails <optional>
 Available if .tag is paper_external_view_forbid_details.
paper_folder_change_subscription_details TeamLogPaperFolderChangeSubscriptionDetails <optional>
 Available if .tag is paper_folder_change_subscription_details.
paper_folder_deleted_details TeamLogPaperFolderDeletedDetails <optional>
 Available if .tag is paper_folder_deleted_details.
paper_folder_followed_details TeamLogPaperFolderFollowedDetails <optional>
 - Available if .tag is paper_folder_followed_details.
paper_folder_team_invite_details TeamLogPaperFolderTeamInviteDetails <optional>
 Available if .tag is paper_folder_team_invite_details.
paper_published_link_change_permission_details TeamLogPaperPublishedLinkChangePermissionDetails <optional>
 Available if .tag is paper_published_link_change_permission_details.
paper_published_link_create_details TeamLogPaperPublishedLinkCreateDetails <optional>
 Available if .tag is paper_published_link_create_details.
paper_published_link_disabled_details TeamLogPaperPublishedLinkDisabledDetails <optional>
 Available if .tag is paper_published_link_disabled_details.
paper_published_link_view_details TeamLogPaperPublishedLinkViewDetails <optional>
 Available if .tag is paper_published_link_view_details.
password_change_details TeamLogPasswordChangeDetails <optional>
 Available if .tag is password_change_details.
password_reset_details TeamLogPasswordResetDetails <optional>
 Available if .tag is password_reset_details.
password_reset_all_details TeamLogPasswordResetAllDetails <optional>
 Available if .tag is password_reset_all_details.
classification_create_report_details TeamLogClassificationCreateReportDetails <optional>
 Available if .tag is classification_create_report_details.
classification_create_report_fail_details TeamLogClassificationCreateReportFailDetails <optional>
 Available if .tag is classification_create_report_fail_details.
emm_create_exceptions_report_details TeamLogEmmCreateExceptionsReportDetails <optional>
 Available if .tag is emm_create_exceptions_report_details.
emm_create_usage_report_details TeamLogEmmCreateUsageReportDetails <optional>
 Available if .tag is emm_create_usage_report_details.
export_members_report_details TeamLogExportMembersReportDetails <optional>
 - Available if .tag is export_members_report_details.
export_members_report_fail_details TeamLogExportMembersReportFailDetails <optional>
 Available if .tag is export_members_report_fail_details.
external_sharing_create_report_details TeamLogExternalSharingCreateReportDetails <optional>
 Available if .tag is external_sharing_create_report_details.
external_sharing_report_failed_details TeamLogExternalSharingReportFailedDetails <optional>
 Available if .tag is external_sharing_report_failed_details.
no_expiration_link_gen_create_report_details TeamLogNoExpirationLinkGenCreateReportDetails <optional>
 Available if .tag is no_expiration_link_gen_create_report_details.
no_expiration_link_gen_report_failed_details TeamLogNoExpirationLinkGenReportFailedDetails <optional>
 Available if .tag is no_expiration_link_gen_report_failed_details.
no_password_link_gen_create_report_details TeamLogNoPasswordLinkGenCreateReportDetails <optional>
 Available if .tag is no_password_link_gen_create_report_details.
no_password_link_gen_report_failed_details TeamLogNoPasswordLinkGenReportFailedDetails <optional>
 Available if .tag is no_password_link_gen_report_failed_details.
no_password_link_view_create_report_details TeamLogNoPasswordLinkViewCreateReportDetails <optional>
 Available if .tag is no_password_link_view_create_report_details.
no_password_link_view_report_failed_details TeamLogNoPasswordLinkViewReportFailedDetails <optional>
 Available if .tag is no_password_link_view_report_failed_details.
outdated_link_view_create_report_details TeamLogOutdatedLinkViewCreateReportDetails <optional>
 Available if .tag is outdated_link_view_create_report_details.
outdated_link_view_report_failed_details TeamLogOutdatedLinkViewReportFailedDetails <optional>
 Available if .tag is outdated_link_view_report_failed_details.
paper_admin_export_start_details TeamLogPaperAdminExportStartDetails <optional>
 Available if .tag is paper_admin_export_start_details.
smart_sync_create_admin_privilege_report_details TeamLogSmartSyncCreateAdminPrivilegeReportDetails <optional>
 Available if .tag is smart_sync_create_admin_privilege_report_details.
team_activity_create_report_details TeamLogTeamActivityCreateReportDetails <optional>
 Available if .tag is team_activity_create_report_details.
team_activity_create_report_fail_details TeamLogTeamActivityCreateReportFailDetails <optional>
 Available if .tag is team_activity_create_report_fail_details.
collection_share_details TeamLogCollectionShareDetails <optional>
 Available if .tag is collection_share_details.
file_transfers_file_add_details TeamLogFileTransfersFileAddDetails <optional>
 Available if .tag is file_transfers_file_add_details.
file_transfers_transfer_delete_details TeamLogFileTransfersTransferDeleteDetails <optional>
 Available if .tag is file_transfers_transfer_delete_details.
file_transfers_transfer_download_details TeamLogFileTransfersTransferDownloadDetails <optional>
 Available if .tag is file_transfers_transfer_download_details.
file_transfers_transfer_send_details TeamLogFileTransfersTransferSendDetails <optional>
 Available if .tag is file_transfers_transfer_send_details.
file_transfers_transfer_view_details TeamLogFileTransfersTransferViewDetails <optional>
 Available if .tag is file_transfers_transfer_view_details.
note_acl_invite_only_details TeamLogNoteAclInviteOnlyDetails <optional>
 Available if .tag is note_acl_invite_only_details.
note_acl_link_details TeamLogNoteAclLinkDetails <optional>
 Available if .tag is note_acl_link_details.
note_acl_team_link_details TeamLogNoteAclTeamLinkDetails <optional>
 Available if .tag is note_acl_team_link_details.
note_shared_details TeamLogNoteSharedDetails <optional>
 Available if .tag is note_shared_details.
note_share_receive_details TeamLogNoteShareReceiveDetails <optional>
 Available if .tag is note_share_receive_details.
open_note_shared_details TeamLogOpenNoteSharedDetails <optional>
 Available if .tag is open_note_shared_details.
sf_add_group_details TeamLogSfAddGroupDetails <optional>
 Available if .tag is sf_add_group_details.
sf_allow_non_members_to_view_shared_links_details TeamLogSfAllowNonMembersToViewSharedLinksDetails <optional>
 Available if .tag is sf_allow_non_members_to_view_shared_links_details.
sf_external_invite_warn_details TeamLogSfExternalInviteWarnDetails <optional>
 Available if .tag is sf_external_invite_warn_details.
sf_fb_invite_details TeamLogSfFbInviteDetails <optional>
 Available if .tag is sf_fb_invite_details.
sf_fb_invite_change_role_details TeamLogSfFbInviteChangeRoleDetails <optional>
 Available if .tag is sf_fb_invite_change_role_details.
sf_fb_uninvite_details TeamLogSfFbUninviteDetails <optional>
 Available if .tag is sf_fb_uninvite_details.
sf_invite_group_details TeamLogSfInviteGroupDetails <optional>
 Available if .tag is sf_invite_group_details.
sf_team_grant_access_details TeamLogSfTeamGrantAccessDetails <optional>
 Available if .tag is sf_team_grant_access_details.
sf_team_invite_details TeamLogSfTeamInviteDetails <optional>
 Available if .tag is sf_team_invite_details.
sf_team_invite_change_role_details TeamLogSfTeamInviteChangeRoleDetails <optional>
 Available if .tag is sf_team_invite_change_role_details.
sf_team_join_details TeamLogSfTeamJoinDetails <optional>
 Available if .tag is sf_team_join_details.
sf_team_join_from_oob_link_details TeamLogSfTeamJoinFromOobLinkDetails <optional>
 Available if .tag is sf_team_join_from_oob_link_details.
sf_team_uninvite_details TeamLogSfTeamUninviteDetails <optional>
 Available if .tag is sf_team_uninvite_details.
shared_content_add_invitees_details TeamLogSharedContentAddInviteesDetails <optional>
 Available if .tag is shared_content_add_invitees_details.
shared_content_add_link_expiry_details TeamLogSharedContentAddLinkExpiryDetails <optional>
 Available if .tag is shared_content_add_link_expiry_details.
shared_content_add_link_password_details TeamLogSharedContentAddLinkPasswordDetails <optional>
 Available if .tag is shared_content_add_link_password_details.
shared_content_add_member_details TeamLogSharedContentAddMemberDetails <optional>
 Available if .tag is shared_content_add_member_details.
shared_content_change_downloads_policy_details TeamLogSharedContentChangeDownloadsPolicyDetails <optional>
 Available if .tag is shared_content_change_downloads_policy_details.
shared_content_change_invitee_role_details TeamLogSharedContentChangeInviteeRoleDetails <optional>
 Available if .tag is shared_content_change_invitee_role_details.
shared_content_change_link_audience_details TeamLogSharedContentChangeLinkAudienceDetails <optional>
 Available if .tag is shared_content_change_link_audience_details.
shared_content_change_link_expiry_details TeamLogSharedContentChangeLinkExpiryDetails <optional>
 Available if .tag is shared_content_change_link_expiry_details.
shared_content_change_link_password_details TeamLogSharedContentChangeLinkPasswordDetails <optional>
 Available if .tag is shared_content_change_link_password_details.
shared_content_change_member_role_details TeamLogSharedContentChangeMemberRoleDetails <optional>
 Available if .tag is shared_content_change_member_role_details.
shared_content_change_viewer_info_policy_details TeamLogSharedContentChangeViewerInfoPolicyDetails <optional>
 Available if .tag is shared_content_change_viewer_info_policy_details.
shared_content_claim_invitation_details TeamLogSharedContentClaimInvitationDetails <optional>
 Available if .tag is shared_content_claim_invitation_details.
shared_content_copy_details TeamLogSharedContentCopyDetails <optional>
 Available if .tag is shared_content_copy_details.
shared_content_download_details TeamLogSharedContentDownloadDetails <optional>
 Available if .tag is shared_content_download_details.
shared_content_relinquish_membership_details TeamLogSharedContentRelinquishMembershipDetails <optional>
 Available if .tag is shared_content_relinquish_membership_details.
shared_content_remove_invitees_details TeamLogSharedContentRemoveInviteesDetails <optional>
 Available if .tag is shared_content_remove_invitees_details.
shared_content_remove_link_expiry_details TeamLogSharedContentRemoveLinkExpiryDetails <optional>
 Available if .tag is shared_content_remove_link_expiry_details.
shared_content_remove_link_password_details TeamLogSharedContentRemoveLinkPasswordDetails <optional>
 Available if .tag is shared_content_remove_link_password_details.
shared_content_remove_member_details TeamLogSharedContentRemoveMemberDetails <optional>
 Available if .tag is shared_content_remove_member_details.
shared_content_request_access_details TeamLogSharedContentRequestAccessDetails <optional>
 Available if .tag is shared_content_request_access_details.
shared_content_restore_invitees_details TeamLogSharedContentRestoreInviteesDetails <optional>
 Available if .tag is shared_content_restore_invitees_details.
shared_content_restore_member_details TeamLogSharedContentRestoreMemberDetails <optional>
 Available if .tag is shared_content_restore_member_details.
shared_content_unshare_details TeamLogSharedContentUnshareDetails <optional>
 Available if .tag is shared_content_unshare_details.
shared_content_view_details TeamLogSharedContentViewDetails <optional>
 Available if .tag is shared_content_view_details.
shared_folder_change_link_policy_details TeamLogSharedFolderChangeLinkPolicyDetails <optional>
 Available if .tag is shared_folder_change_link_policy_details.
shared_folder_change_members_inheritance_policy_details TeamLogSharedFolderChangeMembersInheritancePolicyDetails <optional>
 Available if .tag is shared_folder_change_members_inheritance_policy_details.
shared_folder_change_members_management_policy_details TeamLogSharedFolderChangeMembersManagementPolicyDetails <optional>
 Available if .tag is shared_folder_change_members_management_policy_details.
shared_folder_change_members_policy_details TeamLogSharedFolderChangeMembersPolicyDetails <optional>
 Available if .tag is shared_folder_change_members_policy_details.
shared_folder_create_details TeamLogSharedFolderCreateDetails <optional>
 Available if .tag is shared_folder_create_details.
shared_folder_decline_invitation_details TeamLogSharedFolderDeclineInvitationDetails <optional>
 Available if .tag is shared_folder_decline_invitation_details.
shared_folder_mount_details TeamLogSharedFolderMountDetails <optional>
 Available if .tag is shared_folder_mount_details.
shared_folder_nest_details TeamLogSharedFolderNestDetails <optional>
 Available if .tag is shared_folder_nest_details.
shared_folder_transfer_ownership_details TeamLogSharedFolderTransferOwnershipDetails <optional>
 Available if .tag is shared_folder_transfer_ownership_details.
shared_folder_unmount_details TeamLogSharedFolderUnmountDetails <optional>
 - Available if .tag is shared_folder_unmount_details.
shared_link_add_expiry_details TeamLogSharedLinkAddExpiryDetails <optional>
 Available if .tag is shared_link_add_expiry_details.
shared_link_change_expiry_details TeamLogSharedLinkChangeExpiryDetails <optional>
 Available if .tag is shared_link_change_expiry_details.
shared_link_change_visibility_details TeamLogSharedLinkChangeVisibilityDetails <optional>
 Available if .tag is shared_link_change_visibility_details.
shared_link_copy_details TeamLogSharedLinkCopyDetails <optional>
 Available if .tag is shared_link_copy_details.
shared_link_create_details TeamLogSharedLinkCreateDetails <optional>
 Available if .tag is shared_link_create_details.
shared_link_disable_details TeamLogSharedLinkDisableDetails <optional>
 Available if .tag is shared_link_disable_details.
shared_link_download_details TeamLogSharedLinkDownloadDetails <optional>
 Available if .tag is shared_link_download_details.
shared_link_remove_expiry_details TeamLogSharedLinkRemoveExpiryDetails <optional>
 Available if .tag is shared_link_remove_expiry_details.
shared_link_settings_add_expiration_details TeamLogSharedLinkSettingsAddExpirationDetails <optional>
 Available if .tag is shared_link_settings_add_expiration_details.
shared_link_settings_add_password_details TeamLogSharedLinkSettingsAddPasswordDetails <optional>
 Available if .tag is shared_link_settings_add_password_details.
shared_link_settings_allow_download_disabled_details TeamLogSharedLinkSettingsAllowDownloadDisabledDetails <optional>
 Available if .tag is shared_link_settings_allow_download_disabled_details.
shared_link_settings_allow_download_enabled_details TeamLogSharedLinkSettingsAllowDownloadEnabledDetails <optional>
 Available if .tag is shared_link_settings_allow_download_enabled_details.
shared_link_settings_change_audience_details TeamLogSharedLinkSettingsChangeAudienceDetails <optional>
 Available if .tag is shared_link_settings_change_audience_details.
shared_link_settings_change_expiration_details TeamLogSharedLinkSettingsChangeExpirationDetails <optional>
 Available if .tag is shared_link_settings_change_expiration_details.
shared_link_settings_change_password_details TeamLogSharedLinkSettingsChangePasswordDetails <optional>
 Available if .tag is shared_link_settings_change_password_details.
shared_link_settings_remove_expiration_details TeamLogSharedLinkSettingsRemoveExpirationDetails <optional>
 Available if .tag is shared_link_settings_remove_expiration_details.
shared_link_settings_remove_password_details TeamLogSharedLinkSettingsRemovePasswordDetails <optional>
 Available if .tag is shared_link_settings_remove_password_details.
shared_link_share_details TeamLogSharedLinkShareDetails <optional>
 Available if .tag is shared_link_share_details.
shared_link_view_details TeamLogSharedLinkViewDetails <optional>
 Available if .tag is shared_link_view_details.
shared_note_opened_details TeamLogSharedNoteOpenedDetails <optional>
 Available if .tag is shared_note_opened_details.
shmodel_disable_downloads_details TeamLogShmodelDisableDownloadsDetails <optional>
 Available if .tag is shmodel_disable_downloads_details.
shmodel_enable_downloads_details TeamLogShmodelEnableDownloadsDetails <optional>
 Available if .tag is shmodel_enable_downloads_details.
shmodel_group_share_details TeamLogShmodelGroupShareDetails <optional>
 Available if .tag is shmodel_group_share_details.
showcase_access_granted_details TeamLogShowcaseAccessGrantedDetails <optional>
 Available if .tag is showcase_access_granted_details.
showcase_add_member_details TeamLogShowcaseAddMemberDetails <optional>
 Available if .tag is showcase_add_member_details.
showcase_archived_details TeamLogShowcaseArchivedDetails <optional>
 Available if .tag is showcase_archived_details.
showcase_created_details TeamLogShowcaseCreatedDetails <optional>
 Available if .tag is showcase_created_details.
showcase_delete_comment_details TeamLogShowcaseDeleteCommentDetails <optional>
 Available if .tag is showcase_delete_comment_details.
showcase_edited_details TeamLogShowcaseEditedDetails <optional>
 Available if .tag is showcase_edited_details.
showcase_edit_comment_details TeamLogShowcaseEditCommentDetails <optional>
 - Available if .tag is showcase_edit_comment_details.
showcase_file_added_details TeamLogShowcaseFileAddedDetails <optional>
 Available if .tag is showcase_file_added_details.
showcase_file_download_details TeamLogShowcaseFileDownloadDetails <optional>
 Available if .tag is showcase_file_download_details.
showcase_file_removed_details TeamLogShowcaseFileRemovedDetails <optional>
 - Available if .tag is showcase_file_removed_details.
showcase_file_view_details TeamLogShowcaseFileViewDetails <optional>
 Available if .tag is showcase_file_view_details.
showcase_permanently_deleted_details TeamLogShowcasePermanentlyDeletedDetails <optional>
 Available if .tag is showcase_permanently_deleted_details.
showcase_post_comment_details TeamLogShowcasePostCommentDetails <optional>
 - Available if .tag is showcase_post_comment_details.
showcase_remove_member_details TeamLogShowcaseRemoveMemberDetails <optional>
 Available if .tag is showcase_remove_member_details.
showcase_renamed_details TeamLogShowcaseRenamedDetails <optional>
 Available if .tag is showcase_renamed_details.
showcase_request_access_details TeamLogShowcaseRequestAccessDetails <optional>
 Available if .tag is showcase_request_access_details.
showcase_resolve_comment_details TeamLogShowcaseResolveCommentDetails <optional>
 Available if .tag is showcase_resolve_comment_details.
showcase_restored_details TeamLogShowcaseRestoredDetails <optional>
 Available if .tag is showcase_restored_details.
showcase_trashed_details TeamLogShowcaseTrashedDetails <optional>
 Available if .tag is showcase_trashed_details.
showcase_trashed_deprecated_details TeamLogShowcaseTrashedDeprecatedDetails <optional>
 Available if .tag is showcase_trashed_deprecated_details.
showcase_unresolve_comment_details TeamLogShowcaseUnresolveCommentDetails <optional>
 Available if .tag is showcase_unresolve_comment_details.
showcase_untrashed_details TeamLogShowcaseUntrashedDetails <optional>
 Available if .tag is showcase_untrashed_details.
showcase_untrashed_deprecated_details TeamLogShowcaseUntrashedDeprecatedDetails <optional>
 Available if .tag is showcase_untrashed_deprecated_details.
showcase_view_details TeamLogShowcaseViewDetails <optional>
 Available if .tag is showcase_view_details.
sso_add_cert_details TeamLogSsoAddCertDetails <optional>
 Available if .tag is sso_add_cert_details.
sso_add_login_url_details TeamLogSsoAddLoginUrlDetails <optional>
 Available if .tag is sso_add_login_url_details.
sso_add_logout_url_details TeamLogSsoAddLogoutUrlDetails <optional>
 Available if .tag is sso_add_logout_url_details.
sso_change_cert_details TeamLogSsoChangeCertDetails <optional>
 Available if .tag is sso_change_cert_details.
sso_change_login_url_details TeamLogSsoChangeLoginUrlDetails <optional>
 Available if .tag is sso_change_login_url_details.
sso_change_logout_url_details TeamLogSsoChangeLogoutUrlDetails <optional>
 - Available if .tag is sso_change_logout_url_details.
sso_change_saml_identity_mode_details TeamLogSsoChangeSamlIdentityModeDetails <optional>
 Available if .tag is sso_change_saml_identity_mode_details.
sso_remove_cert_details TeamLogSsoRemoveCertDetails <optional>
 Available if .tag is sso_remove_cert_details.
sso_remove_login_url_details TeamLogSsoRemoveLoginUrlDetails <optional>
 Available if .tag is sso_remove_login_url_details.
sso_remove_logout_url_details TeamLogSsoRemoveLogoutUrlDetails <optional>
 - Available if .tag is sso_remove_logout_url_details.
team_folder_change_status_details TeamLogTeamFolderChangeStatusDetails <optional>
 Available if .tag is team_folder_change_status_details.
team_folder_create_details TeamLogTeamFolderCreateDetails <optional>
 Available if .tag is team_folder_create_details.
team_folder_downgrade_details TeamLogTeamFolderDowngradeDetails <optional>
 - Available if .tag is team_folder_downgrade_details.
team_folder_permanently_delete_details TeamLogTeamFolderPermanentlyDeleteDetails <optional>
 Available if .tag is team_folder_permanently_delete_details.
team_folder_rename_details TeamLogTeamFolderRenameDetails <optional>
 Available if .tag is team_folder_rename_details.
team_selective_sync_settings_changed_details TeamLogTeamSelectiveSyncSettingsChangedDetails <optional>
 Available if .tag is team_selective_sync_settings_changed_details.
account_capture_change_policy_details TeamLogAccountCaptureChangePolicyDetails <optional>
 Available if .tag is account_capture_change_policy_details.
admin_email_reminders_changed_details TeamLogAdminEmailRemindersChangedDetails <optional>
 Available if .tag is admin_email_reminders_changed_details.
allow_download_disabled_details TeamLogAllowDownloadDisabledDetails <optional>
 Available if .tag is allow_download_disabled_details.
allow_download_enabled_details TeamLogAllowDownloadEnabledDetails <optional>
 Available if .tag is allow_download_enabled_details.
app_permissions_changed_details TeamLogAppPermissionsChangedDetails <optional>
 Available if .tag is app_permissions_changed_details.
camera_uploads_policy_changed_details TeamLogCameraUploadsPolicyChangedDetails <optional>
 Available if .tag is camera_uploads_policy_changed_details.
capture_transcript_policy_changed_details TeamLogCaptureTranscriptPolicyChangedDetails <optional>
 Available if .tag is capture_transcript_policy_changed_details.
classification_change_policy_details TeamLogClassificationChangePolicyDetails <optional>
 Available if .tag is classification_change_policy_details.
computer_backup_policy_changed_details TeamLogComputerBackupPolicyChangedDetails <optional>
 Available if .tag is computer_backup_policy_changed_details.
content_administration_policy_changed_details TeamLogContentAdministrationPolicyChangedDetails <optional>
 Available if .tag is content_administration_policy_changed_details.
data_placement_restriction_change_policy_details TeamLogDataPlacementRestrictionChangePolicyDetails <optional>
 Available if .tag is data_placement_restriction_change_policy_details.
data_placement_restriction_satisfy_policy_details TeamLogDataPlacementRestrictionSatisfyPolicyDetails <optional>
 Available if .tag is data_placement_restriction_satisfy_policy_details.
device_approvals_add_exception_details TeamLogDeviceApprovalsAddExceptionDetails <optional>
 Available if .tag is device_approvals_add_exception_details.
device_approvals_change_desktop_policy_details TeamLogDeviceApprovalsChangeDesktopPolicyDetails <optional>
 Available if .tag is device_approvals_change_desktop_policy_details.
device_approvals_change_mobile_policy_details TeamLogDeviceApprovalsChangeMobilePolicyDetails <optional>
 Available if .tag is device_approvals_change_mobile_policy_details.
device_approvals_change_overage_action_details TeamLogDeviceApprovalsChangeOverageActionDetails <optional>
 Available if .tag is device_approvals_change_overage_action_details.
device_approvals_change_unlink_action_details TeamLogDeviceApprovalsChangeUnlinkActionDetails <optional>
 Available if .tag is device_approvals_change_unlink_action_details.
device_approvals_remove_exception_details TeamLogDeviceApprovalsRemoveExceptionDetails <optional>
 Available if .tag is device_approvals_remove_exception_details.
directory_restrictions_add_members_details TeamLogDirectoryRestrictionsAddMembersDetails <optional>
 Available if .tag is directory_restrictions_add_members_details.
directory_restrictions_remove_members_details TeamLogDirectoryRestrictionsRemoveMembersDetails <optional>
 Available if .tag is directory_restrictions_remove_members_details.
dropbox_passwords_policy_changed_details TeamLogDropboxPasswordsPolicyChangedDetails <optional>
 Available if .tag is dropbox_passwords_policy_changed_details.
email_ingest_policy_changed_details TeamLogEmailIngestPolicyChangedDetails <optional>
 Available if .tag is email_ingest_policy_changed_details.
emm_add_exception_details TeamLogEmmAddExceptionDetails <optional>
 Available if .tag is emm_add_exception_details.
emm_change_policy_details TeamLogEmmChangePolicyDetails <optional>
 Available if .tag is emm_change_policy_details.
emm_remove_exception_details TeamLogEmmRemoveExceptionDetails <optional>
 Available if .tag is emm_remove_exception_details.
extended_version_history_change_policy_details TeamLogExtendedVersionHistoryChangePolicyDetails <optional>
 Available if .tag is extended_version_history_change_policy_details.
external_drive_backup_policy_changed_details TeamLogExternalDriveBackupPolicyChangedDetails <optional>
 Available if .tag is external_drive_backup_policy_changed_details.
file_comments_change_policy_details TeamLogFileCommentsChangePolicyDetails <optional>
 Available if .tag is file_comments_change_policy_details.
file_locking_policy_changed_details TeamLogFileLockingPolicyChangedDetails <optional>
 Available if .tag is file_locking_policy_changed_details.
file_provider_migration_policy_changed_details TeamLogFileProviderMigrationPolicyChangedDetails <optional>
 Available if .tag is file_provider_migration_policy_changed_details.
file_requests_change_policy_details TeamLogFileRequestsChangePolicyDetails <optional>
 Available if .tag is file_requests_change_policy_details.
file_requests_emails_enabled_details TeamLogFileRequestsEmailsEnabledDetails <optional>
 Available if .tag is file_requests_emails_enabled_details.
file_requests_emails_restricted_to_team_only_details TeamLogFileRequestsEmailsRestrictedToTeamOnlyDetails <optional>
 Available if .tag is file_requests_emails_restricted_to_team_only_details.
file_transfers_policy_changed_details TeamLogFileTransfersPolicyChangedDetails <optional>
 Available if .tag is file_transfers_policy_changed_details.
folder_link_restriction_policy_changed_details TeamLogFolderLinkRestrictionPolicyChangedDetails <optional>
 Available if .tag is folder_link_restriction_policy_changed_details.
google_sso_change_policy_details TeamLogGoogleSsoChangePolicyDetails <optional>
 Available if .tag is google_sso_change_policy_details.
group_user_management_change_policy_details TeamLogGroupUserManagementChangePolicyDetails <optional>
 Available if .tag is group_user_management_change_policy_details.
integration_policy_changed_details TeamLogIntegrationPolicyChangedDetails <optional>
 Available if .tag is integration_policy_changed_details.
invite_acceptance_email_policy_changed_details TeamLogInviteAcceptanceEmailPolicyChangedDetails <optional>
 Available if .tag is invite_acceptance_email_policy_changed_details.
member_requests_change_policy_details TeamLogMemberRequestsChangePolicyDetails <optional>
 Available if .tag is member_requests_change_policy_details.
member_send_invite_policy_changed_details TeamLogMemberSendInvitePolicyChangedDetails <optional>
 Available if .tag is member_send_invite_policy_changed_details.
member_space_limits_add_exception_details TeamLogMemberSpaceLimitsAddExceptionDetails <optional>
 Available if .tag is member_space_limits_add_exception_details.
member_space_limits_change_caps_type_policy_details TeamLogMemberSpaceLimitsChangeCapsTypePolicyDetails <optional>
 Available if .tag is member_space_limits_change_caps_type_policy_details.
member_space_limits_change_policy_details TeamLogMemberSpaceLimitsChangePolicyDetails <optional>
 Available if .tag is member_space_limits_change_policy_details.
member_space_limits_remove_exception_details TeamLogMemberSpaceLimitsRemoveExceptionDetails <optional>
 Available if .tag is member_space_limits_remove_exception_details.
member_suggestions_change_policy_details TeamLogMemberSuggestionsChangePolicyDetails <optional>
 Available if .tag is member_suggestions_change_policy_details.
microsoft_office_addin_change_policy_details TeamLogMicrosoftOfficeAddinChangePolicyDetails <optional>
 Available if .tag is microsoft_office_addin_change_policy_details.
network_control_change_policy_details TeamLogNetworkControlChangePolicyDetails <optional>
 Available if .tag is network_control_change_policy_details.
paper_change_deployment_policy_details TeamLogPaperChangeDeploymentPolicyDetails <optional>
 Available if .tag is paper_change_deployment_policy_details.
paper_change_member_link_policy_details TeamLogPaperChangeMemberLinkPolicyDetails <optional>
 Available if .tag is paper_change_member_link_policy_details.
paper_change_member_policy_details TeamLogPaperChangeMemberPolicyDetails <optional>
 Available if .tag is paper_change_member_policy_details.
paper_change_policy_details TeamLogPaperChangePolicyDetails <optional>
 Available if .tag is paper_change_policy_details.
paper_default_folder_policy_changed_details TeamLogPaperDefaultFolderPolicyChangedDetails <optional>
 Available if .tag is paper_default_folder_policy_changed_details.
paper_desktop_policy_changed_details TeamLogPaperDesktopPolicyChangedDetails <optional>
 Available if .tag is paper_desktop_policy_changed_details.
paper_enabled_users_group_addition_details TeamLogPaperEnabledUsersGroupAdditionDetails <optional>
 Available if .tag is paper_enabled_users_group_addition_details.
paper_enabled_users_group_removal_details TeamLogPaperEnabledUsersGroupRemovalDetails <optional>
 Available if .tag is paper_enabled_users_group_removal_details.
password_strength_requirements_change_policy_details TeamLogPasswordStrengthRequirementsChangePolicyDetails <optional>
 Available if .tag is password_strength_requirements_change_policy_details.
permanent_delete_change_policy_details TeamLogPermanentDeleteChangePolicyDetails <optional>
 Available if .tag is permanent_delete_change_policy_details.
reseller_support_change_policy_details TeamLogResellerSupportChangePolicyDetails <optional>
 Available if .tag is reseller_support_change_policy_details.
rewind_policy_changed_details TeamLogRewindPolicyChangedDetails <optional>
 - Available if .tag is rewind_policy_changed_details.
send_for_signature_policy_changed_details TeamLogSendForSignaturePolicyChangedDetails <optional>
 Available if .tag is send_for_signature_policy_changed_details.
sharing_change_folder_join_policy_details TeamLogSharingChangeFolderJoinPolicyDetails <optional>
 Available if .tag is sharing_change_folder_join_policy_details.
sharing_change_link_allow_change_expiration_policy_details TeamLogSharingChangeLinkAllowChangeExpirationPolicyDetails <optional>
 Available if .tag is sharing_change_link_allow_change_expiration_policy_details.
sharing_change_link_default_expiration_policy_details TeamLogSharingChangeLinkDefaultExpirationPolicyDetails <optional>
 Available if .tag is sharing_change_link_default_expiration_policy_details.
sharing_change_link_enforce_password_policy_details TeamLogSharingChangeLinkEnforcePasswordPolicyDetails <optional>
 Available if .tag is sharing_change_link_enforce_password_policy_details.
sharing_change_link_policy_details TeamLogSharingChangeLinkPolicyDetails <optional>
 Available if .tag is sharing_change_link_policy_details.
sharing_change_member_policy_details TeamLogSharingChangeMemberPolicyDetails <optional>
 Available if .tag is sharing_change_member_policy_details.
showcase_change_download_policy_details TeamLogShowcaseChangeDownloadPolicyDetails <optional>
 Available if .tag is showcase_change_download_policy_details.
showcase_change_enabled_policy_details TeamLogShowcaseChangeEnabledPolicyDetails <optional>
 Available if .tag is showcase_change_enabled_policy_details.
showcase_change_external_sharing_policy_details TeamLogShowcaseChangeExternalSharingPolicyDetails <optional>
 Available if .tag is showcase_change_external_sharing_policy_details.
smarter_smart_sync_policy_changed_details TeamLogSmarterSmartSyncPolicyChangedDetails <optional>
 Available if .tag is smarter_smart_sync_policy_changed_details.
smart_sync_change_policy_details TeamLogSmartSyncChangePolicyDetails <optional>
 Available if .tag is smart_sync_change_policy_details.
smart_sync_not_opt_out_details TeamLogSmartSyncNotOptOutDetails <optional>
 - Available if .tag is smart_sync_not_opt_out_details.
smart_sync_opt_out_details TeamLogSmartSyncOptOutDetails <optional>
 Available if .tag is smart_sync_opt_out_details.
sso_change_policy_details TeamLogSsoChangePolicyDetails <optional>
 Available if .tag is sso_change_policy_details.
team_branding_policy_changed_details TeamLogTeamBrandingPolicyChangedDetails <optional>
 Available if .tag is team_branding_policy_changed_details.
team_extensions_policy_changed_details TeamLogTeamExtensionsPolicyChangedDetails <optional>
 Available if .tag is team_extensions_policy_changed_details.
team_selective_sync_policy_changed_details TeamLogTeamSelectiveSyncPolicyChangedDetails <optional>
 Available if .tag is team_selective_sync_policy_changed_details.
team_sharing_whitelist_subjects_changed_details TeamLogTeamSharingWhitelistSubjectsChangedDetails <optional>
 Available if .tag is team_sharing_whitelist_subjects_changed_details.
tfa_add_exception_details TeamLogTfaAddExceptionDetails <optional>
 Available if .tag is tfa_add_exception_details.
tfa_change_policy_details TeamLogTfaChangePolicyDetails <optional>
 Available if .tag is tfa_change_policy_details.
tfa_remove_exception_details TeamLogTfaRemoveExceptionDetails <optional>
 Available if .tag is tfa_remove_exception_details.
two_account_change_policy_details TeamLogTwoAccountChangePolicyDetails <optional>
 Available if .tag is two_account_change_policy_details.
viewer_info_policy_changed_details TeamLogViewerInfoPolicyChangedDetails <optional>
 Available if .tag is viewer_info_policy_changed_details.
watermarking_policy_changed_details TeamLogWatermarkingPolicyChangedDetails <optional>
 Available if .tag is watermarking_policy_changed_details.
web_sessions_change_active_session_limit_details TeamLogWebSessionsChangeActiveSessionLimitDetails <optional>
 Available if .tag is web_sessions_change_active_session_limit_details.
web_sessions_change_fixed_length_policy_details TeamLogWebSessionsChangeFixedLengthPolicyDetails <optional>
 Available if .tag is web_sessions_change_fixed_length_policy_details.
web_sessions_change_idle_length_policy_details TeamLogWebSessionsChangeIdleLengthPolicyDetails <optional>
 Available if .tag is web_sessions_change_idle_length_policy_details.
data_residency_migration_request_successful_details TeamLogDataResidencyMigrationRequestSuccessfulDetails <optional>
 Available if .tag is data_residency_migration_request_successful_details.
data_residency_migration_request_unsuccessful_details TeamLogDataResidencyMigrationRequestUnsuccessfulDetails <optional>
 Available if .tag is data_residency_migration_request_unsuccessful_details.
team_merge_from_details TeamLogTeamMergeFromDetails <optional>
 Available if .tag is team_merge_from_details.
team_merge_to_details TeamLogTeamMergeToDetails <optional>
 Available if .tag is team_merge_to_details.
team_profile_add_background_details TeamLogTeamProfileAddBackgroundDetails <optional>
 Available if .tag is team_profile_add_background_details.
team_profile_add_logo_details TeamLogTeamProfileAddLogoDetails <optional>
 - Available if .tag is team_profile_add_logo_details.
team_profile_change_background_details TeamLogTeamProfileChangeBackgroundDetails <optional>
 Available if .tag is team_profile_change_background_details.
team_profile_change_default_language_details TeamLogTeamProfileChangeDefaultLanguageDetails <optional>
 Available if .tag is team_profile_change_default_language_details.
team_profile_change_logo_details TeamLogTeamProfileChangeLogoDetails <optional>
 Available if .tag is team_profile_change_logo_details.
team_profile_change_name_details TeamLogTeamProfileChangeNameDetails <optional>
 Available if .tag is team_profile_change_name_details.
team_profile_remove_background_details TeamLogTeamProfileRemoveBackgroundDetails <optional>
 Available if .tag is team_profile_remove_background_details.
team_profile_remove_logo_details TeamLogTeamProfileRemoveLogoDetails <optional>
 Available if .tag is team_profile_remove_logo_details.
tfa_add_backup_phone_details TeamLogTfaAddBackupPhoneDetails <optional>
 Available if .tag is tfa_add_backup_phone_details.
tfa_add_security_key_details TeamLogTfaAddSecurityKeyDetails <optional>
 Available if .tag is tfa_add_security_key_details.
tfa_change_backup_phone_details TeamLogTfaChangeBackupPhoneDetails <optional>
 Available if .tag is tfa_change_backup_phone_details.
tfa_change_status_details TeamLogTfaChangeStatusDetails <optional>
 Available if .tag is tfa_change_status_details.
tfa_remove_backup_phone_details TeamLogTfaRemoveBackupPhoneDetails <optional>
 Available if .tag is tfa_remove_backup_phone_details.
tfa_remove_security_key_details TeamLogTfaRemoveSecurityKeyDetails <optional>
 Available if .tag is tfa_remove_security_key_details.
tfa_reset_details TeamLogTfaResetDetails <optional>
 Available if .tag is tfa_reset_details.
changed_enterprise_admin_role_details TeamLogChangedEnterpriseAdminRoleDetails <optional>
 Available if .tag is changed_enterprise_admin_role_details.
changed_enterprise_connected_team_status_details TeamLogChangedEnterpriseConnectedTeamStatusDetails <optional>
 Available if .tag is changed_enterprise_connected_team_status_details.
ended_enterprise_admin_session_details TeamLogEndedEnterpriseAdminSessionDetails <optional>
 Available if .tag is ended_enterprise_admin_session_details.
ended_enterprise_admin_session_deprecated_details TeamLogEndedEnterpriseAdminSessionDeprecatedDetails <optional>
 Available if .tag is ended_enterprise_admin_session_deprecated_details.
enterprise_settings_locking_details TeamLogEnterpriseSettingsLockingDetails <optional>
 Available if .tag is enterprise_settings_locking_details.
guest_admin_change_status_details TeamLogGuestAdminChangeStatusDetails <optional>
 Available if .tag is guest_admin_change_status_details.
started_enterprise_admin_session_details TeamLogStartedEnterpriseAdminSessionDetails <optional>
 Available if .tag is started_enterprise_admin_session_details.
team_merge_request_accepted_details TeamLogTeamMergeRequestAcceptedDetails <optional>
 Available if .tag is team_merge_request_accepted_details.
team_merge_request_accepted_shown_to_primary_team_details TeamLogTeamMergeRequestAcceptedShownToPrimaryTeamDetails <optional>
 Available if .tag is team_merge_request_accepted_shown_to_primary_team_details.
team_merge_request_accepted_shown_to_secondary_team_details TeamLogTeamMergeRequestAcceptedShownToSecondaryTeamDetails <optional>
 Available if .tag is team_merge_request_accepted_shown_to_secondary_team_details.
team_merge_request_auto_canceled_details TeamLogTeamMergeRequestAutoCanceledDetails <optional>
 Available if .tag is team_merge_request_auto_canceled_details.
team_merge_request_canceled_details TeamLogTeamMergeRequestCanceledDetails <optional>
 Available if .tag is team_merge_request_canceled_details.
team_merge_request_canceled_shown_to_primary_team_details TeamLogTeamMergeRequestCanceledShownToPrimaryTeamDetails <optional>
 Available if .tag is team_merge_request_canceled_shown_to_primary_team_details.
team_merge_request_canceled_shown_to_secondary_team_details TeamLogTeamMergeRequestCanceledShownToSecondaryTeamDetails <optional>
 Available if .tag is team_merge_request_canceled_shown_to_secondary_team_details.
team_merge_request_expired_details TeamLogTeamMergeRequestExpiredDetails <optional>
 Available if .tag is team_merge_request_expired_details.
team_merge_request_expired_shown_to_primary_team_details TeamLogTeamMergeRequestExpiredShownToPrimaryTeamDetails <optional>
 Available if .tag is team_merge_request_expired_shown_to_primary_team_details.
team_merge_request_expired_shown_to_secondary_team_details TeamLogTeamMergeRequestExpiredShownToSecondaryTeamDetails <optional>
 Available if .tag is team_merge_request_expired_shown_to_secondary_team_details.
team_merge_request_rejected_shown_to_primary_team_details TeamLogTeamMergeRequestRejectedShownToPrimaryTeamDetails <optional>
 Available if .tag is team_merge_request_rejected_shown_to_primary_team_details.
team_merge_request_rejected_shown_to_secondary_team_details TeamLogTeamMergeRequestRejectedShownToSecondaryTeamDetails <optional>
 Available if .tag is team_merge_request_rejected_shown_to_secondary_team_details.
team_merge_request_reminder_details TeamLogTeamMergeRequestReminderDetails <optional>
 Available if .tag is team_merge_request_reminder_details.
team_merge_request_reminder_shown_to_primary_team_details TeamLogTeamMergeRequestReminderShownToPrimaryTeamDetails <optional>
 Available if .tag is team_merge_request_reminder_shown_to_primary_team_details.
team_merge_request_reminder_shown_to_secondary_team_details TeamLogTeamMergeRequestReminderShownToSecondaryTeamDetails <optional>
 Available if .tag is team_merge_request_reminder_shown_to_secondary_team_details.
team_merge_request_revoked_details TeamLogTeamMergeRequestRevokedDetails <optional>
 Available if .tag is team_merge_request_revoked_details.
team_merge_request_sent_shown_to_primary_team_details TeamLogTeamMergeRequestSentShownToPrimaryTeamDetails <optional>
 Available if .tag is team_merge_request_sent_shown_to_primary_team_details.
team_merge_request_sent_shown_to_secondary_team_details TeamLogTeamMergeRequestSentShownToSecondaryTeamDetails <optional>
 Available if .tag is team_merge_request_sent_shown_to_secondary_team_details.
missing_details TeamLogMissingDetails <optional>
 Available if .tag is missing_details. Hints that this event was returned with missing details due to an internal error.
.tag 'admin_alerting_alert_state_changed_details' | 'admin_alerting_changed_alert_config_details' | 'admin_alerting_triggered_alert_details' | 'app_blocked_by_permissions_details' | 'app_link_team_details' | 'app_link_user_details' | 'app_unlink_team_details' | 'app_unlink_user_details' | 'integration_connected_details' | 'integration_disconnected_details' | 'file_add_comment_details' | 'file_change_comment_subscription_details' | 'file_delete_comment_details' | 'file_edit_comment_details' | 'file_like_comment_details' | 'file_resolve_comment_details' | 'file_unlike_comment_details' | 'file_unresolve_comment_details' | 'governance_policy_add_folders_details' | 'governance_policy_add_folder_failed_details' | 'governance_policy_content_disposed_details' | 'governance_policy_create_details' | 'governance_policy_delete_details' | 'governance_policy_edit_details_details' | 'governance_policy_edit_duration_details' | 'governance_policy_export_created_details' | 'governance_policy_export_removed_details' | 'governance_policy_remove_folders_details' | 'governance_policy_report_created_details' | 'governance_policy_zip_part_downloaded_details' | 'legal_holds_activate_a_hold_details' | 'legal_holds_add_members_details' | 'legal_holds_change_hold_details_details' | 'legal_holds_change_hold_name_details' | 'legal_holds_export_a_hold_details' | 'legal_holds_export_cancelled_details' | 'legal_holds_export_downloaded_details' | 'legal_holds_export_removed_details' | 'legal_holds_release_a_hold_details' | 'legal_holds_remove_members_details' | 'legal_holds_report_a_hold_details' | 'device_change_ip_desktop_details' | 'device_change_ip_mobile_details' | 'device_change_ip_web_details' | 'device_delete_on_unlink_fail_details' | 'device_delete_on_unlink_success_details' | 'device_link_fail_details' | 'device_link_success_details' | 'device_management_disabled_details' | 'device_management_enabled_details' | 'device_sync_backup_status_changed_details' | 'device_unlink_details' | 'dropbox_passwords_exported_details' | 'dropbox_passwords_new_device_enrolled_details' | 'emm_refresh_auth_token_details' | 'external_drive_backup_eligibility_status_checked_details' | 'external_drive_backup_status_changed_details' | 'account_capture_change_availability_details' | 'account_capture_migrate_account_details' | 'account_capture_notification_emails_sent_details' | 'account_capture_relinquish_account_details' | 'disabled_domain_invites_details' | 'domain_invites_approve_request_to_join_team_details' | 'domain_invites_decline_request_to_join_team_details' | 'domain_invites_email_existing_users_details' | 'domain_invites_request_to_join_team_details' | 'domain_invites_set_invite_new_user_pref_to_no_details' | 'domain_invites_set_invite_new_user_pref_to_yes_details' | 'domain_verification_add_domain_fail_details' | 'domain_verification_add_domain_success_details' | 'domain_verification_remove_domain_details' | 'enabled_domain_invites_details' | 'apply_naming_convention_details' | 'create_folder_details' | 'file_add_details' | 'file_copy_details' | 'file_delete_details' | 'file_download_details' | 'file_edit_details' | 'file_get_copy_reference_details' | 'file_locking_lock_status_changed_details' | 'file_move_details' | 'file_permanently_delete_details' | 'file_preview_details' | 'file_rename_details' | 'file_restore_details' | 'file_revert_details' | 'file_rollback_changes_details' | 'file_save_copy_reference_details' | 'folder_overview_description_changed_details' | 'folder_overview_item_pinned_details' | 'folder_overview_item_unpinned_details' | 'object_label_added_details' | 'object_label_removed_details' | 'object_label_updated_value_details' | 'organize_folder_with_tidy_details' | 'rewind_folder_details' | 'undo_naming_convention_details' | 'undo_organize_folder_with_tidy_details' | 'user_tags_added_details' | 'user_tags_removed_details' | 'email_ingest_receive_file_details' | 'file_request_change_details' | 'file_request_close_details' | 'file_request_create_details' | 'file_request_delete_details' | 'file_request_receive_file_details' | 'group_add_external_id_details' | 'group_add_member_details' | 'group_change_external_id_details' | 'group_change_management_type_details' | 'group_change_member_role_details' | 'group_create_details' | 'group_delete_details' | 'group_description_updated_details' | 'group_join_policy_updated_details' | 'group_moved_details' | 'group_remove_external_id_details' | 'group_remove_member_details' | 'group_rename_details' | 'account_lock_or_unlocked_details' | 'emm_error_details' | 'guest_admin_signed_in_via_trusted_teams_details' | 'guest_admin_signed_out_via_trusted_teams_details' | 'login_fail_details' | 'login_success_details' | 'logout_details' | 'reseller_support_session_end_details' | 'reseller_support_session_start_details' | 'sign_in_as_session_end_details' | 'sign_in_as_session_start_details' | 'sso_error_details' | 'create_team_invite_link_details' | 'delete_team_invite_link_details' | 'member_add_external_id_details' | 'member_add_name_details' | 'member_change_admin_role_details' | 'member_change_email_details' | 'member_change_external_id_details' | 'member_change_membership_type_details' | 'member_change_name_details' | 'member_change_reseller_role_details' | 'member_change_status_details' | 'member_delete_manual_contacts_details' | 'member_delete_profile_photo_details' | 'member_permanently_delete_account_contents_details' | 'member_remove_external_id_details' | 'member_set_profile_photo_details' | 'member_space_limits_add_custom_quota_details' | 'member_space_limits_change_custom_quota_details' | 'member_space_limits_change_status_details' | 'member_space_limits_remove_custom_quota_details' | 'member_suggest_details' | 'member_transfer_account_contents_details' | 'pending_secondary_email_added_details' | 'secondary_email_deleted_details' | 'secondary_email_verified_details' | 'secondary_mails_policy_changed_details' | 'binder_add_page_details' | 'binder_add_section_details' | 'binder_remove_page_details' | 'binder_remove_section_details' | 'binder_rename_page_details' | 'binder_rename_section_details' | 'binder_reorder_page_details' | 'binder_reorder_section_details' | 'paper_content_add_member_details' | 'paper_content_add_to_folder_details' | 'paper_content_archive_details' | 'paper_content_create_details' | 'paper_content_permanently_delete_details' | 'paper_content_remove_from_folder_details' | 'paper_content_remove_member_details' | 'paper_content_rename_details' | 'paper_content_restore_details' | 'paper_doc_add_comment_details' | 'paper_doc_change_member_role_details' | 'paper_doc_change_sharing_policy_details' | 'paper_doc_change_subscription_details' | 'paper_doc_deleted_details' | 'paper_doc_delete_comment_details' | 'paper_doc_download_details' | 'paper_doc_edit_details' | 'paper_doc_edit_comment_details' | 'paper_doc_followed_details' | 'paper_doc_mention_details' | 'paper_doc_ownership_changed_details' | 'paper_doc_request_access_details' | 'paper_doc_resolve_comment_details' | 'paper_doc_revert_details' | 'paper_doc_slack_share_details' | 'paper_doc_team_invite_details' | 'paper_doc_trashed_details' | 'paper_doc_unresolve_comment_details' | 'paper_doc_untrashed_details' | 'paper_doc_view_details' | 'paper_external_view_allow_details' | 'paper_external_view_default_team_details' | 'paper_external_view_forbid_details' | 'paper_folder_change_subscription_details' | 'paper_folder_deleted_details' | 'paper_folder_followed_details' | 'paper_folder_team_invite_details' | 'paper_published_link_change_permission_details' | 'paper_published_link_create_details' | 'paper_published_link_disabled_details' | 'paper_published_link_view_details' | 'password_change_details' | 'password_reset_details' | 'password_reset_all_details' | 'classification_create_report_details' | 'classification_create_report_fail_details' | 'emm_create_exceptions_report_details' | 'emm_create_usage_report_details' | 'export_members_report_details' | 'export_members_report_fail_details' | 'external_sharing_create_report_details' | 'external_sharing_report_failed_details' | 'no_expiration_link_gen_create_report_details' | 'no_expiration_link_gen_report_failed_details' | 'no_password_link_gen_create_report_details' | 'no_password_link_gen_report_failed_details' | 'no_password_link_view_create_report_details' | 'no_password_link_view_report_failed_details' | 'outdated_link_view_create_report_details' | 'outdated_link_view_report_failed_details' | 'paper_admin_export_start_details' | 'smart_sync_create_admin_privilege_report_details' | 'team_activity_create_report_details' | 'team_activity_create_report_fail_details' | 'collection_share_details' | 'file_transfers_file_add_details' | 'file_transfers_transfer_delete_details' | 'file_transfers_transfer_download_details' | 'file_transfers_transfer_send_details' | 'file_transfers_transfer_view_details' | 'note_acl_invite_only_details' | 'note_acl_link_details' | 'note_acl_team_link_details' | 'note_shared_details' | 'note_share_receive_details' | 'open_note_shared_details' | 'sf_add_group_details' | 'sf_allow_non_members_to_view_shared_links_details' | 'sf_external_invite_warn_details' | 'sf_fb_invite_details' | 'sf_fb_invite_change_role_details' | 'sf_fb_uninvite_details' | 'sf_invite_group_details' | 'sf_team_grant_access_details' | 'sf_team_invite_details' | 'sf_team_invite_change_role_details' | 'sf_team_join_details' | 'sf_team_join_from_oob_link_details' | 'sf_team_uninvite_details' | 'shared_content_add_invitees_details' | 'shared_content_add_link_expiry_details' | 'shared_content_add_link_password_details' | 'shared_content_add_member_details' | 'shared_content_change_downloads_policy_details' | 'shared_content_change_invitee_role_details' | 'shared_content_change_link_audience_details' | 'shared_content_change_link_expiry_details' | 'shared_content_change_link_password_details' | 'shared_content_change_member_role_details' | 'shared_content_change_viewer_info_policy_details' | 'shared_content_claim_invitation_details' | 'shared_content_copy_details' | 'shared_content_download_details' | 'shared_content_relinquish_membership_details' | 'shared_content_remove_invitees_details' | 'shared_content_remove_link_expiry_details' | 'shared_content_remove_link_password_details' | 'shared_content_remove_member_details' | 'shared_content_request_access_details' | 'shared_content_restore_invitees_details' | 'shared_content_restore_member_details' | 'shared_content_unshare_details' | 'shared_content_view_details' | 'shared_folder_change_link_policy_details' | 'shared_folder_change_members_inheritance_policy_details' | 'shared_folder_change_members_management_policy_details' | 'shared_folder_change_members_policy_details' | 'shared_folder_create_details' | 'shared_folder_decline_invitation_details' | 'shared_folder_mount_details' | 'shared_folder_nest_details' | 'shared_folder_transfer_ownership_details' | 'shared_folder_unmount_details' | 'shared_link_add_expiry_details' | 'shared_link_change_expiry_details' | 'shared_link_change_visibility_details' | 'shared_link_copy_details' | 'shared_link_create_details' | 'shared_link_disable_details' | 'shared_link_download_details' | 'shared_link_remove_expiry_details' | 'shared_link_settings_add_expiration_details' | 'shared_link_settings_add_password_details' | 'shared_link_settings_allow_download_disabled_details' | 'shared_link_settings_allow_download_enabled_details' | 'shared_link_settings_change_audience_details' | 'shared_link_settings_change_expiration_details' | 'shared_link_settings_change_password_details' | 'shared_link_settings_remove_expiration_details' | 'shared_link_settings_remove_password_details' | 'shared_link_share_details' | 'shared_link_view_details' | 'shared_note_opened_details' | 'shmodel_disable_downloads_details' | 'shmodel_enable_downloads_details' | 'shmodel_group_share_details' | 'showcase_access_granted_details' | 'showcase_add_member_details' | 'showcase_archived_details' | 'showcase_created_details' | 'showcase_delete_comment_details' | 'showcase_edited_details' | 'showcase_edit_comment_details' | 'showcase_file_added_details' | 'showcase_file_download_details' | 'showcase_file_removed_details' | 'showcase_file_view_details' | 'showcase_permanently_deleted_details' | 'showcase_post_comment_details' | 'showcase_remove_member_details' | 'showcase_renamed_details' | 'showcase_request_access_details' | 'showcase_resolve_comment_details' | 'showcase_restored_details' | 'showcase_trashed_details' | 'showcase_trashed_deprecated_details' | 'showcase_unresolve_comment_details' | 'showcase_untrashed_details' | 'showcase_untrashed_deprecated_details' | 'showcase_view_details' | 'sso_add_cert_details' | 'sso_add_login_url_details' | 'sso_add_logout_url_details' | 'sso_change_cert_details' | 'sso_change_login_url_details' | 'sso_change_logout_url_details' | 'sso_change_saml_identity_mode_details' | 'sso_remove_cert_details' | 'sso_remove_login_url_details' | 'sso_remove_logout_url_details' | 'team_folder_change_status_details' | 'team_folder_create_details' | 'team_folder_downgrade_details' | 'team_folder_permanently_delete_details' | 'team_folder_rename_details' | 'team_selective_sync_settings_changed_details' | 'account_capture_change_policy_details' | 'admin_email_reminders_changed_details' | 'allow_download_disabled_details' | 'allow_download_enabled_details' | 'app_permissions_changed_details' | 'camera_uploads_policy_changed_details' | 'capture_transcript_policy_changed_details' | 'classification_change_policy_details' | 'computer_backup_policy_changed_details' | 'content_administration_policy_changed_details' | 'data_placement_restriction_change_policy_details' | 'data_placement_restriction_satisfy_policy_details' | 'device_approvals_add_exception_details' | 'device_approvals_change_desktop_policy_details' | 'device_approvals_change_mobile_policy_details' | 'device_approvals_change_overage_action_details' | 'device_approvals_change_unlink_action_details' | 'device_approvals_remove_exception_details' | 'directory_restrictions_add_members_details' | 'directory_restrictions_remove_members_details' | 'dropbox_passwords_policy_changed_details' | 'email_ingest_policy_changed_details' | 'emm_add_exception_details' | 'emm_change_policy_details' | 'emm_remove_exception_details' | 'extended_version_history_change_policy_details' | 'external_drive_backup_policy_changed_details' | 'file_comments_change_policy_details' | 'file_locking_policy_changed_details' | 'file_provider_migration_policy_changed_details' | 'file_requests_change_policy_details' | 'file_requests_emails_enabled_details' | 'file_requests_emails_restricted_to_team_only_details' | 'file_transfers_policy_changed_details' | 'folder_link_restriction_policy_changed_details' | 'google_sso_change_policy_details' | 'group_user_management_change_policy_details' | 'integration_policy_changed_details' | 'invite_acceptance_email_policy_changed_details' | 'member_requests_change_policy_details' | 'member_send_invite_policy_changed_details' | 'member_space_limits_add_exception_details' | 'member_space_limits_change_caps_type_policy_details' | 'member_space_limits_change_policy_details' | 'member_space_limits_remove_exception_details' | 'member_suggestions_change_policy_details' | 'microsoft_office_addin_change_policy_details' | 'network_control_change_policy_details' | 'paper_change_deployment_policy_details' | 'paper_change_member_link_policy_details' | 'paper_change_member_policy_details' | 'paper_change_policy_details' | 'paper_default_folder_policy_changed_details' | 'paper_desktop_policy_changed_details' | 'paper_enabled_users_group_addition_details' | 'paper_enabled_users_group_removal_details' | 'password_strength_requirements_change_policy_details' | 'permanent_delete_change_policy_details' | 'reseller_support_change_policy_details' | 'rewind_policy_changed_details' | 'send_for_signature_policy_changed_details' | 'sharing_change_folder_join_policy_details' | 'sharing_change_link_allow_change_expiration_policy_details' | 'sharing_change_link_default_expiration_policy_details' | 'sharing_change_link_enforce_password_policy_details' | 'sharing_change_link_policy_details' | 'sharing_change_member_policy_details' | 'showcase_change_download_policy_details' | 'showcase_change_enabled_policy_details' | 'showcase_change_external_sharing_policy_details' | 'smarter_smart_sync_policy_changed_details' | 'smart_sync_change_policy_details' | 'smart_sync_not_opt_out_details' | 'smart_sync_opt_out_details' | 'sso_change_policy_details' | 'team_branding_policy_changed_details' | 'team_extensions_policy_changed_details' | 'team_selective_sync_policy_changed_details' | 'team_sharing_whitelist_subjects_changed_details' | 'tfa_add_exception_details' | 'tfa_change_policy_details' | 'tfa_remove_exception_details' | 'two_account_change_policy_details' | 'viewer_info_policy_changed_details' | 'watermarking_policy_changed_details' | 'web_sessions_change_active_session_limit_details' | 'web_sessions_change_fixed_length_policy_details' | 'web_sessions_change_idle_length_policy_details' | 'data_residency_migration_request_successful_details' | 'data_residency_migration_request_unsuccessful_details' | 'team_merge_from_details' | 'team_merge_to_details' | 'team_profile_add_background_details' | 'team_profile_add_logo_details' | 'team_profile_change_background_details' | 'team_profile_change_default_language_details' | 'team_profile_change_logo_details' | 'team_profile_change_name_details' | 'team_profile_remove_background_details' | 'team_profile_remove_logo_details' | 'tfa_add_backup_phone_details' | 'tfa_add_security_key_details' | 'tfa_change_backup_phone_details' | 'tfa_change_status_details' | 'tfa_remove_backup_phone_details' | 'tfa_remove_security_key_details' | 'tfa_reset_details' | 'changed_enterprise_admin_role_details' | 'changed_enterprise_connected_team_status_details' | 'ended_enterprise_admin_session_details' | 'ended_enterprise_admin_session_deprecated_details' | 'enterprise_settings_locking_details' | 'guest_admin_change_status_details' | 'started_enterprise_admin_session_details' | 'team_merge_request_accepted_details' | 'team_merge_request_accepted_shown_to_primary_team_details' | 'team_merge_request_accepted_shown_to_secondary_team_details' | 'team_merge_request_auto_canceled_details' | 'team_merge_request_canceled_details' | 'team_merge_request_canceled_shown_to_primary_team_details' | 'team_merge_request_canceled_shown_to_secondary_team_details' | 'team_merge_request_expired_details' | 'team_merge_request_expired_shown_to_primary_team_details' | 'team_merge_request_expired_shown_to_secondary_team_details' | 'team_merge_request_rejected_shown_to_primary_team_details' | 'team_merge_request_rejected_shown_to_secondary_team_details' | 'team_merge_request_reminder_details' | 'team_merge_request_reminder_shown_to_primary_team_details' | 'team_merge_request_reminder_shown_to_secondary_team_details' | 'team_merge_request_revoked_details' | 'team_merge_request_sent_shown_to_primary_team_details' | 'team_merge_request_sent_shown_to_secondary_team_details' | 'missing_details' | 'other' Tag identifying the union variant.

TeamLogEventType

The type of the event with description.
Type:
  • Object
Properties:
Name Type Argument Description
admin_alerting_alert_state_changed TeamLogAdminAlertingAlertStateChangedType <optional>
 Available if .tag is admin_alerting_alert_state_changed. (admin_alerting) Changed an alert state
admin_alerting_changed_alert_config TeamLogAdminAlertingChangedAlertConfigType <optional>
 Available if .tag is admin_alerting_changed_alert_config. (admin_alerting) Changed an alert setting
admin_alerting_triggered_alert TeamLogAdminAlertingTriggeredAlertType <optional>
 Available if .tag is admin_alerting_triggered_alert. (admin_alerting) Triggered security alert
app_blocked_by_permissions TeamLogAppBlockedByPermissionsType <optional>
 Available if .tag is app_blocked_by_permissions. (apps) Failed to connect app for member
app_link_team TeamLogAppLinkTeamType <optional>
 Available if .tag is app_link_team. (apps) Linked app for team
app_link_user TeamLogAppLinkUserType <optional>
 Available if .tag is app_link_user. (apps) Linked app for member
app_unlink_team TeamLogAppUnlinkTeamType <optional>
 Available if .tag is app_unlink_team. (apps) Unlinked app for team
app_unlink_user TeamLogAppUnlinkUserType <optional>
 Available if .tag is app_unlink_user. (apps) Unlinked app for member
integration_connected TeamLogIntegrationConnectedType <optional>
 Available if .tag is integration_connected. (apps) Connected integration for member
integration_disconnected TeamLogIntegrationDisconnectedType <optional>
 Available if .tag is integration_disconnected. (apps) Disconnected integration for member
file_add_comment TeamLogFileAddCommentType <optional>
 Available if .tag is file_add_comment. (comments) Added file comment
file_change_comment_subscription TeamLogFileChangeCommentSubscriptionType <optional>
 Available if .tag is file_change_comment_subscription. (comments) Subscribed to or unsubscribed from comment notifications for file
file_delete_comment TeamLogFileDeleteCommentType <optional>
 Available if .tag is file_delete_comment. (comments) Deleted file comment
file_edit_comment TeamLogFileEditCommentType <optional>
 Available if .tag is file_edit_comment. (comments) Edited file comment
file_like_comment TeamLogFileLikeCommentType <optional>
 Available if .tag is file_like_comment. (comments) Liked file comment (deprecated, no longer logged)
file_resolve_comment TeamLogFileResolveCommentType <optional>
 Available if .tag is file_resolve_comment. (comments) Resolved file comment
file_unlike_comment TeamLogFileUnlikeCommentType <optional>
 Available if .tag is file_unlike_comment. (comments) Unliked file comment (deprecated, no longer logged)
file_unresolve_comment TeamLogFileUnresolveCommentType <optional>
 Available if .tag is file_unresolve_comment. (comments) Unresolved file comment
governance_policy_add_folders TeamLogGovernancePolicyAddFoldersType <optional>
 Available if .tag is governance_policy_add_folders. (data_governance) Added folders to policy
governance_policy_add_folder_failed TeamLogGovernancePolicyAddFolderFailedType <optional>
 Available if .tag is governance_policy_add_folder_failed. (data_governance) Couldn't add a folder to a policy
governance_policy_content_disposed TeamLogGovernancePolicyContentDisposedType <optional>
 Available if .tag is governance_policy_content_disposed. (data_governance) Content disposed
governance_policy_create TeamLogGovernancePolicyCreateType <optional>
 Available if .tag is governance_policy_create. (data_governance) Activated a new policy
governance_policy_delete TeamLogGovernancePolicyDeleteType <optional>
 Available if .tag is governance_policy_delete. (data_governance) Deleted a policy
governance_policy_edit_details TeamLogGovernancePolicyEditDetailsType <optional>
 Available if .tag is governance_policy_edit_details. (data_governance) Edited policy
governance_policy_edit_duration TeamLogGovernancePolicyEditDurationType <optional>
 Available if .tag is governance_policy_edit_duration. (data_governance) Changed policy duration
governance_policy_export_created TeamLogGovernancePolicyExportCreatedType <optional>
 Available if .tag is governance_policy_export_created. (data_governance) Created a policy download
governance_policy_export_removed TeamLogGovernancePolicyExportRemovedType <optional>
 Available if .tag is governance_policy_export_removed. (data_governance) Removed a policy download
governance_policy_remove_folders TeamLogGovernancePolicyRemoveFoldersType <optional>
 Available if .tag is governance_policy_remove_folders. (data_governance) Removed folders from policy
governance_policy_report_created TeamLogGovernancePolicyReportCreatedType <optional>
 Available if .tag is governance_policy_report_created. (data_governance) Created a summary report for a policy
governance_policy_zip_part_downloaded TeamLogGovernancePolicyZipPartDownloadedType <optional>
 Available if .tag is governance_policy_zip_part_downloaded. (data_governance) Downloaded content from a policy
legal_holds_activate_a_hold TeamLogLegalHoldsActivateAHoldType <optional>
 - Available if .tag is legal_holds_activate_a_hold. (data_governance) Activated a hold
legal_holds_add_members TeamLogLegalHoldsAddMembersType <optional>
 Available if .tag is legal_holds_add_members. (data_governance) Added members to a hold
legal_holds_change_hold_details TeamLogLegalHoldsChangeHoldDetailsType <optional>
 Available if .tag is legal_holds_change_hold_details. (data_governance) Edited details for a hold
legal_holds_change_hold_name TeamLogLegalHoldsChangeHoldNameType <optional>
 Available if .tag is legal_holds_change_hold_name. (data_governance) Renamed a hold
legal_holds_export_a_hold TeamLogLegalHoldsExportAHoldType <optional>
 Available if .tag is legal_holds_export_a_hold. (data_governance) Exported hold
legal_holds_export_cancelled TeamLogLegalHoldsExportCancelledType <optional>
 Available if .tag is legal_holds_export_cancelled. (data_governance) Canceled export for a hold
legal_holds_export_downloaded TeamLogLegalHoldsExportDownloadedType <optional>
 Available if .tag is legal_holds_export_downloaded. (data_governance) Downloaded export for a hold
legal_holds_export_removed TeamLogLegalHoldsExportRemovedType <optional>
 Available if .tag is legal_holds_export_removed. (data_governance) Removed export for a hold
legal_holds_release_a_hold TeamLogLegalHoldsReleaseAHoldType <optional>
 Available if .tag is legal_holds_release_a_hold. (data_governance) Released a hold
legal_holds_remove_members TeamLogLegalHoldsRemoveMembersType <optional>
 Available if .tag is legal_holds_remove_members. (data_governance) Removed members from a hold
legal_holds_report_a_hold TeamLogLegalHoldsReportAHoldType <optional>
 Available if .tag is legal_holds_report_a_hold. (data_governance) Created a summary report for a hold
device_change_ip_desktop TeamLogDeviceChangeIpDesktopType <optional>
 Available if .tag is device_change_ip_desktop. (devices) Changed IP address associated with active desktop session
device_change_ip_mobile TeamLogDeviceChangeIpMobileType <optional>
 Available if .tag is device_change_ip_mobile. (devices) Changed IP address associated with active mobile session
device_change_ip_web TeamLogDeviceChangeIpWebType <optional>
 Available if .tag is device_change_ip_web. (devices) Changed IP address associated with active web session
device_delete_on_unlink_fail TeamLogDeviceDeleteOnUnlinkFailType <optional>
 Available if .tag is device_delete_on_unlink_fail. (devices) Failed to delete all files from unlinked device
device_delete_on_unlink_success TeamLogDeviceDeleteOnUnlinkSuccessType <optional>
 Available if .tag is device_delete_on_unlink_success. (devices) Deleted all files from unlinked device
device_link_fail TeamLogDeviceLinkFailType <optional>
 Available if .tag is device_link_fail. (devices) Failed to link device
device_link_success TeamLogDeviceLinkSuccessType <optional>
 Available if .tag is device_link_success. (devices) Linked device
device_management_disabled TeamLogDeviceManagementDisabledType <optional>
 - Available if .tag is device_management_disabled. (devices) Disabled device management (deprecated, no longer logged)
device_management_enabled TeamLogDeviceManagementEnabledType <optional>
 Available if .tag is device_management_enabled. (devices) Enabled device management (deprecated, no longer logged)
device_sync_backup_status_changed TeamLogDeviceSyncBackupStatusChangedType <optional>
 Available if .tag is device_sync_backup_status_changed. (devices) Enabled/disabled backup for computer
device_unlink TeamLogDeviceUnlinkType <optional>
 Available if .tag is device_unlink. (devices) Disconnected device
dropbox_passwords_exported TeamLogDropboxPasswordsExportedType <optional>
 - Available if .tag is dropbox_passwords_exported. (devices) Exported passwords
dropbox_passwords_new_device_enrolled TeamLogDropboxPasswordsNewDeviceEnrolledType <optional>
 Available if .tag is dropbox_passwords_new_device_enrolled. (devices) Enrolled new Dropbox Passwords device
emm_refresh_auth_token TeamLogEmmRefreshAuthTokenType <optional>
 Available if .tag is emm_refresh_auth_token. (devices) Refreshed auth token used for setting up EMM
external_drive_backup_eligibility_status_checked TeamLogExternalDriveBackupEligibilityStatusCheckedType <optional>
 Available if .tag is external_drive_backup_eligibility_status_checked. (devices) Checked external drive backup eligibility status
external_drive_backup_status_changed TeamLogExternalDriveBackupStatusChangedType <optional>
 Available if .tag is external_drive_backup_status_changed. (devices) Modified external drive backup
account_capture_change_availability TeamLogAccountCaptureChangeAvailabilityType <optional>
 Available if .tag is account_capture_change_availability. (domains) Granted/revoked option to enable account capture on team domains
account_capture_migrate_account TeamLogAccountCaptureMigrateAccountType <optional>
 Available if .tag is account_capture_migrate_account. (domains) Account-captured user migrated account to team
account_capture_notification_emails_sent TeamLogAccountCaptureNotificationEmailsSentType <optional>
 Available if .tag is account_capture_notification_emails_sent. (domains) Sent account capture email to all unmanaged members
account_capture_relinquish_account TeamLogAccountCaptureRelinquishAccountType <optional>
 Available if .tag is account_capture_relinquish_account. (domains) Account-captured user changed account email to personal email
disabled_domain_invites TeamLogDisabledDomainInvitesType <optional>
 Available if .tag is disabled_domain_invites. (domains) Disabled domain invites (deprecated, no longer logged)
domain_invites_approve_request_to_join_team TeamLogDomainInvitesApproveRequestToJoinTeamType <optional>
 Available if .tag is domain_invites_approve_request_to_join_team. (domains) Approved user's request to join team
domain_invites_decline_request_to_join_team TeamLogDomainInvitesDeclineRequestToJoinTeamType <optional>
 Available if .tag is domain_invites_decline_request_to_join_team. (domains) Declined user's request to join team
domain_invites_email_existing_users TeamLogDomainInvitesEmailExistingUsersType <optional>
 Available if .tag is domain_invites_email_existing_users. (domains) Sent domain invites to existing domain accounts (deprecated, no longer logged)
domain_invites_request_to_join_team TeamLogDomainInvitesRequestToJoinTeamType <optional>
 Available if .tag is domain_invites_request_to_join_team. (domains) Requested to join team
domain_invites_set_invite_new_user_pref_to_no TeamLogDomainInvitesSetInviteNewUserPrefToNoType <optional>
 Available if .tag is domain_invites_set_invite_new_user_pref_to_no. (domains) Disabled "Automatically invite new users" (deprecated, no longer logged)
domain_invites_set_invite_new_user_pref_to_yes TeamLogDomainInvitesSetInviteNewUserPrefToYesType <optional>
 Available if .tag is domain_invites_set_invite_new_user_pref_to_yes. (domains) Enabled "Automatically invite new users" (deprecated, no longer logged)
domain_verification_add_domain_fail TeamLogDomainVerificationAddDomainFailType <optional>
 Available if .tag is domain_verification_add_domain_fail. (domains) Failed to verify team domain
domain_verification_add_domain_success TeamLogDomainVerificationAddDomainSuccessType <optional>
 Available if .tag is domain_verification_add_domain_success. (domains) Verified team domain
domain_verification_remove_domain TeamLogDomainVerificationRemoveDomainType <optional>
 Available if .tag is domain_verification_remove_domain. (domains) Removed domain from list of verified team domains
enabled_domain_invites TeamLogEnabledDomainInvitesType <optional>
 Available if .tag is enabled_domain_invites. (domains) Enabled domain invites (deprecated, no longer logged)
apply_naming_convention TeamLogApplyNamingConventionType <optional>
 Available if .tag is apply_naming_convention. (file_operations) Applied naming convention
create_folder TeamLogCreateFolderType <optional>
 Available if .tag is create_folder. (file_operations) Created folders (deprecated, no longer logged)
file_add TeamLogFileAddType <optional>
 Available if .tag is file_add. (file_operations) Added files and/or folders
file_copy TeamLogFileCopyType <optional>
 Available if .tag is file_copy. (file_operations) Copied files and/or folders
file_delete TeamLogFileDeleteType <optional>
 Available if .tag is file_delete. (file_operations) Deleted files and/or folders
file_download TeamLogFileDownloadType <optional>
 Available if .tag is file_download. (file_operations) Downloaded files and/or folders
file_edit TeamLogFileEditType <optional>
 Available if .tag is file_edit. (file_operations) Edited files
file_get_copy_reference TeamLogFileGetCopyReferenceType <optional>
 Available if .tag is file_get_copy_reference. (file_operations) Created copy reference to file/folder
file_locking_lock_status_changed TeamLogFileLockingLockStatusChangedType <optional>
 Available if .tag is file_locking_lock_status_changed. (file_operations) Locked/unlocked editing for a file
file_move TeamLogFileMoveType <optional>
 Available if .tag is file_move. (file_operations) Moved files and/or folders
file_permanently_delete TeamLogFilePermanentlyDeleteType <optional>
 Available if .tag is file_permanently_delete. (file_operations) Permanently deleted files and/or folders
file_preview TeamLogFilePreviewType <optional>
 Available if .tag is file_preview. (file_operations) Previewed files and/or folders
file_rename TeamLogFileRenameType <optional>
 Available if .tag is file_rename. (file_operations) Renamed files and/or folders
file_restore TeamLogFileRestoreType <optional>
 Available if .tag is file_restore. (file_operations) Restored deleted files and/or folders
file_revert TeamLogFileRevertType <optional>
 Available if .tag is file_revert. (file_operations) Reverted files to previous version
file_rollback_changes TeamLogFileRollbackChangesType <optional>
 Available if .tag is file_rollback_changes. (file_operations) Rolled back file actions
file_save_copy_reference TeamLogFileSaveCopyReferenceType <optional>
 Available if .tag is file_save_copy_reference. (file_operations) Saved file/folder using copy reference
folder_overview_description_changed TeamLogFolderOverviewDescriptionChangedType <optional>
 Available if .tag is folder_overview_description_changed. (file_operations) Updated folder overview
folder_overview_item_pinned TeamLogFolderOverviewItemPinnedType <optional>
 - Available if .tag is folder_overview_item_pinned. (file_operations) Pinned item to folder overview
folder_overview_item_unpinned TeamLogFolderOverviewItemUnpinnedType <optional>
 Available if .tag is folder_overview_item_unpinned. (file_operations) Unpinned item from folder overview
object_label_added TeamLogObjectLabelAddedType <optional>
 Available if .tag is object_label_added. (file_operations) Added a label
object_label_removed TeamLogObjectLabelRemovedType <optional>
 Available if .tag is object_label_removed. (file_operations) Removed a label
object_label_updated_value TeamLogObjectLabelUpdatedValueType <optional>
 Available if .tag is object_label_updated_value. (file_operations) Updated a label's value
organize_folder_with_tidy TeamLogOrganizeFolderWithTidyType <optional>
 Available if .tag is organize_folder_with_tidy. (file_operations) Organized a folder with multi-file organize
rewind_folder TeamLogRewindFolderType <optional>
 Available if .tag is rewind_folder. (file_operations) Rewound a folder
undo_naming_convention TeamLogUndoNamingConventionType <optional>
 Available if .tag is undo_naming_convention. (file_operations) Reverted naming convention
undo_organize_folder_with_tidy TeamLogUndoOrganizeFolderWithTidyType <optional>
 Available if .tag is undo_organize_folder_with_tidy. (file_operations) Removed multi-file organize
user_tags_added TeamLogUserTagsAddedType <optional>
 Available if .tag is user_tags_added. (file_operations) Tagged a file
user_tags_removed TeamLogUserTagsRemovedType <optional>
 Available if .tag is user_tags_removed. (file_operations) Removed tags
email_ingest_receive_file TeamLogEmailIngestReceiveFileType <optional>
 Available if .tag is email_ingest_receive_file. (file_requests) Received files via Email to Dropbox
file_request_change TeamLogFileRequestChangeType <optional>
 Available if .tag is file_request_change. (file_requests) Changed file request
file_request_close TeamLogFileRequestCloseType <optional>
 Available if .tag is file_request_close. (file_requests) Closed file request
file_request_create TeamLogFileRequestCreateType <optional>
 Available if .tag is file_request_create. (file_requests) Created file request
file_request_delete TeamLogFileRequestDeleteType <optional>
 Available if .tag is file_request_delete. (file_requests) Delete file request
file_request_receive_file TeamLogFileRequestReceiveFileType <optional>
 Available if .tag is file_request_receive_file. (file_requests) Received files for file request
group_add_external_id TeamLogGroupAddExternalIdType <optional>
 Available if .tag is group_add_external_id. (groups) Added external ID for group
group_add_member TeamLogGroupAddMemberType <optional>
 Available if .tag is group_add_member. (groups) Added team members to group
group_change_external_id TeamLogGroupChangeExternalIdType <optional>
 Available if .tag is group_change_external_id. (groups) Changed external ID for group
group_change_management_type TeamLogGroupChangeManagementTypeType <optional>
 Available if .tag is group_change_management_type. (groups) Changed group management type
group_change_member_role TeamLogGroupChangeMemberRoleType <optional>
 Available if .tag is group_change_member_role. (groups) Changed manager permissions of group member
group_create TeamLogGroupCreateType <optional>
 Available if .tag is group_create. (groups) Created group
group_delete TeamLogGroupDeleteType <optional>
 Available if .tag is group_delete. (groups) Deleted group
group_description_updated TeamLogGroupDescriptionUpdatedType <optional>
 Available if .tag is group_description_updated. (groups) Updated group (deprecated, no longer logged)
group_join_policy_updated TeamLogGroupJoinPolicyUpdatedType <optional>
 Available if .tag is group_join_policy_updated. (groups) Updated group join policy (deprecated, no longer logged)
group_moved TeamLogGroupMovedType <optional>
 Available if .tag is group_moved. (groups) Moved group (deprecated, no longer logged)
group_remove_external_id TeamLogGroupRemoveExternalIdType <optional>
 Available if .tag is group_remove_external_id. (groups) Removed external ID for group
group_remove_member TeamLogGroupRemoveMemberType <optional>
 Available if .tag is group_remove_member. (groups) Removed team members from group
group_rename TeamLogGroupRenameType <optional>
 Available if .tag is group_rename. (groups) Renamed group
account_lock_or_unlocked TeamLogAccountLockOrUnlockedType <optional>
 Available if .tag is account_lock_or_unlocked. (logins) Unlocked/locked account after failed sign in attempts
emm_error TeamLogEmmErrorType <optional>
 Available if .tag is emm_error. (logins) Failed to sign in via EMM (deprecated, replaced by 'Failed to sign in')
guest_admin_signed_in_via_trusted_teams TeamLogGuestAdminSignedInViaTrustedTeamsType <optional>
 Available if .tag is guest_admin_signed_in_via_trusted_teams. (logins) Started trusted team admin session
guest_admin_signed_out_via_trusted_teams TeamLogGuestAdminSignedOutViaTrustedTeamsType <optional>
 Available if .tag is guest_admin_signed_out_via_trusted_teams. (logins) Ended trusted team admin session
login_fail TeamLogLoginFailType <optional>
 Available if .tag is login_fail. (logins) Failed to sign in
login_success TeamLogLoginSuccessType <optional>
 Available if .tag is login_success. (logins) Signed in
logout TeamLogLogoutType <optional>
 Available if .tag is logout. (logins) Signed out
reseller_support_session_end TeamLogResellerSupportSessionEndType <optional>
 Available if .tag is reseller_support_session_end. (logins) Ended reseller support session
reseller_support_session_start TeamLogResellerSupportSessionStartType <optional>
 Available if .tag is reseller_support_session_start. (logins) Started reseller support session
sign_in_as_session_end TeamLogSignInAsSessionEndType <optional>
 Available if .tag is sign_in_as_session_end. (logins) Ended admin sign-in-as session
sign_in_as_session_start TeamLogSignInAsSessionStartType <optional>
 Available if .tag is sign_in_as_session_start. (logins) Started admin sign-in-as session
sso_error TeamLogSsoErrorType <optional>
 Available if .tag is sso_error. (logins) Failed to sign in via SSO (deprecated, replaced by 'Failed to sign in')
create_team_invite_link TeamLogCreateTeamInviteLinkType <optional>
 Available if .tag is create_team_invite_link. (members) Created team invite link
delete_team_invite_link TeamLogDeleteTeamInviteLinkType <optional>
 Available if .tag is delete_team_invite_link. (members) Deleted team invite link
member_add_external_id TeamLogMemberAddExternalIdType <optional>
 Available if .tag is member_add_external_id. (members) Added an external ID for team member
member_add_name TeamLogMemberAddNameType <optional>
 Available if .tag is member_add_name. (members) Added team member name
member_change_admin_role TeamLogMemberChangeAdminRoleType <optional>
 Available if .tag is member_change_admin_role. (members) Changed team member admin role
member_change_email TeamLogMemberChangeEmailType <optional>
 Available if .tag is member_change_email. (members) Changed team member email
member_change_external_id TeamLogMemberChangeExternalIdType <optional>
 Available if .tag is member_change_external_id. (members) Changed the external ID for team member
member_change_membership_type TeamLogMemberChangeMembershipTypeType <optional>
 Available if .tag is member_change_membership_type. (members) Changed membership type (limited/full) of member (deprecated, no longer logged)
member_change_name TeamLogMemberChangeNameType <optional>
 Available if .tag is member_change_name. (members) Changed team member name
member_change_reseller_role TeamLogMemberChangeResellerRoleType <optional>
 - Available if .tag is member_change_reseller_role. (members) Changed team member reseller role
member_change_status TeamLogMemberChangeStatusType <optional>
 Available if .tag is member_change_status. (members) Changed member status (invited, joined, suspended, etc.)
member_delete_manual_contacts TeamLogMemberDeleteManualContactsType <optional>
 Available if .tag is member_delete_manual_contacts. (members) Cleared manually added contacts
member_delete_profile_photo TeamLogMemberDeleteProfilePhotoType <optional>
 - Available if .tag is member_delete_profile_photo. (members) Deleted team member profile photo
member_permanently_delete_account_contents TeamLogMemberPermanentlyDeleteAccountContentsType <optional>
 Available if .tag is member_permanently_delete_account_contents. (members) Permanently deleted contents of deleted team member account
member_remove_external_id TeamLogMemberRemoveExternalIdType <optional>
 Available if .tag is member_remove_external_id. (members) Removed the external ID for team member
member_set_profile_photo TeamLogMemberSetProfilePhotoType <optional>
 Available if .tag is member_set_profile_photo. (members) Set team member profile photo
member_space_limits_add_custom_quota TeamLogMemberSpaceLimitsAddCustomQuotaType <optional>
 Available if .tag is member_space_limits_add_custom_quota. (members) Set custom member space limit
member_space_limits_change_custom_quota TeamLogMemberSpaceLimitsChangeCustomQuotaType <optional>
 Available if .tag is member_space_limits_change_custom_quota. (members) Changed custom member space limit
member_space_limits_change_status TeamLogMemberSpaceLimitsChangeStatusType <optional>
 Available if .tag is member_space_limits_change_status. (members) Changed space limit status
member_space_limits_remove_custom_quota TeamLogMemberSpaceLimitsRemoveCustomQuotaType <optional>
 Available if .tag is member_space_limits_remove_custom_quota. (members) Removed custom member space limit
member_suggest TeamLogMemberSuggestType <optional>
 Available if .tag is member_suggest. (members) Suggested person to add to team
member_transfer_account_contents TeamLogMemberTransferAccountContentsType <optional>
 Available if .tag is member_transfer_account_contents. (members) Transferred contents of deleted member account to another member
pending_secondary_email_added TeamLogPendingSecondaryEmailAddedType <optional>
 Available if .tag is pending_secondary_email_added. (members) Added pending secondary email
secondary_email_deleted TeamLogSecondaryEmailDeletedType <optional>
 Available if .tag is secondary_email_deleted. (members) Deleted secondary email
secondary_email_verified TeamLogSecondaryEmailVerifiedType <optional>
 Available if .tag is secondary_email_verified. (members) Verified secondary email
secondary_mails_policy_changed TeamLogSecondaryMailsPolicyChangedType <optional>
 Available if .tag is secondary_mails_policy_changed. (members) Secondary mails policy changed
binder_add_page TeamLogBinderAddPageType <optional>
 Available if .tag is binder_add_page. (paper) Added Binder page (deprecated, replaced by 'Edited files')
binder_add_section TeamLogBinderAddSectionType <optional>
 Available if .tag is binder_add_section. (paper) Added Binder section (deprecated, replaced by 'Edited files')
binder_remove_page TeamLogBinderRemovePageType <optional>
 Available if .tag is binder_remove_page. (paper) Removed Binder page (deprecated, replaced by 'Edited files')
binder_remove_section TeamLogBinderRemoveSectionType <optional>
 Available if .tag is binder_remove_section. (paper) Removed Binder section (deprecated, replaced by 'Edited files')
binder_rename_page TeamLogBinderRenamePageType <optional>
 Available if .tag is binder_rename_page. (paper) Renamed Binder page (deprecated, replaced by 'Edited files')
binder_rename_section TeamLogBinderRenameSectionType <optional>
 Available if .tag is binder_rename_section. (paper) Renamed Binder section (deprecated, replaced by 'Edited files')
binder_reorder_page TeamLogBinderReorderPageType <optional>
 Available if .tag is binder_reorder_page. (paper) Reordered Binder page (deprecated, replaced by 'Edited files')
binder_reorder_section TeamLogBinderReorderSectionType <optional>
 Available if .tag is binder_reorder_section. (paper) Reordered Binder section (deprecated, replaced by 'Edited files')
paper_content_add_member TeamLogPaperContentAddMemberType <optional>
 Available if .tag is paper_content_add_member. (paper) Added users and/or groups to Paper doc/folder
paper_content_add_to_folder TeamLogPaperContentAddToFolderType <optional>
 - Available if .tag is paper_content_add_to_folder. (paper) Added Paper doc/folder to folder
paper_content_archive TeamLogPaperContentArchiveType <optional>
 Available if .tag is paper_content_archive. (paper) Archived Paper doc/folder
paper_content_create TeamLogPaperContentCreateType <optional>
 Available if .tag is paper_content_create. (paper) Created Paper doc/folder
paper_content_permanently_delete TeamLogPaperContentPermanentlyDeleteType <optional>
 Available if .tag is paper_content_permanently_delete. (paper) Permanently deleted Paper doc/folder
paper_content_remove_from_folder TeamLogPaperContentRemoveFromFolderType <optional>
 Available if .tag is paper_content_remove_from_folder. (paper) Removed Paper doc/folder from folder
paper_content_remove_member TeamLogPaperContentRemoveMemberType <optional>
 - Available if .tag is paper_content_remove_member. (paper) Removed users and/or groups from Paper doc/folder
paper_content_rename TeamLogPaperContentRenameType <optional>
 Available if .tag is paper_content_rename. (paper) Renamed Paper doc/folder
paper_content_restore TeamLogPaperContentRestoreType <optional>
 Available if .tag is paper_content_restore. (paper) Restored archived Paper doc/folder
paper_doc_add_comment TeamLogPaperDocAddCommentType <optional>
 Available if .tag is paper_doc_add_comment. (paper) Added Paper doc comment
paper_doc_change_member_role TeamLogPaperDocChangeMemberRoleType <optional>
 Available if .tag is paper_doc_change_member_role. (paper) Changed member permissions for Paper doc
paper_doc_change_sharing_policy TeamLogPaperDocChangeSharingPolicyType <optional>
 Available if .tag is paper_doc_change_sharing_policy. (paper) Changed sharing setting for Paper doc
paper_doc_change_subscription TeamLogPaperDocChangeSubscriptionType <optional>
 Available if .tag is paper_doc_change_subscription. (paper) Followed/unfollowed Paper doc
paper_doc_deleted TeamLogPaperDocDeletedType <optional>
 Available if .tag is paper_doc_deleted. (paper) Archived Paper doc (deprecated, no longer logged)
paper_doc_delete_comment TeamLogPaperDocDeleteCommentType <optional>
 Available if .tag is paper_doc_delete_comment. (paper) Deleted Paper doc comment
paper_doc_download TeamLogPaperDocDownloadType <optional>
 Available if .tag is paper_doc_download. (paper) Downloaded Paper doc in specific format
paper_doc_edit TeamLogPaperDocEditType <optional>
 Available if .tag is paper_doc_edit. (paper) Edited Paper doc
paper_doc_edit_comment TeamLogPaperDocEditCommentType <optional>
 Available if .tag is paper_doc_edit_comment. (paper) Edited Paper doc comment
paper_doc_followed TeamLogPaperDocFollowedType <optional>
 Available if .tag is paper_doc_followed. (paper) Followed Paper doc (deprecated, replaced by 'Followed/unfollowed Paper doc')
paper_doc_mention TeamLogPaperDocMentionType <optional>
 Available if .tag is paper_doc_mention. (paper) Mentioned user in Paper doc
paper_doc_ownership_changed TeamLogPaperDocOwnershipChangedType <optional>
 - Available if .tag is paper_doc_ownership_changed. (paper) Transferred ownership of Paper doc
paper_doc_request_access TeamLogPaperDocRequestAccessType <optional>
 Available if .tag is paper_doc_request_access. (paper) Requested access to Paper doc
paper_doc_resolve_comment TeamLogPaperDocResolveCommentType <optional>
 Available if .tag is paper_doc_resolve_comment. (paper) Resolved Paper doc comment
paper_doc_revert TeamLogPaperDocRevertType <optional>
 Available if .tag is paper_doc_revert. (paper) Restored Paper doc to previous version
paper_doc_slack_share TeamLogPaperDocSlackShareType <optional>
 Available if .tag is paper_doc_slack_share. (paper) Shared Paper doc via Slack
paper_doc_team_invite TeamLogPaperDocTeamInviteType <optional>
 Available if .tag is paper_doc_team_invite. (paper) Shared Paper doc with users and/or groups (deprecated, no longer logged)
paper_doc_trashed TeamLogPaperDocTrashedType <optional>
 Available if .tag is paper_doc_trashed. (paper) Deleted Paper doc
paper_doc_unresolve_comment TeamLogPaperDocUnresolveCommentType <optional>
 - Available if .tag is paper_doc_unresolve_comment. (paper) Unresolved Paper doc comment
paper_doc_untrashed TeamLogPaperDocUntrashedType <optional>
 Available if .tag is paper_doc_untrashed. (paper) Restored Paper doc
paper_doc_view TeamLogPaperDocViewType <optional>
 Available if .tag is paper_doc_view. (paper) Viewed Paper doc
paper_external_view_allow TeamLogPaperExternalViewAllowType <optional>
 Available if .tag is paper_external_view_allow. (paper) Changed Paper external sharing setting to anyone (deprecated, no longer logged)
paper_external_view_default_team TeamLogPaperExternalViewDefaultTeamType <optional>
 Available if .tag is paper_external_view_default_team. (paper) Changed Paper external sharing setting to default team (deprecated, no longer logged)
paper_external_view_forbid TeamLogPaperExternalViewForbidType <optional>
 Available if .tag is paper_external_view_forbid. (paper) Changed Paper external sharing setting to team-only (deprecated, no longer logged)
paper_folder_change_subscription TeamLogPaperFolderChangeSubscriptionType <optional>
 Available if .tag is paper_folder_change_subscription. (paper) Followed/unfollowed Paper folder
paper_folder_deleted TeamLogPaperFolderDeletedType <optional>
 Available if .tag is paper_folder_deleted. (paper) Archived Paper folder (deprecated, no longer logged)
paper_folder_followed TeamLogPaperFolderFollowedType <optional>
 Available if .tag is paper_folder_followed. (paper) Followed Paper folder (deprecated, replaced by 'Followed/unfollowed Paper folder')
paper_folder_team_invite TeamLogPaperFolderTeamInviteType <optional>
 Available if .tag is paper_folder_team_invite. (paper) Shared Paper folder with users and/or groups (deprecated, no longer logged)
paper_published_link_change_permission TeamLogPaperPublishedLinkChangePermissionType <optional>
 Available if .tag is paper_published_link_change_permission. (paper) Changed permissions for published doc
paper_published_link_create TeamLogPaperPublishedLinkCreateType <optional>
 - Available if .tag is paper_published_link_create. (paper) Published doc
paper_published_link_disabled TeamLogPaperPublishedLinkDisabledType <optional>
 Available if .tag is paper_published_link_disabled. (paper) Unpublished doc
paper_published_link_view TeamLogPaperPublishedLinkViewType <optional>
 Available if .tag is paper_published_link_view. (paper) Viewed published doc
password_change TeamLogPasswordChangeType <optional>
 Available if .tag is password_change. (passwords) Changed password
password_reset TeamLogPasswordResetType <optional>
 Available if .tag is password_reset. (passwords) Reset password
password_reset_all TeamLogPasswordResetAllType <optional>
 Available if .tag is password_reset_all. (passwords) Reset all team member passwords
classification_create_report TeamLogClassificationCreateReportType <optional>
 Available if .tag is classification_create_report. (reports) Created Classification report
classification_create_report_fail TeamLogClassificationCreateReportFailType <optional>
 Available if .tag is classification_create_report_fail. (reports) Couldn't create Classification report
emm_create_exceptions_report TeamLogEmmCreateExceptionsReportType <optional>
 Available if .tag is emm_create_exceptions_report. (reports) Created EMM-excluded users report
emm_create_usage_report TeamLogEmmCreateUsageReportType <optional>
 Available if .tag is emm_create_usage_report. (reports) Created EMM mobile app usage report
export_members_report TeamLogExportMembersReportType <optional>
 Available if .tag is export_members_report. (reports) Created member data report
export_members_report_fail TeamLogExportMembersReportFailType <optional>
 Available if .tag is export_members_report_fail. (reports) Failed to create members data report
external_sharing_create_report TeamLogExternalSharingCreateReportType <optional>
 Available if .tag is external_sharing_create_report. (reports) Created External sharing report
external_sharing_report_failed TeamLogExternalSharingReportFailedType <optional>
 Available if .tag is external_sharing_report_failed. (reports) Couldn't create External sharing report
no_expiration_link_gen_create_report TeamLogNoExpirationLinkGenCreateReportType <optional>
 Available if .tag is no_expiration_link_gen_create_report. (reports) Report created: Links created with no expiration
no_expiration_link_gen_report_failed TeamLogNoExpirationLinkGenReportFailedType <optional>
 Available if .tag is no_expiration_link_gen_report_failed. (reports) Couldn't create report: Links created with no expiration
no_password_link_gen_create_report TeamLogNoPasswordLinkGenCreateReportType <optional>
 Available if .tag is no_password_link_gen_create_report. (reports) Report created: Links created without passwords
no_password_link_gen_report_failed TeamLogNoPasswordLinkGenReportFailedType <optional>
 Available if .tag is no_password_link_gen_report_failed. (reports) Couldn't create report: Links created without passwords
no_password_link_view_create_report TeamLogNoPasswordLinkViewCreateReportType <optional>
 Available if .tag is no_password_link_view_create_report. (reports) Report created: Views of links without passwords
no_password_link_view_report_failed TeamLogNoPasswordLinkViewReportFailedType <optional>
 Available if .tag is no_password_link_view_report_failed. (reports) Couldn't create report: Views of links without passwords
outdated_link_view_create_report TeamLogOutdatedLinkViewCreateReportType <optional>
 Available if .tag is outdated_link_view_create_report. (reports) Report created: Views of old links
outdated_link_view_report_failed TeamLogOutdatedLinkViewReportFailedType <optional>
 Available if .tag is outdated_link_view_report_failed. (reports) Couldn't create report: Views of old links
paper_admin_export_start TeamLogPaperAdminExportStartType <optional>
 Available if .tag is paper_admin_export_start. (reports) Exported all team Paper docs
smart_sync_create_admin_privilege_report TeamLogSmartSyncCreateAdminPrivilegeReportType <optional>
 Available if .tag is smart_sync_create_admin_privilege_report. (reports) Created Smart Sync non-admin devices report
team_activity_create_report TeamLogTeamActivityCreateReportType <optional>
 - Available if .tag is team_activity_create_report. (reports) Created team activity report
team_activity_create_report_fail TeamLogTeamActivityCreateReportFailType <optional>
 Available if .tag is team_activity_create_report_fail. (reports) Couldn't generate team activity report
collection_share TeamLogCollectionShareType <optional>
 Available if .tag is collection_share. (sharing) Shared album
file_transfers_file_add TeamLogFileTransfersFileAddType <optional>
 Available if .tag is file_transfers_file_add. (sharing) Transfer files added
file_transfers_transfer_delete TeamLogFileTransfersTransferDeleteType <optional>
 Available if .tag is file_transfers_transfer_delete. (sharing) Deleted transfer
file_transfers_transfer_download TeamLogFileTransfersTransferDownloadType <optional>
 Available if .tag is file_transfers_transfer_download. (sharing) Transfer downloaded
file_transfers_transfer_send TeamLogFileTransfersTransferSendType <optional>
 Available if .tag is file_transfers_transfer_send. (sharing) Sent transfer
file_transfers_transfer_view TeamLogFileTransfersTransferViewType <optional>
 Available if .tag is file_transfers_transfer_view. (sharing) Viewed transfer
note_acl_invite_only TeamLogNoteAclInviteOnlyType <optional>
 Available if .tag is note_acl_invite_only. (sharing) Changed Paper doc to invite-only (deprecated, no longer logged)
note_acl_link TeamLogNoteAclLinkType <optional>
 Available if .tag is note_acl_link. (sharing) Changed Paper doc to link-accessible (deprecated, no longer logged)
note_acl_team_link TeamLogNoteAclTeamLinkType <optional>
 Available if .tag is note_acl_team_link. (sharing) Changed Paper doc to link-accessible for team (deprecated, no longer logged)
note_shared TeamLogNoteSharedType <optional>
 Available if .tag is note_shared. (sharing) Shared Paper doc (deprecated, no longer logged)
note_share_receive TeamLogNoteShareReceiveType <optional>
 Available if .tag is note_share_receive. (sharing) Shared received Paper doc (deprecated, no longer logged)
open_note_shared TeamLogOpenNoteSharedType <optional>
 Available if .tag is open_note_shared. (sharing) Opened shared Paper doc (deprecated, no longer logged)
sf_add_group TeamLogSfAddGroupType <optional>
 Available if .tag is sf_add_group. (sharing) Added team to shared folder (deprecated, no longer logged)
sf_allow_non_members_to_view_shared_links TeamLogSfAllowNonMembersToViewSharedLinksType <optional>
 Available if .tag is sf_allow_non_members_to_view_shared_links. (sharing) Allowed non-collaborators to view links to files in shared folder (deprecated, no longer logged)
sf_external_invite_warn TeamLogSfExternalInviteWarnType <optional>
 Available if .tag is sf_external_invite_warn. (sharing) Set team members to see warning before sharing folders outside team (deprecated, no longer logged)
sf_fb_invite TeamLogSfFbInviteType <optional>
 Available if .tag is sf_fb_invite. (sharing) Invited Facebook users to shared folder (deprecated, no longer logged)
sf_fb_invite_change_role TeamLogSfFbInviteChangeRoleType <optional>
 Available if .tag is sf_fb_invite_change_role. (sharing) Changed Facebook user's role in shared folder (deprecated, no longer logged)
sf_fb_uninvite TeamLogSfFbUninviteType <optional>
 Available if .tag is sf_fb_uninvite. (sharing) Uninvited Facebook user from shared folder (deprecated, no longer logged)
sf_invite_group TeamLogSfInviteGroupType <optional>
 Available if .tag is sf_invite_group. (sharing) Invited group to shared folder (deprecated, no longer logged)
sf_team_grant_access TeamLogSfTeamGrantAccessType <optional>
 Available if .tag is sf_team_grant_access. (sharing) Granted access to shared folder (deprecated, no longer logged)
sf_team_invite TeamLogSfTeamInviteType <optional>
 Available if .tag is sf_team_invite. (sharing) Invited team members to shared folder (deprecated, replaced by 'Invited user to Dropbox and added them to shared file/folder')
sf_team_invite_change_role TeamLogSfTeamInviteChangeRoleType <optional>
 Available if .tag is sf_team_invite_change_role. (sharing) Changed team member's role in shared folder (deprecated, no longer logged)
sf_team_join TeamLogSfTeamJoinType <optional>
 Available if .tag is sf_team_join. (sharing) Joined team member's shared folder (deprecated, no longer logged)
sf_team_join_from_oob_link TeamLogSfTeamJoinFromOobLinkType <optional>
 Available if .tag is sf_team_join_from_oob_link. (sharing) Joined team member's shared folder from link (deprecated, no longer logged)
sf_team_uninvite TeamLogSfTeamUninviteType <optional>
 Available if .tag is sf_team_uninvite. (sharing) Unshared folder with team member (deprecated, replaced by 'Removed invitee from shared file/folder before invite was accepted')
shared_content_add_invitees TeamLogSharedContentAddInviteesType <optional>
 - Available if .tag is shared_content_add_invitees. (sharing) Invited user to Dropbox and added them to shared file/folder
shared_content_add_link_expiry TeamLogSharedContentAddLinkExpiryType <optional>
 Available if .tag is shared_content_add_link_expiry. (sharing) Added expiration date to link for shared file/folder (deprecated, no longer logged)
shared_content_add_link_password TeamLogSharedContentAddLinkPasswordType <optional>
 Available if .tag is shared_content_add_link_password. (sharing) Added password to link for shared file/folder (deprecated, no longer logged)
shared_content_add_member TeamLogSharedContentAddMemberType <optional>
 Available if .tag is shared_content_add_member. (sharing) Added users and/or groups to shared file/folder
shared_content_change_downloads_policy TeamLogSharedContentChangeDownloadsPolicyType <optional>
 Available if .tag is shared_content_change_downloads_policy. (sharing) Changed whether members can download shared file/folder (deprecated, no longer logged)
shared_content_change_invitee_role TeamLogSharedContentChangeInviteeRoleType <optional>
 Available if .tag is shared_content_change_invitee_role. (sharing) Changed access type of invitee to shared file/folder before invite was accepted
shared_content_change_link_audience TeamLogSharedContentChangeLinkAudienceType <optional>
 Available if .tag is shared_content_change_link_audience. (sharing) Changed link audience of shared file/folder (deprecated, no longer logged)
shared_content_change_link_expiry TeamLogSharedContentChangeLinkExpiryType <optional>
 Available if .tag is shared_content_change_link_expiry. (sharing) Changed link expiration of shared file/folder (deprecated, no longer logged)
shared_content_change_link_password TeamLogSharedContentChangeLinkPasswordType <optional>
 Available if .tag is shared_content_change_link_password. (sharing) Changed link password of shared file/folder (deprecated, no longer logged)
shared_content_change_member_role TeamLogSharedContentChangeMemberRoleType <optional>
 Available if .tag is shared_content_change_member_role. (sharing) Changed access type of shared file/folder member
shared_content_change_viewer_info_policy TeamLogSharedContentChangeViewerInfoPolicyType <optional>
 Available if .tag is shared_content_change_viewer_info_policy. (sharing) Changed whether members can see who viewed shared file/folder
shared_content_claim_invitation TeamLogSharedContentClaimInvitationType <optional>
 Available if .tag is shared_content_claim_invitation. (sharing) Acquired membership of shared file/folder by accepting invite
shared_content_copy TeamLogSharedContentCopyType <optional>
 Available if .tag is shared_content_copy. (sharing) Copied shared file/folder to own Dropbox
shared_content_download TeamLogSharedContentDownloadType <optional>
 Available if .tag is shared_content_download. (sharing) Downloaded shared file/folder
shared_content_relinquish_membership TeamLogSharedContentRelinquishMembershipType <optional>
 Available if .tag is shared_content_relinquish_membership. (sharing) Left shared file/folder
shared_content_remove_invitees TeamLogSharedContentRemoveInviteesType <optional>
 Available if .tag is shared_content_remove_invitees. (sharing) Removed invitee from shared file/folder before invite was accepted
shared_content_remove_link_expiry TeamLogSharedContentRemoveLinkExpiryType <optional>
 Available if .tag is shared_content_remove_link_expiry. (sharing) Removed link expiration date of shared file/folder (deprecated, no longer logged)
shared_content_remove_link_password TeamLogSharedContentRemoveLinkPasswordType <optional>
 Available if .tag is shared_content_remove_link_password. (sharing) Removed link password of shared file/folder (deprecated, no longer logged)
shared_content_remove_member TeamLogSharedContentRemoveMemberType <optional>
 Available if .tag is shared_content_remove_member. (sharing) Removed user/group from shared file/folder
shared_content_request_access TeamLogSharedContentRequestAccessType <optional>
 Available if .tag is shared_content_request_access. (sharing) Requested access to shared file/folder
shared_content_restore_invitees TeamLogSharedContentRestoreInviteesType <optional>
 Available if .tag is shared_content_restore_invitees. (sharing) Restored shared file/folder invitees
shared_content_restore_member TeamLogSharedContentRestoreMemberType <optional>
 Available if .tag is shared_content_restore_member. (sharing) Restored users and/or groups to membership of shared file/folder
shared_content_unshare TeamLogSharedContentUnshareType <optional>
 Available if .tag is shared_content_unshare. (sharing) Unshared file/folder by clearing membership
shared_content_view TeamLogSharedContentViewType <optional>
 Available if .tag is shared_content_view. (sharing) Previewed shared file/folder
shared_folder_change_link_policy TeamLogSharedFolderChangeLinkPolicyType <optional>
 Available if .tag is shared_folder_change_link_policy. (sharing) Changed who can access shared folder via link
shared_folder_change_members_inheritance_policy TeamLogSharedFolderChangeMembersInheritancePolicyType <optional>
 Available if .tag is shared_folder_change_members_inheritance_policy. (sharing) Changed whether shared folder inherits members from parent folder
shared_folder_change_members_management_policy TeamLogSharedFolderChangeMembersManagementPolicyType <optional>
 Available if .tag is shared_folder_change_members_management_policy. (sharing) Changed who can add/remove members of shared folder
shared_folder_change_members_policy TeamLogSharedFolderChangeMembersPolicyType <optional>
 Available if .tag is shared_folder_change_members_policy. (sharing) Changed who can become member of shared folder
shared_folder_create TeamLogSharedFolderCreateType <optional>
 Available if .tag is shared_folder_create. (sharing) Created shared folder
shared_folder_decline_invitation TeamLogSharedFolderDeclineInvitationType <optional>
 Available if .tag is shared_folder_decline_invitation. (sharing) Declined team member's invite to shared folder
shared_folder_mount TeamLogSharedFolderMountType <optional>
 Available if .tag is shared_folder_mount. (sharing) Added shared folder to own Dropbox
shared_folder_nest TeamLogSharedFolderNestType <optional>
 Available if .tag is shared_folder_nest. (sharing) Changed parent of shared folder
shared_folder_transfer_ownership TeamLogSharedFolderTransferOwnershipType <optional>
 Available if .tag is shared_folder_transfer_ownership. (sharing) Transferred ownership of shared folder to another member
shared_folder_unmount TeamLogSharedFolderUnmountType <optional>
 Available if .tag is shared_folder_unmount. (sharing) Deleted shared folder from Dropbox
shared_link_add_expiry TeamLogSharedLinkAddExpiryType <optional>
 Available if .tag is shared_link_add_expiry. (sharing) Added shared link expiration date
shared_link_change_expiry TeamLogSharedLinkChangeExpiryType <optional>
 Available if .tag is shared_link_change_expiry. (sharing) Changed shared link expiration date
shared_link_change_visibility TeamLogSharedLinkChangeVisibilityType <optional>
 Available if .tag is shared_link_change_visibility. (sharing) Changed visibility of shared link
shared_link_copy TeamLogSharedLinkCopyType <optional>
 Available if .tag is shared_link_copy. (sharing) Added file/folder to Dropbox from shared link
shared_link_create TeamLogSharedLinkCreateType <optional>
 Available if .tag is shared_link_create. (sharing) Created shared link
shared_link_disable TeamLogSharedLinkDisableType <optional>
 Available if .tag is shared_link_disable. (sharing) Removed shared link
shared_link_download TeamLogSharedLinkDownloadType <optional>
 Available if .tag is shared_link_download. (sharing) Downloaded file/folder from shared link
shared_link_remove_expiry TeamLogSharedLinkRemoveExpiryType <optional>
 Available if .tag is shared_link_remove_expiry. (sharing) Removed shared link expiration date
shared_link_settings_add_expiration TeamLogSharedLinkSettingsAddExpirationType <optional>
 Available if .tag is shared_link_settings_add_expiration. (sharing) Added an expiration date to the shared link
shared_link_settings_add_password TeamLogSharedLinkSettingsAddPasswordType <optional>
 Available if .tag is shared_link_settings_add_password. (sharing) Added a password to the shared link
shared_link_settings_allow_download_disabled TeamLogSharedLinkSettingsAllowDownloadDisabledType <optional>
 Available if .tag is shared_link_settings_allow_download_disabled. (sharing) Disabled downloads
shared_link_settings_allow_download_enabled TeamLogSharedLinkSettingsAllowDownloadEnabledType <optional>
 Available if .tag is shared_link_settings_allow_download_enabled. (sharing) Enabled downloads
shared_link_settings_change_audience TeamLogSharedLinkSettingsChangeAudienceType <optional>
 Available if .tag is shared_link_settings_change_audience. (sharing) Changed the audience of the shared link
shared_link_settings_change_expiration TeamLogSharedLinkSettingsChangeExpirationType <optional>
 Available if .tag is shared_link_settings_change_expiration. (sharing) Changed the expiration date of the shared link
shared_link_settings_change_password TeamLogSharedLinkSettingsChangePasswordType <optional>
 Available if .tag is shared_link_settings_change_password. (sharing) Changed the password of the shared link
shared_link_settings_remove_expiration TeamLogSharedLinkSettingsRemoveExpirationType <optional>
 Available if .tag is shared_link_settings_remove_expiration. (sharing) Removed the expiration date from the shared link
shared_link_settings_remove_password TeamLogSharedLinkSettingsRemovePasswordType <optional>
 Available if .tag is shared_link_settings_remove_password. (sharing) Removed the password from the shared link
shared_link_share TeamLogSharedLinkShareType <optional>
 Available if .tag is shared_link_share. (sharing) Added members as audience of shared link
shared_link_view TeamLogSharedLinkViewType <optional>
 Available if .tag is shared_link_view. (sharing) Opened shared link
shared_note_opened TeamLogSharedNoteOpenedType <optional>
 Available if .tag is shared_note_opened. (sharing) Opened shared Paper doc (deprecated, no longer logged)
shmodel_disable_downloads TeamLogShmodelDisableDownloadsType <optional>
 Available if .tag is shmodel_disable_downloads. (sharing) Disabled downloads for link (deprecated, no longer logged)
shmodel_enable_downloads TeamLogShmodelEnableDownloadsType <optional>
 Available if .tag is shmodel_enable_downloads. (sharing) Enabled downloads for link (deprecated, no longer logged)
shmodel_group_share TeamLogShmodelGroupShareType <optional>
 Available if .tag is shmodel_group_share. (sharing) Shared link with group (deprecated, no longer logged)
showcase_access_granted TeamLogShowcaseAccessGrantedType <optional>
 Available if .tag is showcase_access_granted. (showcase) Granted access to showcase
showcase_add_member TeamLogShowcaseAddMemberType <optional>
 Available if .tag is showcase_add_member. (showcase) Added member to showcase
showcase_archived TeamLogShowcaseArchivedType <optional>
 Available if .tag is showcase_archived. (showcase) Archived showcase
showcase_created TeamLogShowcaseCreatedType <optional>
 Available if .tag is showcase_created. (showcase) Created showcase
showcase_delete_comment TeamLogShowcaseDeleteCommentType <optional>
 Available if .tag is showcase_delete_comment. (showcase) Deleted showcase comment
showcase_edited TeamLogShowcaseEditedType <optional>
 Available if .tag is showcase_edited. (showcase) Edited showcase
showcase_edit_comment TeamLogShowcaseEditCommentType <optional>
 Available if .tag is showcase_edit_comment. (showcase) Edited showcase comment
showcase_file_added TeamLogShowcaseFileAddedType <optional>
 Available if .tag is showcase_file_added. (showcase) Added file to showcase
showcase_file_download TeamLogShowcaseFileDownloadType <optional>
 Available if .tag is showcase_file_download. (showcase) Downloaded file from showcase
showcase_file_removed TeamLogShowcaseFileRemovedType <optional>
 Available if .tag is showcase_file_removed. (showcase) Removed file from showcase
showcase_file_view TeamLogShowcaseFileViewType <optional>
 Available if .tag is showcase_file_view. (showcase) Viewed file in showcase
showcase_permanently_deleted TeamLogShowcasePermanentlyDeletedType <optional>
 Available if .tag is showcase_permanently_deleted. (showcase) Permanently deleted showcase
showcase_post_comment TeamLogShowcasePostCommentType <optional>
 Available if .tag is showcase_post_comment. (showcase) Added showcase comment
showcase_remove_member TeamLogShowcaseRemoveMemberType <optional>
 Available if .tag is showcase_remove_member. (showcase) Removed member from showcase
showcase_renamed TeamLogShowcaseRenamedType <optional>
 Available if .tag is showcase_renamed. (showcase) Renamed showcase
showcase_request_access TeamLogShowcaseRequestAccessType <optional>
 Available if .tag is showcase_request_access. (showcase) Requested access to showcase
showcase_resolve_comment TeamLogShowcaseResolveCommentType <optional>
 Available if .tag is showcase_resolve_comment. (showcase) Resolved showcase comment
showcase_restored TeamLogShowcaseRestoredType <optional>
 Available if .tag is showcase_restored. (showcase) Unarchived showcase
showcase_trashed TeamLogShowcaseTrashedType <optional>
 Available if .tag is showcase_trashed. (showcase) Deleted showcase
showcase_trashed_deprecated TeamLogShowcaseTrashedDeprecatedType <optional>
 Available if .tag is showcase_trashed_deprecated. (showcase) Deleted showcase (old version) (deprecated, replaced by 'Deleted showcase')
showcase_unresolve_comment TeamLogShowcaseUnresolveCommentType <optional>
 - Available if .tag is showcase_unresolve_comment. (showcase) Unresolved showcase comment
showcase_untrashed TeamLogShowcaseUntrashedType <optional>
 Available if .tag is showcase_untrashed. (showcase) Restored showcase
showcase_untrashed_deprecated TeamLogShowcaseUntrashedDeprecatedType <optional>
 Available if .tag is showcase_untrashed_deprecated. (showcase) Restored showcase (old version) (deprecated, replaced by 'Restored showcase')
showcase_view TeamLogShowcaseViewType <optional>
 Available if .tag is showcase_view. (showcase) Viewed showcase
sso_add_cert TeamLogSsoAddCertType <optional>
 Available if .tag is sso_add_cert. (sso) Added X.509 certificate for SSO
sso_add_login_url TeamLogSsoAddLoginUrlType <optional>
 Available if .tag is sso_add_login_url. (sso) Added sign-in URL for SSO
sso_add_logout_url TeamLogSsoAddLogoutUrlType <optional>
 Available if .tag is sso_add_logout_url. (sso) Added sign-out URL for SSO
sso_change_cert TeamLogSsoChangeCertType <optional>
 Available if .tag is sso_change_cert. (sso) Changed X.509 certificate for SSO
sso_change_login_url TeamLogSsoChangeLoginUrlType <optional>
 Available if .tag is sso_change_login_url. (sso) Changed sign-in URL for SSO
sso_change_logout_url TeamLogSsoChangeLogoutUrlType <optional>
 Available if .tag is sso_change_logout_url. (sso) Changed sign-out URL for SSO
sso_change_saml_identity_mode TeamLogSsoChangeSamlIdentityModeType <optional>
 Available if .tag is sso_change_saml_identity_mode. (sso) Changed SAML identity mode for SSO
sso_remove_cert TeamLogSsoRemoveCertType <optional>
 Available if .tag is sso_remove_cert. (sso) Removed X.509 certificate for SSO
sso_remove_login_url TeamLogSsoRemoveLoginUrlType <optional>
 Available if .tag is sso_remove_login_url. (sso) Removed sign-in URL for SSO
sso_remove_logout_url TeamLogSsoRemoveLogoutUrlType <optional>
 Available if .tag is sso_remove_logout_url. (sso) Removed sign-out URL for SSO
team_folder_change_status TeamLogTeamFolderChangeStatusType <optional>
 Available if .tag is team_folder_change_status. (team_folders) Changed archival status of team folder
team_folder_create TeamLogTeamFolderCreateType <optional>
 Available if .tag is team_folder_create. (team_folders) Created team folder in active status
team_folder_downgrade TeamLogTeamFolderDowngradeType <optional>
 Available if .tag is team_folder_downgrade. (team_folders) Downgraded team folder to regular shared folder
team_folder_permanently_delete TeamLogTeamFolderPermanentlyDeleteType <optional>
 Available if .tag is team_folder_permanently_delete. (team_folders) Permanently deleted archived team folder
team_folder_rename TeamLogTeamFolderRenameType <optional>
 Available if .tag is team_folder_rename. (team_folders) Renamed active/archived team folder
team_selective_sync_settings_changed TeamLogTeamSelectiveSyncSettingsChangedType <optional>
 Available if .tag is team_selective_sync_settings_changed. (team_folders) Changed sync default
account_capture_change_policy TeamLogAccountCaptureChangePolicyType <optional>
 Available if .tag is account_capture_change_policy. (team_policies) Changed account capture setting on team domain
admin_email_reminders_changed TeamLogAdminEmailRemindersChangedType <optional>
 Available if .tag is admin_email_reminders_changed. (team_policies) Changed admin reminder settings for requests to join the team
allow_download_disabled TeamLogAllowDownloadDisabledType <optional>
 Available if .tag is allow_download_disabled. (team_policies) Disabled downloads (deprecated, no longer logged)
allow_download_enabled TeamLogAllowDownloadEnabledType <optional>
 Available if .tag is allow_download_enabled. (team_policies) Enabled downloads (deprecated, no longer logged)
app_permissions_changed TeamLogAppPermissionsChangedType <optional>
 Available if .tag is app_permissions_changed. (team_policies) Changed app permissions
camera_uploads_policy_changed TeamLogCameraUploadsPolicyChangedType <optional>
 Available if .tag is camera_uploads_policy_changed. (team_policies) Changed camera uploads setting for team
capture_transcript_policy_changed TeamLogCaptureTranscriptPolicyChangedType <optional>
 Available if .tag is capture_transcript_policy_changed. (team_policies) Changed Capture transcription policy for team
classification_change_policy TeamLogClassificationChangePolicyType <optional>
 Available if .tag is classification_change_policy. (team_policies) Changed classification policy for team
computer_backup_policy_changed TeamLogComputerBackupPolicyChangedType <optional>
 Available if .tag is computer_backup_policy_changed. (team_policies) Changed computer backup policy for team
content_administration_policy_changed TeamLogContentAdministrationPolicyChangedType <optional>
 Available if .tag is content_administration_policy_changed. (team_policies) Changed content management setting
data_placement_restriction_change_policy TeamLogDataPlacementRestrictionChangePolicyType <optional>
 Available if .tag is data_placement_restriction_change_policy. (team_policies) Set restrictions on data center locations where team data resides
data_placement_restriction_satisfy_policy TeamLogDataPlacementRestrictionSatisfyPolicyType <optional>
 Available if .tag is data_placement_restriction_satisfy_policy. (team_policies) Completed restrictions on data center locations where team data resides
device_approvals_add_exception TeamLogDeviceApprovalsAddExceptionType <optional>
 Available if .tag is device_approvals_add_exception. (team_policies) Added members to device approvals exception list
device_approvals_change_desktop_policy TeamLogDeviceApprovalsChangeDesktopPolicyType <optional>
 Available if .tag is device_approvals_change_desktop_policy. (team_policies) Set/removed limit on number of computers member can link to team Dropbox account
device_approvals_change_mobile_policy TeamLogDeviceApprovalsChangeMobilePolicyType <optional>
 Available if .tag is device_approvals_change_mobile_policy. (team_policies) Set/removed limit on number of mobile devices member can link to team Dropbox account
device_approvals_change_overage_action TeamLogDeviceApprovalsChangeOverageActionType <optional>
 Available if .tag is device_approvals_change_overage_action. (team_policies) Changed device approvals setting when member is over limit
device_approvals_change_unlink_action TeamLogDeviceApprovalsChangeUnlinkActionType <optional>
 Available if .tag is device_approvals_change_unlink_action. (team_policies) Changed device approvals setting when member unlinks approved device
device_approvals_remove_exception TeamLogDeviceApprovalsRemoveExceptionType <optional>
 Available if .tag is device_approvals_remove_exception. (team_policies) Removed members from device approvals exception list
directory_restrictions_add_members TeamLogDirectoryRestrictionsAddMembersType <optional>
 Available if .tag is directory_restrictions_add_members. (team_policies) Added members to directory restrictions list
directory_restrictions_remove_members TeamLogDirectoryRestrictionsRemoveMembersType <optional>
 Available if .tag is directory_restrictions_remove_members. (team_policies) Removed members from directory restrictions list
dropbox_passwords_policy_changed TeamLogDropboxPasswordsPolicyChangedType <optional>
 Available if .tag is dropbox_passwords_policy_changed. (team_policies) Changed Dropbox Passwords policy for team
email_ingest_policy_changed TeamLogEmailIngestPolicyChangedType <optional>
 - Available if .tag is email_ingest_policy_changed. (team_policies) Changed email to Dropbox policy for team
emm_add_exception TeamLogEmmAddExceptionType <optional>
 Available if .tag is emm_add_exception. (team_policies) Added members to EMM exception list
emm_change_policy TeamLogEmmChangePolicyType <optional>
 Available if .tag is emm_change_policy. (team_policies) Enabled/disabled enterprise mobility management for members
emm_remove_exception TeamLogEmmRemoveExceptionType <optional>
 Available if .tag is emm_remove_exception. (team_policies) Removed members from EMM exception list
extended_version_history_change_policy TeamLogExtendedVersionHistoryChangePolicyType <optional>
 Available if .tag is extended_version_history_change_policy. (team_policies) Accepted/opted out of extended version history
external_drive_backup_policy_changed TeamLogExternalDriveBackupPolicyChangedType <optional>
 Available if .tag is external_drive_backup_policy_changed. (team_policies) Changed external drive backup policy for team
file_comments_change_policy TeamLogFileCommentsChangePolicyType <optional>
 - Available if .tag is file_comments_change_policy. (team_policies) Enabled/disabled commenting on team files
file_locking_policy_changed TeamLogFileLockingPolicyChangedType <optional>
 - Available if .tag is file_locking_policy_changed. (team_policies) Changed file locking policy for team
file_provider_migration_policy_changed TeamLogFileProviderMigrationPolicyChangedType <optional>
 Available if .tag is file_provider_migration_policy_changed. (team_policies) Changed File Provider Migration policy for team
file_requests_change_policy TeamLogFileRequestsChangePolicyType <optional>
 - Available if .tag is file_requests_change_policy. (team_policies) Enabled/disabled file requests
file_requests_emails_enabled TeamLogFileRequestsEmailsEnabledType <optional>
 Available if .tag is file_requests_emails_enabled. (team_policies) Enabled file request emails for everyone (deprecated, no longer logged)
file_requests_emails_restricted_to_team_only TeamLogFileRequestsEmailsRestrictedToTeamOnlyType <optional>
 Available if .tag is file_requests_emails_restricted_to_team_only. (team_policies) Enabled file request emails for team (deprecated, no longer logged)
file_transfers_policy_changed TeamLogFileTransfersPolicyChangedType <optional>
 Available if .tag is file_transfers_policy_changed. (team_policies) Changed file transfers policy for team
folder_link_restriction_policy_changed TeamLogFolderLinkRestrictionPolicyChangedType <optional>
 Available if .tag is folder_link_restriction_policy_changed. (team_policies) Changed folder link restrictions policy for team
google_sso_change_policy TeamLogGoogleSsoChangePolicyType <optional>
 Available if .tag is google_sso_change_policy. (team_policies) Enabled/disabled Google single sign-on for team
group_user_management_change_policy TeamLogGroupUserManagementChangePolicyType <optional>
 Available if .tag is group_user_management_change_policy. (team_policies) Changed who can create groups
integration_policy_changed TeamLogIntegrationPolicyChangedType <optional>
 - Available if .tag is integration_policy_changed. (team_policies) Changed integration policy for team
invite_acceptance_email_policy_changed TeamLogInviteAcceptanceEmailPolicyChangedType <optional>
 Available if .tag is invite_acceptance_email_policy_changed. (team_policies) Changed invite accept email policy for team
member_requests_change_policy TeamLogMemberRequestsChangePolicyType <optional>
 Available if .tag is member_requests_change_policy. (team_policies) Changed whether users can find team when not invited
member_send_invite_policy_changed TeamLogMemberSendInvitePolicyChangedType <optional>
 Available if .tag is member_send_invite_policy_changed. (team_policies) Changed member send invite policy for team
member_space_limits_add_exception TeamLogMemberSpaceLimitsAddExceptionType <optional>
 Available if .tag is member_space_limits_add_exception. (team_policies) Added members to member space limit exception list
member_space_limits_change_caps_type_policy TeamLogMemberSpaceLimitsChangeCapsTypePolicyType <optional>
 Available if .tag is member_space_limits_change_caps_type_policy. (team_policies) Changed member space limit type for team
member_space_limits_change_policy TeamLogMemberSpaceLimitsChangePolicyType <optional>
 Available if .tag is member_space_limits_change_policy. (team_policies) Changed team default member space limit
member_space_limits_remove_exception TeamLogMemberSpaceLimitsRemoveExceptionType <optional>
 Available if .tag is member_space_limits_remove_exception. (team_policies) Removed members from member space limit exception list
member_suggestions_change_policy TeamLogMemberSuggestionsChangePolicyType <optional>
 Available if .tag is member_suggestions_change_policy. (team_policies) Enabled/disabled option for team members to suggest people to add to team
microsoft_office_addin_change_policy TeamLogMicrosoftOfficeAddinChangePolicyType <optional>
 Available if .tag is microsoft_office_addin_change_policy. (team_policies) Enabled/disabled Microsoft Office add-in
network_control_change_policy TeamLogNetworkControlChangePolicyType <optional>
 Available if .tag is network_control_change_policy. (team_policies) Enabled/disabled network control
paper_change_deployment_policy TeamLogPaperChangeDeploymentPolicyType <optional>
 Available if .tag is paper_change_deployment_policy. (team_policies) Changed whether Dropbox Paper, when enabled, is deployed to all members or to specific members
paper_change_member_link_policy TeamLogPaperChangeMemberLinkPolicyType <optional>
 Available if .tag is paper_change_member_link_policy. (team_policies) Changed whether non-members can view Paper docs with link (deprecated, no longer logged)
paper_change_member_policy TeamLogPaperChangeMemberPolicyType <optional>
 Available if .tag is paper_change_member_policy. (team_policies) Changed whether members can share Paper docs outside team, and if docs are accessible only by team members or anyone by default
paper_change_policy TeamLogPaperChangePolicyType <optional>
 Available if .tag is paper_change_policy. (team_policies) Enabled/disabled Dropbox Paper for team
paper_default_folder_policy_changed TeamLogPaperDefaultFolderPolicyChangedType <optional>
 Available if .tag is paper_default_folder_policy_changed. (team_policies) Changed Paper Default Folder Policy setting for team
paper_desktop_policy_changed TeamLogPaperDesktopPolicyChangedType <optional>
 Available if .tag is paper_desktop_policy_changed. (team_policies) Enabled/disabled Paper Desktop for team
paper_enabled_users_group_addition TeamLogPaperEnabledUsersGroupAdditionType <optional>
 Available if .tag is paper_enabled_users_group_addition. (team_policies) Added users to Paper-enabled users list
paper_enabled_users_group_removal TeamLogPaperEnabledUsersGroupRemovalType <optional>
 Available if .tag is paper_enabled_users_group_removal. (team_policies) Removed users from Paper-enabled users list
password_strength_requirements_change_policy TeamLogPasswordStrengthRequirementsChangePolicyType <optional>
 Available if .tag is password_strength_requirements_change_policy. (team_policies) Changed team password strength requirements
permanent_delete_change_policy TeamLogPermanentDeleteChangePolicyType <optional>
 Available if .tag is permanent_delete_change_policy. (team_policies) Enabled/disabled ability of team members to permanently delete content
reseller_support_change_policy TeamLogResellerSupportChangePolicyType <optional>
 Available if .tag is reseller_support_change_policy. (team_policies) Enabled/disabled reseller support
rewind_policy_changed TeamLogRewindPolicyChangedType <optional>
 Available if .tag is rewind_policy_changed. (team_policies) Changed Rewind policy for team
send_for_signature_policy_changed TeamLogSendForSignaturePolicyChangedType <optional>
 Available if .tag is send_for_signature_policy_changed. (team_policies) Changed send for signature policy for team
sharing_change_folder_join_policy TeamLogSharingChangeFolderJoinPolicyType <optional>
 Available if .tag is sharing_change_folder_join_policy. (team_policies) Changed whether team members can join shared folders owned outside team
sharing_change_link_allow_change_expiration_policy TeamLogSharingChangeLinkAllowChangeExpirationPolicyType <optional>
 Available if .tag is sharing_change_link_allow_change_expiration_policy. (team_policies) Changed the allow remove or change expiration policy for the links shared outside of the team
sharing_change_link_default_expiration_policy TeamLogSharingChangeLinkDefaultExpirationPolicyType <optional>
 Available if .tag is sharing_change_link_default_expiration_policy. (team_policies) Changed the default expiration for the links shared outside of the team
sharing_change_link_enforce_password_policy TeamLogSharingChangeLinkEnforcePasswordPolicyType <optional>
 Available if .tag is sharing_change_link_enforce_password_policy. (team_policies) Changed the password requirement for the links shared outside of the team
sharing_change_link_policy TeamLogSharingChangeLinkPolicyType <optional>
 Available if .tag is sharing_change_link_policy. (team_policies) Changed whether members can share links outside team, and if links are accessible only by team members or anyone by default
sharing_change_member_policy TeamLogSharingChangeMemberPolicyType <optional>
 Available if .tag is sharing_change_member_policy. (team_policies) Changed whether members can share files/folders outside team
showcase_change_download_policy TeamLogShowcaseChangeDownloadPolicyType <optional>
 Available if .tag is showcase_change_download_policy. (team_policies) Enabled/disabled downloading files from Dropbox Showcase for team
showcase_change_enabled_policy TeamLogShowcaseChangeEnabledPolicyType <optional>
 Available if .tag is showcase_change_enabled_policy. (team_policies) Enabled/disabled Dropbox Showcase for team
showcase_change_external_sharing_policy TeamLogShowcaseChangeExternalSharingPolicyType <optional>
 Available if .tag is showcase_change_external_sharing_policy. (team_policies) Enabled/disabled sharing Dropbox Showcase externally for team
smarter_smart_sync_policy_changed TeamLogSmarterSmartSyncPolicyChangedType <optional>
 Available if .tag is smarter_smart_sync_policy_changed. (team_policies) Changed automatic Smart Sync setting for team
smart_sync_change_policy TeamLogSmartSyncChangePolicyType <optional>
 Available if .tag is smart_sync_change_policy. (team_policies) Changed default Smart Sync setting for team members
smart_sync_not_opt_out TeamLogSmartSyncNotOptOutType <optional>
 Available if .tag is smart_sync_not_opt_out. (team_policies) Opted team into Smart Sync
smart_sync_opt_out TeamLogSmartSyncOptOutType <optional>
 Available if .tag is smart_sync_opt_out. (team_policies) Opted team out of Smart Sync
sso_change_policy TeamLogSsoChangePolicyType <optional>
 Available if .tag is sso_change_policy. (team_policies) Changed single sign-on setting for team
team_branding_policy_changed TeamLogTeamBrandingPolicyChangedType <optional>
 Available if .tag is team_branding_policy_changed. (team_policies) Changed team branding policy for team
team_extensions_policy_changed TeamLogTeamExtensionsPolicyChangedType <optional>
 Available if .tag is team_extensions_policy_changed. (team_policies) Changed App Integrations setting for team
team_selective_sync_policy_changed TeamLogTeamSelectiveSyncPolicyChangedType <optional>
 Available if .tag is team_selective_sync_policy_changed. (team_policies) Enabled/disabled Team Selective Sync for team
team_sharing_whitelist_subjects_changed TeamLogTeamSharingWhitelistSubjectsChangedType <optional>
 Available if .tag is team_sharing_whitelist_subjects_changed. (team_policies) Edited the approved list for sharing externally
tfa_add_exception TeamLogTfaAddExceptionType <optional>
 Available if .tag is tfa_add_exception. (team_policies) Added members to two factor authentication exception list
tfa_change_policy TeamLogTfaChangePolicyType <optional>
 Available if .tag is tfa_change_policy. (team_policies) Changed two-step verification setting for team
tfa_remove_exception TeamLogTfaRemoveExceptionType <optional>
 Available if .tag is tfa_remove_exception. (team_policies) Removed members from two factor authentication exception list
two_account_change_policy TeamLogTwoAccountChangePolicyType <optional>
 Available if .tag is two_account_change_policy. (team_policies) Enabled/disabled option for members to link personal Dropbox account and team account to same computer
viewer_info_policy_changed TeamLogViewerInfoPolicyChangedType <optional>
 Available if .tag is viewer_info_policy_changed. (team_policies) Changed team policy for viewer info
watermarking_policy_changed TeamLogWatermarkingPolicyChangedType <optional>
 Available if .tag is watermarking_policy_changed. (team_policies) Changed watermarking policy for team
web_sessions_change_active_session_limit TeamLogWebSessionsChangeActiveSessionLimitType <optional>
 Available if .tag is web_sessions_change_active_session_limit. (team_policies) Changed limit on active sessions per member
web_sessions_change_fixed_length_policy TeamLogWebSessionsChangeFixedLengthPolicyType <optional>
 Available if .tag is web_sessions_change_fixed_length_policy. (team_policies) Changed how long members can stay signed in to Dropbox.com
web_sessions_change_idle_length_policy TeamLogWebSessionsChangeIdleLengthPolicyType <optional>
 Available if .tag is web_sessions_change_idle_length_policy. (team_policies) Changed how long team members can be idle while signed in to Dropbox.com
data_residency_migration_request_successful TeamLogDataResidencyMigrationRequestSuccessfulType <optional>
 Available if .tag is data_residency_migration_request_successful. (team_profile) Requested data residency migration for team data
data_residency_migration_request_unsuccessful TeamLogDataResidencyMigrationRequestUnsuccessfulType <optional>
 Available if .tag is data_residency_migration_request_unsuccessful. (team_profile) Request for data residency migration for team data has failed
team_merge_from TeamLogTeamMergeFromType <optional>
 Available if .tag is team_merge_from. (team_profile) Merged another team into this team
team_merge_to TeamLogTeamMergeToType <optional>
 Available if .tag is team_merge_to. (team_profile) Merged this team into another team
team_profile_add_background TeamLogTeamProfileAddBackgroundType <optional>
 - Available if .tag is team_profile_add_background. (team_profile) Added team background to display on shared link headers
team_profile_add_logo TeamLogTeamProfileAddLogoType <optional>
 Available if .tag is team_profile_add_logo. (team_profile) Added team logo to display on shared link headers
team_profile_change_background TeamLogTeamProfileChangeBackgroundType <optional>
 Available if .tag is team_profile_change_background. (team_profile) Changed team background displayed on shared link headers
team_profile_change_default_language TeamLogTeamProfileChangeDefaultLanguageType <optional>
 Available if .tag is team_profile_change_default_language. (team_profile) Changed default language for team
team_profile_change_logo TeamLogTeamProfileChangeLogoType <optional>
 Available if .tag is team_profile_change_logo. (team_profile) Changed team logo displayed on shared link headers
team_profile_change_name TeamLogTeamProfileChangeNameType <optional>
 Available if .tag is team_profile_change_name. (team_profile) Changed team name
team_profile_remove_background TeamLogTeamProfileRemoveBackgroundType <optional>
 Available if .tag is team_profile_remove_background. (team_profile) Removed team background displayed on shared link headers
team_profile_remove_logo TeamLogTeamProfileRemoveLogoType <optional>
 Available if .tag is team_profile_remove_logo. (team_profile) Removed team logo displayed on shared link headers
tfa_add_backup_phone TeamLogTfaAddBackupPhoneType <optional>
 Available if .tag is tfa_add_backup_phone. (tfa) Added backup phone for two-step verification
tfa_add_security_key TeamLogTfaAddSecurityKeyType <optional>
 Available if .tag is tfa_add_security_key. (tfa) Added security key for two-step verification
tfa_change_backup_phone TeamLogTfaChangeBackupPhoneType <optional>
 Available if .tag is tfa_change_backup_phone. (tfa) Changed backup phone for two-step verification
tfa_change_status TeamLogTfaChangeStatusType <optional>
 Available if .tag is tfa_change_status. (tfa) Enabled/disabled/changed two-step verification setting
tfa_remove_backup_phone TeamLogTfaRemoveBackupPhoneType <optional>
 Available if .tag is tfa_remove_backup_phone. (tfa) Removed backup phone for two-step verification
tfa_remove_security_key TeamLogTfaRemoveSecurityKeyType <optional>
 Available if .tag is tfa_remove_security_key. (tfa) Removed security key for two-step verification
tfa_reset TeamLogTfaResetType <optional>
 Available if .tag is tfa_reset. (tfa) Reset two-step verification for team member
changed_enterprise_admin_role TeamLogChangedEnterpriseAdminRoleType <optional>
 Available if .tag is changed_enterprise_admin_role. (trusted_teams) Changed enterprise admin role
changed_enterprise_connected_team_status TeamLogChangedEnterpriseConnectedTeamStatusType <optional>
 Available if .tag is changed_enterprise_connected_team_status. (trusted_teams) Changed enterprise-connected team status
ended_enterprise_admin_session TeamLogEndedEnterpriseAdminSessionType <optional>
 Available if .tag is ended_enterprise_admin_session. (trusted_teams) Ended enterprise admin session
ended_enterprise_admin_session_deprecated TeamLogEndedEnterpriseAdminSessionDeprecatedType <optional>
 Available if .tag is ended_enterprise_admin_session_deprecated. (trusted_teams) Ended enterprise admin session (deprecated, replaced by 'Ended enterprise admin session')
enterprise_settings_locking TeamLogEnterpriseSettingsLockingType <optional>
 Available if .tag is enterprise_settings_locking. (trusted_teams) Changed who can update a setting
guest_admin_change_status TeamLogGuestAdminChangeStatusType <optional>
 Available if .tag is guest_admin_change_status. (trusted_teams) Changed guest team admin status
started_enterprise_admin_session TeamLogStartedEnterpriseAdminSessionType <optional>
 Available if .tag is started_enterprise_admin_session. (trusted_teams) Started enterprise admin session
team_merge_request_accepted TeamLogTeamMergeRequestAcceptedType <optional>
 - Available if .tag is team_merge_request_accepted. (trusted_teams) Accepted a team merge request
team_merge_request_accepted_shown_to_primary_team TeamLogTeamMergeRequestAcceptedShownToPrimaryTeamType <optional>
 Available if .tag is team_merge_request_accepted_shown_to_primary_team. (trusted_teams) Accepted a team merge request (deprecated, replaced by 'Accepted a team merge request')
team_merge_request_accepted_shown_to_secondary_team TeamLogTeamMergeRequestAcceptedShownToSecondaryTeamType <optional>
 Available if .tag is team_merge_request_accepted_shown_to_secondary_team. (trusted_teams) Accepted a team merge request (deprecated, replaced by 'Accepted a team merge request')
team_merge_request_auto_canceled TeamLogTeamMergeRequestAutoCanceledType <optional>
 Available if .tag is team_merge_request_auto_canceled. (trusted_teams) Automatically canceled team merge request
team_merge_request_canceled TeamLogTeamMergeRequestCanceledType <optional>
 - Available if .tag is team_merge_request_canceled. (trusted_teams) Canceled a team merge request
team_merge_request_canceled_shown_to_primary_team TeamLogTeamMergeRequestCanceledShownToPrimaryTeamType <optional>
 Available if .tag is team_merge_request_canceled_shown_to_primary_team. (trusted_teams) Canceled a team merge request (deprecated, replaced by 'Canceled a team merge request')
team_merge_request_canceled_shown_to_secondary_team TeamLogTeamMergeRequestCanceledShownToSecondaryTeamType <optional>
 Available if .tag is team_merge_request_canceled_shown_to_secondary_team. (trusted_teams) Canceled a team merge request (deprecated, replaced by 'Canceled a team merge request')
team_merge_request_expired TeamLogTeamMergeRequestExpiredType <optional>
 Available if .tag is team_merge_request_expired. (trusted_teams) Team merge request expired
team_merge_request_expired_shown_to_primary_team TeamLogTeamMergeRequestExpiredShownToPrimaryTeamType <optional>
 Available if .tag is team_merge_request_expired_shown_to_primary_team. (trusted_teams) Team merge request expired (deprecated, replaced by 'Team merge request expired')
team_merge_request_expired_shown_to_secondary_team TeamLogTeamMergeRequestExpiredShownToSecondaryTeamType <optional>
 Available if .tag is team_merge_request_expired_shown_to_secondary_team. (trusted_teams) Team merge request expired (deprecated, replaced by 'Team merge request expired')
team_merge_request_rejected_shown_to_primary_team TeamLogTeamMergeRequestRejectedShownToPrimaryTeamType <optional>
 Available if .tag is team_merge_request_rejected_shown_to_primary_team. (trusted_teams) Rejected a team merge request (deprecated, no longer logged)
team_merge_request_rejected_shown_to_secondary_team TeamLogTeamMergeRequestRejectedShownToSecondaryTeamType <optional>
 Available if .tag is team_merge_request_rejected_shown_to_secondary_team. (trusted_teams) Rejected a team merge request (deprecated, no longer logged)
team_merge_request_reminder TeamLogTeamMergeRequestReminderType <optional>
 - Available if .tag is team_merge_request_reminder. (trusted_teams) Sent a team merge request reminder
team_merge_request_reminder_shown_to_primary_team TeamLogTeamMergeRequestReminderShownToPrimaryTeamType <optional>
 Available if .tag is team_merge_request_reminder_shown_to_primary_team. (trusted_teams) Sent a team merge request reminder (deprecated, replaced by 'Sent a team merge request reminder')
team_merge_request_reminder_shown_to_secondary_team TeamLogTeamMergeRequestReminderShownToSecondaryTeamType <optional>
 Available if .tag is team_merge_request_reminder_shown_to_secondary_team. (trusted_teams) Sent a team merge request reminder (deprecated, replaced by 'Sent a team merge request reminder')
team_merge_request_revoked TeamLogTeamMergeRequestRevokedType <optional>
 Available if .tag is team_merge_request_revoked. (trusted_teams) Canceled the team merge
team_merge_request_sent_shown_to_primary_team TeamLogTeamMergeRequestSentShownToPrimaryTeamType <optional>
 Available if .tag is team_merge_request_sent_shown_to_primary_team. (trusted_teams) Requested to merge their Dropbox team into yours
team_merge_request_sent_shown_to_secondary_team TeamLogTeamMergeRequestSentShownToSecondaryTeamType <optional>
 Available if .tag is team_merge_request_sent_shown_to_secondary_team. (trusted_teams) Requested to merge your team into another Dropbox team
.tag 'admin_alerting_alert_state_changed' | 'admin_alerting_changed_alert_config' | 'admin_alerting_triggered_alert' | 'app_blocked_by_permissions' | 'app_link_team' | 'app_link_user' | 'app_unlink_team' | 'app_unlink_user' | 'integration_connected' | 'integration_disconnected' | 'file_add_comment' | 'file_change_comment_subscription' | 'file_delete_comment' | 'file_edit_comment' | 'file_like_comment' | 'file_resolve_comment' | 'file_unlike_comment' | 'file_unresolve_comment' | 'governance_policy_add_folders' | 'governance_policy_add_folder_failed' | 'governance_policy_content_disposed' | 'governance_policy_create' | 'governance_policy_delete' | 'governance_policy_edit_details' | 'governance_policy_edit_duration' | 'governance_policy_export_created' | 'governance_policy_export_removed' | 'governance_policy_remove_folders' | 'governance_policy_report_created' | 'governance_policy_zip_part_downloaded' | 'legal_holds_activate_a_hold' | 'legal_holds_add_members' | 'legal_holds_change_hold_details' | 'legal_holds_change_hold_name' | 'legal_holds_export_a_hold' | 'legal_holds_export_cancelled' | 'legal_holds_export_downloaded' | 'legal_holds_export_removed' | 'legal_holds_release_a_hold' | 'legal_holds_remove_members' | 'legal_holds_report_a_hold' | 'device_change_ip_desktop' | 'device_change_ip_mobile' | 'device_change_ip_web' | 'device_delete_on_unlink_fail' | 'device_delete_on_unlink_success' | 'device_link_fail' | 'device_link_success' | 'device_management_disabled' | 'device_management_enabled' | 'device_sync_backup_status_changed' | 'device_unlink' | 'dropbox_passwords_exported' | 'dropbox_passwords_new_device_enrolled' | 'emm_refresh_auth_token' | 'external_drive_backup_eligibility_status_checked' | 'external_drive_backup_status_changed' | 'account_capture_change_availability' | 'account_capture_migrate_account' | 'account_capture_notification_emails_sent' | 'account_capture_relinquish_account' | 'disabled_domain_invites' | 'domain_invites_approve_request_to_join_team' | 'domain_invites_decline_request_to_join_team' | 'domain_invites_email_existing_users' | 'domain_invites_request_to_join_team' | 'domain_invites_set_invite_new_user_pref_to_no' | 'domain_invites_set_invite_new_user_pref_to_yes' | 'domain_verification_add_domain_fail' | 'domain_verification_add_domain_success' | 'domain_verification_remove_domain' | 'enabled_domain_invites' | 'apply_naming_convention' | 'create_folder' | 'file_add' | 'file_copy' | 'file_delete' | 'file_download' | 'file_edit' | 'file_get_copy_reference' | 'file_locking_lock_status_changed' | 'file_move' | 'file_permanently_delete' | 'file_preview' | 'file_rename' | 'file_restore' | 'file_revert' | 'file_rollback_changes' | 'file_save_copy_reference' | 'folder_overview_description_changed' | 'folder_overview_item_pinned' | 'folder_overview_item_unpinned' | 'object_label_added' | 'object_label_removed' | 'object_label_updated_value' | 'organize_folder_with_tidy' | 'rewind_folder' | 'undo_naming_convention' | 'undo_organize_folder_with_tidy' | 'user_tags_added' | 'user_tags_removed' | 'email_ingest_receive_file' | 'file_request_change' | 'file_request_close' | 'file_request_create' | 'file_request_delete' | 'file_request_receive_file' | 'group_add_external_id' | 'group_add_member' | 'group_change_external_id' | 'group_change_management_type' | 'group_change_member_role' | 'group_create' | 'group_delete' | 'group_description_updated' | 'group_join_policy_updated' | 'group_moved' | 'group_remove_external_id' | 'group_remove_member' | 'group_rename' | 'account_lock_or_unlocked' | 'emm_error' | 'guest_admin_signed_in_via_trusted_teams' | 'guest_admin_signed_out_via_trusted_teams' | 'login_fail' | 'login_success' | 'logout' | 'reseller_support_session_end' | 'reseller_support_session_start' | 'sign_in_as_session_end' | 'sign_in_as_session_start' | 'sso_error' | 'create_team_invite_link' | 'delete_team_invite_link' | 'member_add_external_id' | 'member_add_name' | 'member_change_admin_role' | 'member_change_email' | 'member_change_external_id' | 'member_change_membership_type' | 'member_change_name' | 'member_change_reseller_role' | 'member_change_status' | 'member_delete_manual_contacts' | 'member_delete_profile_photo' | 'member_permanently_delete_account_contents' | 'member_remove_external_id' | 'member_set_profile_photo' | 'member_space_limits_add_custom_quota' | 'member_space_limits_change_custom_quota' | 'member_space_limits_change_status' | 'member_space_limits_remove_custom_quota' | 'member_suggest' | 'member_transfer_account_contents' | 'pending_secondary_email_added' | 'secondary_email_deleted' | 'secondary_email_verified' | 'secondary_mails_policy_changed' | 'binder_add_page' | 'binder_add_section' | 'binder_remove_page' | 'binder_remove_section' | 'binder_rename_page' | 'binder_rename_section' | 'binder_reorder_page' | 'binder_reorder_section' | 'paper_content_add_member' | 'paper_content_add_to_folder' | 'paper_content_archive' | 'paper_content_create' | 'paper_content_permanently_delete' | 'paper_content_remove_from_folder' | 'paper_content_remove_member' | 'paper_content_rename' | 'paper_content_restore' | 'paper_doc_add_comment' | 'paper_doc_change_member_role' | 'paper_doc_change_sharing_policy' | 'paper_doc_change_subscription' | 'paper_doc_deleted' | 'paper_doc_delete_comment' | 'paper_doc_download' | 'paper_doc_edit' | 'paper_doc_edit_comment' | 'paper_doc_followed' | 'paper_doc_mention' | 'paper_doc_ownership_changed' | 'paper_doc_request_access' | 'paper_doc_resolve_comment' | 'paper_doc_revert' | 'paper_doc_slack_share' | 'paper_doc_team_invite' | 'paper_doc_trashed' | 'paper_doc_unresolve_comment' | 'paper_doc_untrashed' | 'paper_doc_view' | 'paper_external_view_allow' | 'paper_external_view_default_team' | 'paper_external_view_forbid' | 'paper_folder_change_subscription' | 'paper_folder_deleted' | 'paper_folder_followed' | 'paper_folder_team_invite' | 'paper_published_link_change_permission' | 'paper_published_link_create' | 'paper_published_link_disabled' | 'paper_published_link_view' | 'password_change' | 'password_reset' | 'password_reset_all' | 'classification_create_report' | 'classification_create_report_fail' | 'emm_create_exceptions_report' | 'emm_create_usage_report' | 'export_members_report' | 'export_members_report_fail' | 'external_sharing_create_report' | 'external_sharing_report_failed' | 'no_expiration_link_gen_create_report' | 'no_expiration_link_gen_report_failed' | 'no_password_link_gen_create_report' | 'no_password_link_gen_report_failed' | 'no_password_link_view_create_report' | 'no_password_link_view_report_failed' | 'outdated_link_view_create_report' | 'outdated_link_view_report_failed' | 'paper_admin_export_start' | 'smart_sync_create_admin_privilege_report' | 'team_activity_create_report' | 'team_activity_create_report_fail' | 'collection_share' | 'file_transfers_file_add' | 'file_transfers_transfer_delete' | 'file_transfers_transfer_download' | 'file_transfers_transfer_send' | 'file_transfers_transfer_view' | 'note_acl_invite_only' | 'note_acl_link' | 'note_acl_team_link' | 'note_shared' | 'note_share_receive' | 'open_note_shared' | 'sf_add_group' | 'sf_allow_non_members_to_view_shared_links' | 'sf_external_invite_warn' | 'sf_fb_invite' | 'sf_fb_invite_change_role' | 'sf_fb_uninvite' | 'sf_invite_group' | 'sf_team_grant_access' | 'sf_team_invite' | 'sf_team_invite_change_role' | 'sf_team_join' | 'sf_team_join_from_oob_link' | 'sf_team_uninvite' | 'shared_content_add_invitees' | 'shared_content_add_link_expiry' | 'shared_content_add_link_password' | 'shared_content_add_member' | 'shared_content_change_downloads_policy' | 'shared_content_change_invitee_role' | 'shared_content_change_link_audience' | 'shared_content_change_link_expiry' | 'shared_content_change_link_password' | 'shared_content_change_member_role' | 'shared_content_change_viewer_info_policy' | 'shared_content_claim_invitation' | 'shared_content_copy' | 'shared_content_download' | 'shared_content_relinquish_membership' | 'shared_content_remove_invitees' | 'shared_content_remove_link_expiry' | 'shared_content_remove_link_password' | 'shared_content_remove_member' | 'shared_content_request_access' | 'shared_content_restore_invitees' | 'shared_content_restore_member' | 'shared_content_unshare' | 'shared_content_view' | 'shared_folder_change_link_policy' | 'shared_folder_change_members_inheritance_policy' | 'shared_folder_change_members_management_policy' | 'shared_folder_change_members_policy' | 'shared_folder_create' | 'shared_folder_decline_invitation' | 'shared_folder_mount' | 'shared_folder_nest' | 'shared_folder_transfer_ownership' | 'shared_folder_unmount' | 'shared_link_add_expiry' | 'shared_link_change_expiry' | 'shared_link_change_visibility' | 'shared_link_copy' | 'shared_link_create' | 'shared_link_disable' | 'shared_link_download' | 'shared_link_remove_expiry' | 'shared_link_settings_add_expiration' | 'shared_link_settings_add_password' | 'shared_link_settings_allow_download_disabled' | 'shared_link_settings_allow_download_enabled' | 'shared_link_settings_change_audience' | 'shared_link_settings_change_expiration' | 'shared_link_settings_change_password' | 'shared_link_settings_remove_expiration' | 'shared_link_settings_remove_password' | 'shared_link_share' | 'shared_link_view' | 'shared_note_opened' | 'shmodel_disable_downloads' | 'shmodel_enable_downloads' | 'shmodel_group_share' | 'showcase_access_granted' | 'showcase_add_member' | 'showcase_archived' | 'showcase_created' | 'showcase_delete_comment' | 'showcase_edited' | 'showcase_edit_comment' | 'showcase_file_added' | 'showcase_file_download' | 'showcase_file_removed' | 'showcase_file_view' | 'showcase_permanently_deleted' | 'showcase_post_comment' | 'showcase_remove_member' | 'showcase_renamed' | 'showcase_request_access' | 'showcase_resolve_comment' | 'showcase_restored' | 'showcase_trashed' | 'showcase_trashed_deprecated' | 'showcase_unresolve_comment' | 'showcase_untrashed' | 'showcase_untrashed_deprecated' | 'showcase_view' | 'sso_add_cert' | 'sso_add_login_url' | 'sso_add_logout_url' | 'sso_change_cert' | 'sso_change_login_url' | 'sso_change_logout_url' | 'sso_change_saml_identity_mode' | 'sso_remove_cert' | 'sso_remove_login_url' | 'sso_remove_logout_url' | 'team_folder_change_status' | 'team_folder_create' | 'team_folder_downgrade' | 'team_folder_permanently_delete' | 'team_folder_rename' | 'team_selective_sync_settings_changed' | 'account_capture_change_policy' | 'admin_email_reminders_changed' | 'allow_download_disabled' | 'allow_download_enabled' | 'app_permissions_changed' | 'camera_uploads_policy_changed' | 'capture_transcript_policy_changed' | 'classification_change_policy' | 'computer_backup_policy_changed' | 'content_administration_policy_changed' | 'data_placement_restriction_change_policy' | 'data_placement_restriction_satisfy_policy' | 'device_approvals_add_exception' | 'device_approvals_change_desktop_policy' | 'device_approvals_change_mobile_policy' | 'device_approvals_change_overage_action' | 'device_approvals_change_unlink_action' | 'device_approvals_remove_exception' | 'directory_restrictions_add_members' | 'directory_restrictions_remove_members' | 'dropbox_passwords_policy_changed' | 'email_ingest_policy_changed' | 'emm_add_exception' | 'emm_change_policy' | 'emm_remove_exception' | 'extended_version_history_change_policy' | 'external_drive_backup_policy_changed' | 'file_comments_change_policy' | 'file_locking_policy_changed' | 'file_provider_migration_policy_changed' | 'file_requests_change_policy' | 'file_requests_emails_enabled' | 'file_requests_emails_restricted_to_team_only' | 'file_transfers_policy_changed' | 'folder_link_restriction_policy_changed' | 'google_sso_change_policy' | 'group_user_management_change_policy' | 'integration_policy_changed' | 'invite_acceptance_email_policy_changed' | 'member_requests_change_policy' | 'member_send_invite_policy_changed' | 'member_space_limits_add_exception' | 'member_space_limits_change_caps_type_policy' | 'member_space_limits_change_policy' | 'member_space_limits_remove_exception' | 'member_suggestions_change_policy' | 'microsoft_office_addin_change_policy' | 'network_control_change_policy' | 'paper_change_deployment_policy' | 'paper_change_member_link_policy' | 'paper_change_member_policy' | 'paper_change_policy' | 'paper_default_folder_policy_changed' | 'paper_desktop_policy_changed' | 'paper_enabled_users_group_addition' | 'paper_enabled_users_group_removal' | 'password_strength_requirements_change_policy' | 'permanent_delete_change_policy' | 'reseller_support_change_policy' | 'rewind_policy_changed' | 'send_for_signature_policy_changed' | 'sharing_change_folder_join_policy' | 'sharing_change_link_allow_change_expiration_policy' | 'sharing_change_link_default_expiration_policy' | 'sharing_change_link_enforce_password_policy' | 'sharing_change_link_policy' | 'sharing_change_member_policy' | 'showcase_change_download_policy' | 'showcase_change_enabled_policy' | 'showcase_change_external_sharing_policy' | 'smarter_smart_sync_policy_changed' | 'smart_sync_change_policy' | 'smart_sync_not_opt_out' | 'smart_sync_opt_out' | 'sso_change_policy' | 'team_branding_policy_changed' | 'team_extensions_policy_changed' | 'team_selective_sync_policy_changed' | 'team_sharing_whitelist_subjects_changed' | 'tfa_add_exception' | 'tfa_change_policy' | 'tfa_remove_exception' | 'two_account_change_policy' | 'viewer_info_policy_changed' | 'watermarking_policy_changed' | 'web_sessions_change_active_session_limit' | 'web_sessions_change_fixed_length_policy' | 'web_sessions_change_idle_length_policy' | 'data_residency_migration_request_successful' | 'data_residency_migration_request_unsuccessful' | 'team_merge_from' | 'team_merge_to' | 'team_profile_add_background' | 'team_profile_add_logo' | 'team_profile_change_background' | 'team_profile_change_default_language' | 'team_profile_change_logo' | 'team_profile_change_name' | 'team_profile_remove_background' | 'team_profile_remove_logo' | 'tfa_add_backup_phone' | 'tfa_add_security_key' | 'tfa_change_backup_phone' | 'tfa_change_status' | 'tfa_remove_backup_phone' | 'tfa_remove_security_key' | 'tfa_reset' | 'changed_enterprise_admin_role' | 'changed_enterprise_connected_team_status' | 'ended_enterprise_admin_session' | 'ended_enterprise_admin_session_deprecated' | 'enterprise_settings_locking' | 'guest_admin_change_status' | 'started_enterprise_admin_session' | 'team_merge_request_accepted' | 'team_merge_request_accepted_shown_to_primary_team' | 'team_merge_request_accepted_shown_to_secondary_team' | 'team_merge_request_auto_canceled' | 'team_merge_request_canceled' | 'team_merge_request_canceled_shown_to_primary_team' | 'team_merge_request_canceled_shown_to_secondary_team' | 'team_merge_request_expired' | 'team_merge_request_expired_shown_to_primary_team' | 'team_merge_request_expired_shown_to_secondary_team' | 'team_merge_request_rejected_shown_to_primary_team' | 'team_merge_request_rejected_shown_to_secondary_team' | 'team_merge_request_reminder' | 'team_merge_request_reminder_shown_to_primary_team' | 'team_merge_request_reminder_shown_to_secondary_team' | 'team_merge_request_revoked' | 'team_merge_request_sent_shown_to_primary_team' | 'team_merge_request_sent_shown_to_secondary_team' | 'other' Tag identifying the union variant.

TeamLogEventTypeArg

The type of the event.
Type:
  • Object
Properties:
Name Type Description
.tag 'admin_alerting_alert_state_changed' | 'admin_alerting_changed_alert_config' | 'admin_alerting_triggered_alert' | 'app_blocked_by_permissions' | 'app_link_team' | 'app_link_user' | 'app_unlink_team' | 'app_unlink_user' | 'integration_connected' | 'integration_disconnected' | 'file_add_comment' | 'file_change_comment_subscription' | 'file_delete_comment' | 'file_edit_comment' | 'file_like_comment' | 'file_resolve_comment' | 'file_unlike_comment' | 'file_unresolve_comment' | 'governance_policy_add_folders' | 'governance_policy_add_folder_failed' | 'governance_policy_content_disposed' | 'governance_policy_create' | 'governance_policy_delete' | 'governance_policy_edit_details' | 'governance_policy_edit_duration' | 'governance_policy_export_created' | 'governance_policy_export_removed' | 'governance_policy_remove_folders' | 'governance_policy_report_created' | 'governance_policy_zip_part_downloaded' | 'legal_holds_activate_a_hold' | 'legal_holds_add_members' | 'legal_holds_change_hold_details' | 'legal_holds_change_hold_name' | 'legal_holds_export_a_hold' | 'legal_holds_export_cancelled' | 'legal_holds_export_downloaded' | 'legal_holds_export_removed' | 'legal_holds_release_a_hold' | 'legal_holds_remove_members' | 'legal_holds_report_a_hold' | 'device_change_ip_desktop' | 'device_change_ip_mobile' | 'device_change_ip_web' | 'device_delete_on_unlink_fail' | 'device_delete_on_unlink_success' | 'device_link_fail' | 'device_link_success' | 'device_management_disabled' | 'device_management_enabled' | 'device_sync_backup_status_changed' | 'device_unlink' | 'dropbox_passwords_exported' | 'dropbox_passwords_new_device_enrolled' | 'emm_refresh_auth_token' | 'external_drive_backup_eligibility_status_checked' | 'external_drive_backup_status_changed' | 'account_capture_change_availability' | 'account_capture_migrate_account' | 'account_capture_notification_emails_sent' | 'account_capture_relinquish_account' | 'disabled_domain_invites' | 'domain_invites_approve_request_to_join_team' | 'domain_invites_decline_request_to_join_team' | 'domain_invites_email_existing_users' | 'domain_invites_request_to_join_team' | 'domain_invites_set_invite_new_user_pref_to_no' | 'domain_invites_set_invite_new_user_pref_to_yes' | 'domain_verification_add_domain_fail' | 'domain_verification_add_domain_success' | 'domain_verification_remove_domain' | 'enabled_domain_invites' | 'apply_naming_convention' | 'create_folder' | 'file_add' | 'file_copy' | 'file_delete' | 'file_download' | 'file_edit' | 'file_get_copy_reference' | 'file_locking_lock_status_changed' | 'file_move' | 'file_permanently_delete' | 'file_preview' | 'file_rename' | 'file_restore' | 'file_revert' | 'file_rollback_changes' | 'file_save_copy_reference' | 'folder_overview_description_changed' | 'folder_overview_item_pinned' | 'folder_overview_item_unpinned' | 'object_label_added' | 'object_label_removed' | 'object_label_updated_value' | 'organize_folder_with_tidy' | 'rewind_folder' | 'undo_naming_convention' | 'undo_organize_folder_with_tidy' | 'user_tags_added' | 'user_tags_removed' | 'email_ingest_receive_file' | 'file_request_change' | 'file_request_close' | 'file_request_create' | 'file_request_delete' | 'file_request_receive_file' | 'group_add_external_id' | 'group_add_member' | 'group_change_external_id' | 'group_change_management_type' | 'group_change_member_role' | 'group_create' | 'group_delete' | 'group_description_updated' | 'group_join_policy_updated' | 'group_moved' | 'group_remove_external_id' | 'group_remove_member' | 'group_rename' | 'account_lock_or_unlocked' | 'emm_error' | 'guest_admin_signed_in_via_trusted_teams' | 'guest_admin_signed_out_via_trusted_teams' | 'login_fail' | 'login_success' | 'logout' | 'reseller_support_session_end' | 'reseller_support_session_start' | 'sign_in_as_session_end' | 'sign_in_as_session_start' | 'sso_error' | 'create_team_invite_link' | 'delete_team_invite_link' | 'member_add_external_id' | 'member_add_name' | 'member_change_admin_role' | 'member_change_email' | 'member_change_external_id' | 'member_change_membership_type' | 'member_change_name' | 'member_change_reseller_role' | 'member_change_status' | 'member_delete_manual_contacts' | 'member_delete_profile_photo' | 'member_permanently_delete_account_contents' | 'member_remove_external_id' | 'member_set_profile_photo' | 'member_space_limits_add_custom_quota' | 'member_space_limits_change_custom_quota' | 'member_space_limits_change_status' | 'member_space_limits_remove_custom_quota' | 'member_suggest' | 'member_transfer_account_contents' | 'pending_secondary_email_added' | 'secondary_email_deleted' | 'secondary_email_verified' | 'secondary_mails_policy_changed' | 'binder_add_page' | 'binder_add_section' | 'binder_remove_page' | 'binder_remove_section' | 'binder_rename_page' | 'binder_rename_section' | 'binder_reorder_page' | 'binder_reorder_section' | 'paper_content_add_member' | 'paper_content_add_to_folder' | 'paper_content_archive' | 'paper_content_create' | 'paper_content_permanently_delete' | 'paper_content_remove_from_folder' | 'paper_content_remove_member' | 'paper_content_rename' | 'paper_content_restore' | 'paper_doc_add_comment' | 'paper_doc_change_member_role' | 'paper_doc_change_sharing_policy' | 'paper_doc_change_subscription' | 'paper_doc_deleted' | 'paper_doc_delete_comment' | 'paper_doc_download' | 'paper_doc_edit' | 'paper_doc_edit_comment' | 'paper_doc_followed' | 'paper_doc_mention' | 'paper_doc_ownership_changed' | 'paper_doc_request_access' | 'paper_doc_resolve_comment' | 'paper_doc_revert' | 'paper_doc_slack_share' | 'paper_doc_team_invite' | 'paper_doc_trashed' | 'paper_doc_unresolve_comment' | 'paper_doc_untrashed' | 'paper_doc_view' | 'paper_external_view_allow' | 'paper_external_view_default_team' | 'paper_external_view_forbid' | 'paper_folder_change_subscription' | 'paper_folder_deleted' | 'paper_folder_followed' | 'paper_folder_team_invite' | 'paper_published_link_change_permission' | 'paper_published_link_create' | 'paper_published_link_disabled' | 'paper_published_link_view' | 'password_change' | 'password_reset' | 'password_reset_all' | 'classification_create_report' | 'classification_create_report_fail' | 'emm_create_exceptions_report' | 'emm_create_usage_report' | 'export_members_report' | 'export_members_report_fail' | 'external_sharing_create_report' | 'external_sharing_report_failed' | 'no_expiration_link_gen_create_report' | 'no_expiration_link_gen_report_failed' | 'no_password_link_gen_create_report' | 'no_password_link_gen_report_failed' | 'no_password_link_view_create_report' | 'no_password_link_view_report_failed' | 'outdated_link_view_create_report' | 'outdated_link_view_report_failed' | 'paper_admin_export_start' | 'smart_sync_create_admin_privilege_report' | 'team_activity_create_report' | 'team_activity_create_report_fail' | 'collection_share' | 'file_transfers_file_add' | 'file_transfers_transfer_delete' | 'file_transfers_transfer_download' | 'file_transfers_transfer_send' | 'file_transfers_transfer_view' | 'note_acl_invite_only' | 'note_acl_link' | 'note_acl_team_link' | 'note_shared' | 'note_share_receive' | 'open_note_shared' | 'sf_add_group' | 'sf_allow_non_members_to_view_shared_links' | 'sf_external_invite_warn' | 'sf_fb_invite' | 'sf_fb_invite_change_role' | 'sf_fb_uninvite' | 'sf_invite_group' | 'sf_team_grant_access' | 'sf_team_invite' | 'sf_team_invite_change_role' | 'sf_team_join' | 'sf_team_join_from_oob_link' | 'sf_team_uninvite' | 'shared_content_add_invitees' | 'shared_content_add_link_expiry' | 'shared_content_add_link_password' | 'shared_content_add_member' | 'shared_content_change_downloads_policy' | 'shared_content_change_invitee_role' | 'shared_content_change_link_audience' | 'shared_content_change_link_expiry' | 'shared_content_change_link_password' | 'shared_content_change_member_role' | 'shared_content_change_viewer_info_policy' | 'shared_content_claim_invitation' | 'shared_content_copy' | 'shared_content_download' | 'shared_content_relinquish_membership' | 'shared_content_remove_invitees' | 'shared_content_remove_link_expiry' | 'shared_content_remove_link_password' | 'shared_content_remove_member' | 'shared_content_request_access' | 'shared_content_restore_invitees' | 'shared_content_restore_member' | 'shared_content_unshare' | 'shared_content_view' | 'shared_folder_change_link_policy' | 'shared_folder_change_members_inheritance_policy' | 'shared_folder_change_members_management_policy' | 'shared_folder_change_members_policy' | 'shared_folder_create' | 'shared_folder_decline_invitation' | 'shared_folder_mount' | 'shared_folder_nest' | 'shared_folder_transfer_ownership' | 'shared_folder_unmount' | 'shared_link_add_expiry' | 'shared_link_change_expiry' | 'shared_link_change_visibility' | 'shared_link_copy' | 'shared_link_create' | 'shared_link_disable' | 'shared_link_download' | 'shared_link_remove_expiry' | 'shared_link_settings_add_expiration' | 'shared_link_settings_add_password' | 'shared_link_settings_allow_download_disabled' | 'shared_link_settings_allow_download_enabled' | 'shared_link_settings_change_audience' | 'shared_link_settings_change_expiration' | 'shared_link_settings_change_password' | 'shared_link_settings_remove_expiration' | 'shared_link_settings_remove_password' | 'shared_link_share' | 'shared_link_view' | 'shared_note_opened' | 'shmodel_disable_downloads' | 'shmodel_enable_downloads' | 'shmodel_group_share' | 'showcase_access_granted' | 'showcase_add_member' | 'showcase_archived' | 'showcase_created' | 'showcase_delete_comment' | 'showcase_edited' | 'showcase_edit_comment' | 'showcase_file_added' | 'showcase_file_download' | 'showcase_file_removed' | 'showcase_file_view' | 'showcase_permanently_deleted' | 'showcase_post_comment' | 'showcase_remove_member' | 'showcase_renamed' | 'showcase_request_access' | 'showcase_resolve_comment' | 'showcase_restored' | 'showcase_trashed' | 'showcase_trashed_deprecated' | 'showcase_unresolve_comment' | 'showcase_untrashed' | 'showcase_untrashed_deprecated' | 'showcase_view' | 'sso_add_cert' | 'sso_add_login_url' | 'sso_add_logout_url' | 'sso_change_cert' | 'sso_change_login_url' | 'sso_change_logout_url' | 'sso_change_saml_identity_mode' | 'sso_remove_cert' | 'sso_remove_login_url' | 'sso_remove_logout_url' | 'team_folder_change_status' | 'team_folder_create' | 'team_folder_downgrade' | 'team_folder_permanently_delete' | 'team_folder_rename' | 'team_selective_sync_settings_changed' | 'account_capture_change_policy' | 'admin_email_reminders_changed' | 'allow_download_disabled' | 'allow_download_enabled' | 'app_permissions_changed' | 'camera_uploads_policy_changed' | 'capture_transcript_policy_changed' | 'classification_change_policy' | 'computer_backup_policy_changed' | 'content_administration_policy_changed' | 'data_placement_restriction_change_policy' | 'data_placement_restriction_satisfy_policy' | 'device_approvals_add_exception' | 'device_approvals_change_desktop_policy' | 'device_approvals_change_mobile_policy' | 'device_approvals_change_overage_action' | 'device_approvals_change_unlink_action' | 'device_approvals_remove_exception' | 'directory_restrictions_add_members' | 'directory_restrictions_remove_members' | 'dropbox_passwords_policy_changed' | 'email_ingest_policy_changed' | 'emm_add_exception' | 'emm_change_policy' | 'emm_remove_exception' | 'extended_version_history_change_policy' | 'external_drive_backup_policy_changed' | 'file_comments_change_policy' | 'file_locking_policy_changed' | 'file_provider_migration_policy_changed' | 'file_requests_change_policy' | 'file_requests_emails_enabled' | 'file_requests_emails_restricted_to_team_only' | 'file_transfers_policy_changed' | 'folder_link_restriction_policy_changed' | 'google_sso_change_policy' | 'group_user_management_change_policy' | 'integration_policy_changed' | 'invite_acceptance_email_policy_changed' | 'member_requests_change_policy' | 'member_send_invite_policy_changed' | 'member_space_limits_add_exception' | 'member_space_limits_change_caps_type_policy' | 'member_space_limits_change_policy' | 'member_space_limits_remove_exception' | 'member_suggestions_change_policy' | 'microsoft_office_addin_change_policy' | 'network_control_change_policy' | 'paper_change_deployment_policy' | 'paper_change_member_link_policy' | 'paper_change_member_policy' | 'paper_change_policy' | 'paper_default_folder_policy_changed' | 'paper_desktop_policy_changed' | 'paper_enabled_users_group_addition' | 'paper_enabled_users_group_removal' | 'password_strength_requirements_change_policy' | 'permanent_delete_change_policy' | 'reseller_support_change_policy' | 'rewind_policy_changed' | 'send_for_signature_policy_changed' | 'sharing_change_folder_join_policy' | 'sharing_change_link_allow_change_expiration_policy' | 'sharing_change_link_default_expiration_policy' | 'sharing_change_link_enforce_password_policy' | 'sharing_change_link_policy' | 'sharing_change_member_policy' | 'showcase_change_download_policy' | 'showcase_change_enabled_policy' | 'showcase_change_external_sharing_policy' | 'smarter_smart_sync_policy_changed' | 'smart_sync_change_policy' | 'smart_sync_not_opt_out' | 'smart_sync_opt_out' | 'sso_change_policy' | 'team_branding_policy_changed' | 'team_extensions_policy_changed' | 'team_selective_sync_policy_changed' | 'team_sharing_whitelist_subjects_changed' | 'tfa_add_exception' | 'tfa_change_policy' | 'tfa_remove_exception' | 'two_account_change_policy' | 'viewer_info_policy_changed' | 'watermarking_policy_changed' | 'web_sessions_change_active_session_limit' | 'web_sessions_change_fixed_length_policy' | 'web_sessions_change_idle_length_policy' | 'data_residency_migration_request_successful' | 'data_residency_migration_request_unsuccessful' | 'team_merge_from' | 'team_merge_to' | 'team_profile_add_background' | 'team_profile_add_logo' | 'team_profile_change_background' | 'team_profile_change_default_language' | 'team_profile_change_logo' | 'team_profile_change_name' | 'team_profile_remove_background' | 'team_profile_remove_logo' | 'tfa_add_backup_phone' | 'tfa_add_security_key' | 'tfa_change_backup_phone' | 'tfa_change_status' | 'tfa_remove_backup_phone' | 'tfa_remove_security_key' | 'tfa_reset' | 'changed_enterprise_admin_role' | 'changed_enterprise_connected_team_status' | 'ended_enterprise_admin_session' | 'ended_enterprise_admin_session_deprecated' | 'enterprise_settings_locking' | 'guest_admin_change_status' | 'started_enterprise_admin_session' | 'team_merge_request_accepted' | 'team_merge_request_accepted_shown_to_primary_team' | 'team_merge_request_accepted_shown_to_secondary_team' | 'team_merge_request_auto_canceled' | 'team_merge_request_canceled' | 'team_merge_request_canceled_shown_to_primary_team' | 'team_merge_request_canceled_shown_to_secondary_team' | 'team_merge_request_expired' | 'team_merge_request_expired_shown_to_primary_team' | 'team_merge_request_expired_shown_to_secondary_team' | 'team_merge_request_rejected_shown_to_primary_team' | 'team_merge_request_rejected_shown_to_secondary_team' | 'team_merge_request_reminder' | 'team_merge_request_reminder_shown_to_primary_team' | 'team_merge_request_reminder_shown_to_secondary_team' | 'team_merge_request_revoked' | 'team_merge_request_sent_shown_to_primary_team' | 'team_merge_request_sent_shown_to_secondary_team' | 'other' Tag identifying the union variant.

TeamLogExportMembersReportDetails

Created member data report.
Type:
  • Object

TeamLogExportMembersReportFailDetails

Failed to create members data report.
Type:
  • Object
Properties:
Name Type Description
failure_reason TeamTeamReportFailureReason Failure reason.

TeamLogExportMembersReportFailType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogExportMembersReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogExtendedVersionHistoryChangePolicyDetails

Accepted/opted out of extended version history.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogExtendedVersionHistoryPolicy New extended version history policy.
previous_value TeamLogExtendedVersionHistoryPolicy <optional>
 Previous extended version history policy. Might be missing due to historical data gap.

TeamLogExtendedVersionHistoryChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogExtendedVersionHistoryPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'explicitly_limited' | 'explicitly_unlimited' | 'implicitly_limited' | 'implicitly_unlimited' | 'other' Tag identifying the union variant.

TeamLogExternalDriveBackupEligibilityStatus

External Drive Backup eligibility status
Type:
  • Object
Properties:
Name Type Description
.tag 'exceed_license_cap' | 'success' | 'other' Tag identifying the union variant.

TeamLogExternalDriveBackupEligibilityStatusCheckedDetails

Checked external drive backup eligibility status.
Type:
  • Object
Properties:
Name Type Description
desktop_device_session_info TeamLogDesktopDeviceSessionLogInfo Device's session logged information.
status TeamLogExternalDriveBackupEligibilityStatus Current eligibility status of external drive backup.
number_of_external_drive_backup number Total number of valid external drive backup for all the team members.

TeamLogExternalDriveBackupEligibilityStatusCheckedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogExternalDriveBackupPolicy

Policy for controlling team access to external drive backup feature
Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogExternalDriveBackupPolicyChangedDetails

Changed external drive backup policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogExternalDriveBackupPolicy New external drive backup policy.
previous_value TeamLogExternalDriveBackupPolicy Previous external drive backup policy.

TeamLogExternalDriveBackupPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogExternalDriveBackupStatus

External Drive Backup status
Type:
  • Object
Properties:
Name Type Description
.tag 'broken' | 'created' | 'created_or_broken' | 'deleted' | 'empty' | 'unknown' | 'other' Tag identifying the union variant.

TeamLogExternalDriveBackupStatusChangedDetails

Modified external drive backup.
Type:
  • Object
Properties:
Name Type Description
desktop_device_session_info TeamLogDesktopDeviceSessionLogInfo Device's session logged information.
previous_value TeamLogExternalDriveBackupStatus Previous status of this external drive backup.
new_value TeamLogExternalDriveBackupStatus Next status of this external drive backup.

TeamLogExternalDriveBackupStatusChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogExternalSharingCreateReportDetails

Created External sharing report.
Type:
  • Object

TeamLogExternalSharingCreateReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogExternalSharingReportFailedDetails

Couldn't create External sharing report.
Type:
  • Object
Properties:
Name Type Description
failure_reason TeamTeamReportFailureReason Failure reason.

TeamLogExternalSharingReportFailedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogExternalUserLogInfo

A user without a Dropbox account.
Type:
  • Object
Properties:
Name Type Description
user_identifier string An external user identifier.
identifier_type TeamLogIdentifierType Identifier type.

TeamLogFailureDetailsLogInfo

Provides details about a failure
Type:
  • Object
Properties:
Name Type Argument Description
user_friendly_message string <optional>
 A user friendly explanation of the error.
technical_error_message string <optional>
 A technical explanation of the error. This is relevant for some errors.

TeamLogFedAdminRole

Type:
  • Object
Properties:
Name Type Description
.tag 'enterprise_admin' | 'not_enterprise_admin' | 'other' Tag identifying the union variant.

TeamLogFederationStatusChangeAdditionalInfo

Additional information about the organization or connected team
Type:
  • Object
Properties:
Name Type Argument Description
connected_team_name TeamLogConnectedTeamName <optional>
 Available if .tag is connected_team_name. The name of the team.
non_trusted_team_details TeamLogNonTrustedTeamDetails <optional>
 Available if .tag is non_trusted_team_details. The email to which the request was sent.
organization_name TeamLogOrganizationName <optional>
 Available if .tag is organization_name. The name of the organization.
.tag 'connected_team_name' | 'non_trusted_team_details' | 'organization_name' | 'other' Tag identifying the union variant.

TeamLogFedExtraDetails

More details about the organization or team.
Type:
  • Object
Properties:
Name Type Argument Description
organization TeamLogOrganizationDetails <optional>
 Available if .tag is organization. More details about the organization.
team TeamLogTeamDetails <optional>
 Available if .tag is team. More details about the team.
.tag 'organization' | 'team' | 'other' Tag identifying the union variant.

TeamLogFedHandshakeAction

Type:
  • Object
Properties:
Name Type Description
.tag 'accepted_invite' | 'canceled_invite' | 'invite_expired' | 'invited' | 'rejected_invite' | 'removed_team' | 'other' Tag identifying the union variant.

TeamLogFileAddCommentDetails

Added file comment.
Type:
  • Object
Properties:
Name Type Argument Description
comment_text string <optional>
 Comment text.

TeamLogFileAddCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileAddDetails

Added files and/or folders.
Type:
  • Object

TeamLogFileAddType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileChangeCommentSubscriptionDetails

Subscribed to or unsubscribed from comment notifications for file.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogFileCommentNotificationPolicy New file comment subscription.
previous_value TeamLogFileCommentNotificationPolicy <optional>
 Previous file comment subscription. Might be missing due to historical data gap.

TeamLogFileChangeCommentSubscriptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileCommentNotificationPolicy

Enable or disable file comments notifications
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogFileCommentsChangePolicyDetails

Enabled/disabled commenting on team files.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogFileCommentsPolicy New commenting on team files policy.
previous_value TeamLogFileCommentsPolicy <optional>
 Previous commenting on team files policy. Might be missing due to historical data gap.

TeamLogFileCommentsChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileCommentsPolicy

File comments policy
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogFileCopyDetails

Copied files and/or folders.
Type:
  • Object
Properties:
Name Type Description
relocate_action_details Array.<TeamLogRelocateAssetReferencesLogInfo> Relocate action details.

TeamLogFileCopyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileDeleteCommentDetails

Deleted file comment.
Type:
  • Object
Properties:
Name Type Argument Description
comment_text string <optional>
 Comment text.

TeamLogFileDeleteCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileDeleteDetails

Deleted files and/or folders.
Type:
  • Object

TeamLogFileDeleteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileDownloadDetails

Downloaded files and/or folders.
Type:
  • Object

TeamLogFileDownloadType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileEditCommentDetails

Edited file comment.
Type:
  • Object
Properties:
Name Type Argument Description
previous_comment_text string Previous comment text.
comment_text string <optional>
 Comment text.

TeamLogFileEditCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileEditDetails

Edited files.
Type:
  • Object

TeamLogFileEditType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileGetCopyReferenceDetails

Created copy reference to file/folder.
Type:
  • Object

TeamLogFileGetCopyReferenceType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileLikeCommentDetails

Liked file comment.
Type:
  • Object
Properties:
Name Type Argument Description
comment_text string <optional>
 Comment text.

TeamLogFileLikeCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileLockingLockStatusChangedDetails

Locked/unlocked editing for a file.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogLockStatus Previous lock status of the file.
new_value TeamLogLockStatus New lock status of the file.

TeamLogFileLockingLockStatusChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileLockingPolicyChangedDetails

Changed file locking policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamPoliciesFileLockingPolicyState New file locking policy.
previous_value TeamPoliciesFileLockingPolicyState Previous file locking policy.

TeamLogFileLockingPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileLogInfo

File's logged information.
Type:
  • Object
Properties:
Name Type Argument Description
path TeamLogPathLogInfo Path relative to event context.
display_name string <optional>
 Display name.
file_id string <optional>
 Unique ID.
file_size number <optional>
 File or folder size in bytes.

TeamLogFileMoveDetails

Moved files and/or folders.
Type:
  • Object
Properties:
Name Type Description
relocate_action_details Array.<TeamLogRelocateAssetReferencesLogInfo> Relocate action details.

TeamLogFileMoveType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileOrFolderLogInfo

Generic information relevant both for files and folders
Type:
  • Object
Properties:
Name Type Argument Description
path TeamLogPathLogInfo Path relative to event context.
display_name string <optional>
 Display name.
file_id string <optional>
 Unique ID.
file_size number <optional>
 File or folder size in bytes.

TeamLogFilePermanentlyDeleteDetails

Permanently deleted files and/or folders.
Type:
  • Object

TeamLogFilePermanentlyDeleteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFilePreviewDetails

Previewed files and/or folders.
Type:
  • Object

TeamLogFilePreviewType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileProviderMigrationPolicyChangedDetails

Changed File Provider Migration policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamPoliciesFileProviderMigrationPolicyState To.
previous_value TeamPoliciesFileProviderMigrationPolicyState From.

TeamLogFileProviderMigrationPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRenameDetails

Renamed files and/or folders.
Type:
  • Object
Properties:
Name Type Description
relocate_action_details Array.<TeamLogRelocateAssetReferencesLogInfo> Relocate action details.

TeamLogFileRenameType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRequestChangeDetails

Changed file request.
Type:
  • Object
Properties:
Name Type Argument Description
new_details TeamLogFileRequestDetails New file request details.
file_request_id string <optional>
 File request id. Might be missing due to historical data gap.
previous_details TeamLogFileRequestDetails <optional>
 Previous file request details. Might be missing due to historical data gap.

TeamLogFileRequestChangeType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRequestCloseDetails

Closed file request.
Type:
  • Object
Properties:
Name Type Argument Description
file_request_id string <optional>
 File request id. Might be missing due to historical data gap.
previous_details TeamLogFileRequestDetails <optional>
 Previous file request details. Might be missing due to historical data gap.

TeamLogFileRequestCloseType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRequestCreateDetails

Created file request.
Type:
  • Object
Properties:
Name Type Argument Description
file_request_id string <optional>
 File request id. Might be missing due to historical data gap.
request_details TeamLogFileRequestDetails <optional>
 File request details. Might be missing due to historical data gap.

TeamLogFileRequestCreateType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRequestDeadline

File request deadline
Type:
  • Object
Properties:
Name Type Argument Description
deadline Timestamp <optional>
 The deadline for this file request. Might be missing due to historical data gap.
allow_late_uploads string <optional>
 If set, allow uploads after the deadline has passed.

TeamLogFileRequestDeleteDetails

Delete file request.
Type:
  • Object
Properties:
Name Type Argument Description
file_request_id string <optional>
 File request id. Might be missing due to historical data gap.
previous_details TeamLogFileRequestDetails <optional>
 Previous file request details. Might be missing due to historical data gap.

TeamLogFileRequestDeleteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRequestDetails

File request details
Type:
  • Object
Properties:
Name Type Argument Description
asset_index number Asset position in the Assets list.
deadline TeamLogFileRequestDeadline <optional>
 File request deadline.

TeamLogFileRequestReceiveFileDetails

Received files for file request.
Type:
  • Object
Properties:
Name Type Argument Description
submitted_file_names Array.<string> Submitted file names.
file_request_id string <optional>
 File request id. Might be missing due to historical data gap.
file_request_details TeamLogFileRequestDetails <optional>
 File request details. Might be missing due to historical data gap.
submitter_name string <optional>
 The name as provided by the submitter.
submitter_email string <optional>
 The email as provided by the submitter.

TeamLogFileRequestReceiveFileType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRequestsChangePolicyDetails

Enabled/disabled file requests.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogFileRequestsPolicy New file requests policy.
previous_value TeamLogFileRequestsPolicy <optional>
 Previous file requests policy. Might be missing due to historical data gap.

TeamLogFileRequestsChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRequestsEmailsEnabledDetails

Enabled file request emails for everyone.
Type:
  • Object

TeamLogFileRequestsEmailsEnabledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRequestsEmailsRestrictedToTeamOnlyDetails

Enabled file request emails for team.
Type:
  • Object

TeamLogFileRequestsEmailsRestrictedToTeamOnlyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRequestsPolicy

File requests policy
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogFileResolveCommentDetails

Resolved file comment.
Type:
  • Object
Properties:
Name Type Argument Description
comment_text string <optional>
 Comment text.

TeamLogFileResolveCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRestoreDetails

Restored deleted files and/or folders.
Type:
  • Object

TeamLogFileRestoreType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRevertDetails

Reverted files to previous version.
Type:
  • Object

TeamLogFileRevertType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileRollbackChangesDetails

Rolled back file actions.
Type:
  • Object

TeamLogFileRollbackChangesType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileSaveCopyReferenceDetails

Saved file/folder using copy reference.
Type:
  • Object
Properties:
Name Type Description
relocate_action_details Array.<TeamLogRelocateAssetReferencesLogInfo> Relocate action details.

TeamLogFileSaveCopyReferenceType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileTransfersFileAddDetails

Transfer files added.
Type:
  • Object
Properties:
Name Type Description
file_transfer_id string Transfer id.

TeamLogFileTransfersFileAddType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileTransfersPolicy

File transfers policy
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogFileTransfersPolicyChangedDetails

Changed file transfers policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogFileTransfersPolicy New file transfers policy.
previous_value TeamLogFileTransfersPolicy Previous file transfers policy.

TeamLogFileTransfersPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileTransfersTransferDeleteDetails

Deleted transfer.
Type:
  • Object
Properties:
Name Type Description
file_transfer_id string Transfer id.

TeamLogFileTransfersTransferDeleteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileTransfersTransferDownloadDetails

Transfer downloaded.
Type:
  • Object
Properties:
Name Type Description
file_transfer_id string Transfer id.

TeamLogFileTransfersTransferDownloadType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileTransfersTransferSendDetails

Sent transfer.
Type:
  • Object
Properties:
Name Type Description
file_transfer_id string Transfer id.

TeamLogFileTransfersTransferSendType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileTransfersTransferViewDetails

Viewed transfer.
Type:
  • Object
Properties:
Name Type Description
file_transfer_id string Transfer id.

TeamLogFileTransfersTransferViewType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileUnlikeCommentDetails

Unliked file comment.
Type:
  • Object
Properties:
Name Type Argument Description
comment_text string <optional>
 Comment text.

TeamLogFileUnlikeCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFileUnresolveCommentDetails

Unresolved file comment.
Type:
  • Object
Properties:
Name Type Argument Description
comment_text string <optional>
 Comment text.

TeamLogFileUnresolveCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFolderLinkRestrictionPolicy

Policy for deciding whether applying link restrictions on all team owned folders
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogFolderLinkRestrictionPolicyChangedDetails

Changed folder link restrictions policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogFolderLinkRestrictionPolicy To.
previous_value TeamLogFolderLinkRestrictionPolicy From.

TeamLogFolderLinkRestrictionPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFolderLogInfo

Folder's logged information.
Type:
  • Object
Properties:
Name Type Argument Description
path TeamLogPathLogInfo Path relative to event context.
display_name string <optional>
 Display name.
file_id string <optional>
 Unique ID.
file_size number <optional>
 File or folder size in bytes.
file_count number <optional>
 Number of files within the folder.

TeamLogFolderOverviewDescriptionChangedDetails

Updated folder overview.
Type:
  • Object
Properties:
Name Type Description
folder_overview_location_asset number Folder Overview location position in the Assets list.

TeamLogFolderOverviewDescriptionChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFolderOverviewItemPinnedDetails

Pinned item to folder overview.
Type:
  • Object
Properties:
Name Type Description
folder_overview_location_asset number Folder Overview location position in the Assets list.
pinned_items_asset_indices Array.<number> Pinned items positions in the Assets list.

TeamLogFolderOverviewItemPinnedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogFolderOverviewItemUnpinnedDetails

Unpinned item from folder overview.
Type:
  • Object
Properties:
Name Type Description
folder_overview_location_asset number Folder Overview location position in the Assets list.
pinned_items_asset_indices Array.<number> Pinned items positions in the Assets list.

TeamLogFolderOverviewItemUnpinnedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGeoLocationLogInfo

Geographic location details.
Type:
  • Object
Properties:
Name Type Argument Description
ip_address string IP address.
city string <optional>
 City name.
region string <optional>
 Region name.
country string <optional>
 Country code.

TeamLogGetTeamEventsArg

Type:
  • Object
Properties:
Name Type Argument Description
limit number 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 get_events/continue.
account_id string <optional>
 Filter the events by account ID. Return only events with this account_id as either Actor, Context, or Participants.
time TeamCommonTimeRange <optional>
 Filter by time range.
category TeamLogEventCategory <optional>
 Filter the returned events to a single category. Note that category shouldn't be provided together with event_type.
event_type TeamLogEventTypeArg <optional>
 Filter the returned events to a single event type. Note that event_type shouldn't be provided together with category.

TeamLogGetTeamEventsContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string Indicates from what point to get the next set of events.

TeamLogGetTeamEventsContinueError

Errors that can be raised when calling get_events/continue.
Type:
  • Object
Properties:
Name Type Argument Description
reset Timestamp <optional>
 Available if .tag is reset. Cursors are intended to be used quickly. Individual cursor values are normally valid for days, but in rare cases may be reset sooner. Cursor reset errors should be handled by fetching a new cursor from :route:`get_events`. The associated value is the approximate timestamp of the most recent event returned by the cursor. This should be used as a resumption point when calling :route:`get_events` to obtain a new cursor.
.tag 'bad_cursor' | 'reset' | 'other' Tag identifying the union variant.

TeamLogGetTeamEventsError

Errors that can be raised when calling get_events.
Type:
  • Object
Properties:
Name Type Description
.tag 'account_id_not_found' | 'invalid_time_range' | 'invalid_filters' | 'other' Tag identifying the union variant.

TeamLogGetTeamEventsResult

Type:
  • Object
Properties:
Name Type Description
events Array.<TeamLogTeamEvent> List of events. Note that events are not guaranteed to be sorted by their timestamp value.
cursor string Pass the cursor into get_events/continue to obtain additional events. The value of cursor may change for each response from get_events/continue, regardless of the value of has_more; older cursor strings may expire. Thus, callers should ensure that they update their cursor based on the latest value of cursor after each call, and poll regularly if they wish to poll for new events. Callers should handle reset exceptions for expired cursors.
has_more boolean Is true if there may be additional events that have not been returned yet. An additional call to get_events/continue can retrieve them. Note that has_more may be true, even if events is empty.

TeamLogGoogleSsoChangePolicyDetails

Enabled/disabled Google single sign-on for team.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogGoogleSsoPolicy New Google single sign-on policy.
previous_value TeamLogGoogleSsoPolicy <optional>
 Previous Google single sign-on policy. Might be missing due to historical data gap.

TeamLogGoogleSsoChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGoogleSsoPolicy

Google SSO policy
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogGovernancePolicyAddFolderFailedDetails

Couldn't add a folder to a policy.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
folder string Folder.
policy_type TeamLogPolicyType <optional>
 Policy type.
reason string <optional>
 Reason.

TeamLogGovernancePolicyAddFolderFailedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyAddFoldersDetails

Added folders to policy.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
policy_type TeamLogPolicyType <optional>
 Policy type.
folders Array.<string> <optional>
 Folders.

TeamLogGovernancePolicyAddFoldersType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyContentDisposedDetails

Content disposed.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
disposition_type TeamLogDispositionActionType Disposition type.
policy_type TeamLogPolicyType <optional>
 Policy type.

TeamLogGovernancePolicyContentDisposedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyCreateDetails

Activated a new policy.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
duration TeamLogDurationLogInfo Duration in days.
policy_type TeamLogPolicyType <optional>
 Policy type.
folders Array.<string> <optional>
 Folders.

TeamLogGovernancePolicyCreateType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyDeleteDetails

Deleted a policy.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
policy_type TeamLogPolicyType <optional>
 Policy type.

TeamLogGovernancePolicyDeleteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyEditDetailsDetails

Edited policy.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
attribute string Attribute.
previous_value string From.
new_value string To.
policy_type TeamLogPolicyType <optional>
 Policy type.

TeamLogGovernancePolicyEditDetailsType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyEditDurationDetails

Changed policy duration.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
previous_value TeamLogDurationLogInfo From.
new_value TeamLogDurationLogInfo To.
policy_type TeamLogPolicyType <optional>
 Policy type.

TeamLogGovernancePolicyEditDurationType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyExportCreatedDetails

Created a policy download.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
export_name string Export name.
policy_type TeamLogPolicyType <optional>
 Policy type.

TeamLogGovernancePolicyExportCreatedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyExportRemovedDetails

Removed a policy download.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
export_name string Export name.
policy_type TeamLogPolicyType <optional>
 Policy type.

TeamLogGovernancePolicyExportRemovedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyRemoveFoldersDetails

Removed folders from policy.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
policy_type TeamLogPolicyType <optional>
 Policy type.
folders Array.<string> <optional>
 Folders.
reason string <optional>
 Reason.

TeamLogGovernancePolicyRemoveFoldersType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyReportCreatedDetails

Created a summary report for a policy.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
policy_type TeamLogPolicyType <optional>
 Policy type.

TeamLogGovernancePolicyReportCreatedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGovernancePolicyZipPartDownloadedDetails

Downloaded content from a policy.
Type:
  • Object
Properties:
Name Type Argument Description
governance_policy_id string Policy ID.
name string Policy name.
export_name string Export name.
policy_type TeamLogPolicyType <optional>
 Policy type.
part string <optional>
 Part.

TeamLogGovernancePolicyZipPartDownloadedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupAddExternalIdDetails

Added external ID for group.
Type:
  • Object
Properties:
Name Type Description
new_value string Current external id.

TeamLogGroupAddExternalIdType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupAddMemberDetails

Added team members to group.
Type:
  • Object
Properties:
Name Type Description
is_group_owner boolean Is group owner.

TeamLogGroupAddMemberType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupChangeExternalIdDetails

Changed external ID for group.
Type:
  • Object
Properties:
Name Type Description
new_value string Current external id.
previous_value string Old external id.

TeamLogGroupChangeExternalIdType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupChangeManagementTypeDetails

Changed group management type.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamCommonGroupManagementType New group management type.
previous_value TeamCommonGroupManagementType <optional>
 Previous group management type. Might be missing due to historical data gap.

TeamLogGroupChangeManagementTypeType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupChangeMemberRoleDetails

Changed manager permissions of group member.
Type:
  • Object
Properties:
Name Type Description
is_group_owner boolean Is group owner.

TeamLogGroupChangeMemberRoleType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupCreateDetails

Created group.
Type:
  • Object
Properties:
Name Type Argument Description
is_company_managed boolean <optional>
 Is company managed group.
join_policy TeamLogGroupJoinPolicy <optional>
 Group join policy.

TeamLogGroupCreateType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupDeleteDetails

Deleted group.
Type:
  • Object
Properties:
Name Type Argument Description
is_company_managed boolean <optional>
 Is company managed group.

TeamLogGroupDeleteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupDescriptionUpdatedDetails

Updated group.
Type:
  • Object

TeamLogGroupDescriptionUpdatedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupJoinPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'open' | 'request_to_join' | 'other' Tag identifying the union variant.

TeamLogGroupJoinPolicyUpdatedDetails

Updated group join policy.
Type:
  • Object
Properties:
Name Type Argument Description
is_company_managed boolean <optional>
 Is company managed group.
join_policy TeamLogGroupJoinPolicy <optional>
 Group join policy.

TeamLogGroupJoinPolicyUpdatedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupLogInfo

Group's logged information.
Type:
  • Object
Properties:
Name Type Argument Description
display_name string The name of this group.
group_id string <optional>
 The unique id of this group.
external_id string <optional>
 External group ID.

TeamLogGroupMovedDetails

Moved group.
Type:
  • Object

TeamLogGroupMovedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupRemoveExternalIdDetails

Removed external ID for group.
Type:
  • Object
Properties:
Name Type Description
previous_value string Old external id.

TeamLogGroupRemoveExternalIdType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupRemoveMemberDetails

Removed team members from group.
Type:
  • Object

TeamLogGroupRemoveMemberType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupRenameDetails

Renamed group.
Type:
  • Object
Properties:
Name Type Description
previous_value string Previous display name.
new_value string New display name.

TeamLogGroupRenameType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGroupUserManagementChangePolicyDetails

Changed who can create groups.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamPoliciesGroupCreation New group users management policy.
previous_value TeamPoliciesGroupCreation <optional>
 Previous group users management policy. Might be missing due to historical data gap.

TeamLogGroupUserManagementChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGuestAdminChangeStatusDetails

Changed guest team admin status.
Type:
  • Object
Properties:
Name Type Argument Description
is_guest boolean True for guest, false for host.
previous_value TeamLogTrustedTeamsRequestState Previous request state.
new_value TeamLogTrustedTeamsRequestState New request state.
action_details TeamLogTrustedTeamsRequestAction Action details.
guest_team_name string <optional>
 The name of the guest team.
host_team_name string <optional>
 The name of the host team.

TeamLogGuestAdminChangeStatusType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGuestAdminSignedInViaTrustedTeamsDetails

Started trusted team admin session.
Type:
  • Object
Properties:
Name Type Argument Description
team_name string <optional>
 Host team name.
trusted_team_name string <optional>
 Trusted team name.

TeamLogGuestAdminSignedInViaTrustedTeamsType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogGuestAdminSignedOutViaTrustedTeamsDetails

Ended trusted team admin session.
Type:
  • Object
Properties:
Name Type Argument Description
team_name string <optional>
 Host team name.
trusted_team_name string <optional>
 Trusted team name.

TeamLogGuestAdminSignedOutViaTrustedTeamsType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogIdentifierType

Type:
  • Object
Properties:
Name Type Description
.tag 'email' | 'facebook_profile_name' | 'other' Tag identifying the union variant.

TeamLogIntegrationConnectedDetails

Connected integration for member.
Type:
  • Object
Properties:
Name Type Description
integration_name string Name of the third-party integration.

TeamLogIntegrationConnectedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogIntegrationDisconnectedDetails

Disconnected integration for member.
Type:
  • Object
Properties:
Name Type Description
integration_name string Name of the third-party integration.

TeamLogIntegrationDisconnectedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogIntegrationPolicy

Policy for controlling whether a service integration is enabled for the team.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogIntegrationPolicyChangedDetails

Changed integration policy for team.
Type:
  • Object
Properties:
Name Type Description
integration_name string Name of the third-party integration.
new_value TeamLogIntegrationPolicy New integration policy.
previous_value TeamLogIntegrationPolicy Previous integration policy.

TeamLogIntegrationPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogInviteAcceptanceEmailPolicy

Policy for deciding whether team admins receive email when an invitation to join the team is accepted
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogInviteAcceptanceEmailPolicyChangedDetails

Changed invite accept email policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogInviteAcceptanceEmailPolicy To.
previous_value TeamLogInviteAcceptanceEmailPolicy From.

TeamLogInviteAcceptanceEmailPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogInviteMethod

Type:
  • Object
Properties:
Name Type Description
.tag 'auto_approve' | 'invite_link' | 'member_invite' | 'moved_from_another_team' | 'other' Tag identifying the union variant.

TeamLogJoinTeamDetails

Additional information relevant when a new member joins the team.
Type:
  • Object
Properties:
Name Type Argument Description
linked_apps Array.<TeamLogUserLinkedAppLogInfo> Linked applications. (Deprecated) Please use has_linked_apps boolean field instead.
linked_devices Array.<TeamLogLinkedDeviceLogInfo> Linked devices. (Deprecated) Please use has_linked_devices boolean field instead.
linked_shared_folders Array.<TeamLogFolderLogInfo> Linked shared folders. (Deprecated) Please use has_linked_shared_folders boolean field instead.
was_linked_apps_truncated boolean <optional>
 (Deprecated) True if the linked_apps list was truncated to the maximum supported length (50).
was_linked_devices_truncated boolean <optional>
 (Deprecated) True if the linked_devices list was truncated to the maximum supported length (50).
was_linked_shared_folders_truncated boolean <optional>
 (Deprecated) True if the linked_shared_folders list was truncated to the maximum supported length (50).
has_linked_apps boolean <optional>
 True if the user had linked apps at event time.
has_linked_devices boolean <optional>
 True if the user had linked apps at event time.
has_linked_shared_folders boolean <optional>
 True if the user had linked shared folders at event time.

TeamLogLabelType

Label type
Type:
  • Object
Properties:
Name Type Description
.tag 'personal_information' | 'test_only' | 'user_defined_tag' | 'other' Tag identifying the union variant.

TeamLogLegacyDeviceSessionLogInfo

Information on sessions, in legacy format
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'legacy_device_session' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
ip_address string <optional>
 The IP address of the last activity from this session.
created Timestamp <optional>
 The time this session was created.
updated Timestamp <optional>
 The time of the last activity from this session.
session_info TeamLogWebSessionLogInfo | TeamLogDesktopSessionLogInfo | TeamLogMobileSessionLogInfo | TeamLogSessionLogInfo <optional>
 Session unique id.
display_name string <optional>
 The device name. Might be missing due to historical data gap.
is_emm_managed boolean <optional>
 Is device managed by emm. Might be missing due to historical data gap.
platform string <optional>
 Information on the hosting platform. Might be missing due to historical data gap.
mac_address string <optional>
 The mac address of the last activity from this session. Might be missing due to historical data gap.
os_version string <optional>
 The hosting OS version. Might be missing due to historical data gap.
device_type string <optional>
 Information on the hosting device type. Might be missing due to historical data gap.
client_version string <optional>
 The Dropbox client version. Might be missing due to historical data gap.
legacy_uniq_id string <optional>
 Alternative unique device session id, instead of session id field. Might be missing due to historical data gap.

TeamLogLegalHoldsActivateAHoldDetails

Activated a hold.
Type:
  • Object
Properties:
Name Type Argument Description
legal_hold_id string Hold ID.
name string Hold name.
start_date Timestamp Hold start date.
end_date Timestamp <optional>
 Hold end date.

TeamLogLegalHoldsActivateAHoldType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLegalHoldsAddMembersDetails

Added members to a hold.
Type:
  • Object
Properties:
Name Type Description
legal_hold_id string Hold ID.
name string Hold name.

TeamLogLegalHoldsAddMembersType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLegalHoldsChangeHoldDetailsDetails

Edited details for a hold.
Type:
  • Object
Properties:
Name Type Description
legal_hold_id string Hold ID.
name string Hold name.
previous_value string Previous details.
new_value string New details.

TeamLogLegalHoldsChangeHoldDetailsType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLegalHoldsChangeHoldNameDetails

Renamed a hold.
Type:
  • Object
Properties:
Name Type Description
legal_hold_id string Hold ID.
previous_value string Previous Name.
new_value string New Name.

TeamLogLegalHoldsChangeHoldNameType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLegalHoldsExportAHoldDetails

Exported hold.
Type:
  • Object
Properties:
Name Type Argument Description
legal_hold_id string Hold ID.
name string Hold name.
export_name string <optional>
 Export name.

TeamLogLegalHoldsExportAHoldType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLegalHoldsExportCancelledDetails

Canceled export for a hold.
Type:
  • Object
Properties:
Name Type Description
legal_hold_id string Hold ID.
name string Hold name.
export_name string Export name.

TeamLogLegalHoldsExportCancelledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLegalHoldsExportDownloadedDetails

Downloaded export for a hold.
Type:
  • Object
Properties:
Name Type Argument Description
legal_hold_id string Hold ID.
name string Hold name.
export_name string Export name.
part string <optional>
 Part.
file_name string <optional>
 Filename.

TeamLogLegalHoldsExportDownloadedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLegalHoldsExportRemovedDetails

Removed export for a hold.
Type:
  • Object
Properties:
Name Type Description
legal_hold_id string Hold ID.
name string Hold name.
export_name string Export name.

TeamLogLegalHoldsExportRemovedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLegalHoldsReleaseAHoldDetails

Released a hold.
Type:
  • Object
Properties:
Name Type Description
legal_hold_id string Hold ID.
name string Hold name.

TeamLogLegalHoldsReleaseAHoldType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLegalHoldsRemoveMembersDetails

Removed members from a hold.
Type:
  • Object
Properties:
Name Type Description
legal_hold_id string Hold ID.
name string Hold name.

TeamLogLegalHoldsRemoveMembersType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLegalHoldsReportAHoldDetails

Created a summary report for a hold.
Type:
  • Object
Properties:
Name Type Description
legal_hold_id string Hold ID.
name string Hold name.

TeamLogLegalHoldsReportAHoldType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLinkedDeviceLogInfo

The device sessions that user is linked to.
Type:
  • Object
Properties:
Name Type Argument Description
desktop_device_session TeamLogDesktopDeviceSessionLogInfo <optional>
 Available if .tag is desktop_device_session. desktop device session's details.
legacy_device_session TeamLogLegacyDeviceSessionLogInfo <optional>
 Available if .tag is legacy_device_session. legacy device session's details.
mobile_device_session TeamLogMobileDeviceSessionLogInfo <optional>
 Available if .tag is mobile_device_session. mobile device session's details.
web_device_session TeamLogWebDeviceSessionLogInfo <optional>
 Available if .tag is web_device_session. web device session's details.
.tag 'desktop_device_session' | 'legacy_device_session' | 'mobile_device_session' | 'web_device_session' | 'other' Tag identifying the union variant.

TeamLogLockStatus

File lock status
Type:
  • Object
Properties:
Name Type Description
.tag 'locked' | 'unlocked' | 'other' Tag identifying the union variant.

TeamLogLoginFailDetails

Failed to sign in.
Type:
  • Object
Properties:
Name Type Argument Description
login_method TeamLogLoginMethod Login method.
error_details TeamLogFailureDetailsLogInfo Error details.
is_emm_managed boolean <optional>
 Tells if the login device is EMM managed. Might be missing due to historical data gap.

TeamLogLoginFailType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLoginMethod

Type:
  • Object
Properties:
Name Type Description
.tag 'apple_oauth' | 'first_party_token_exchange' | 'google_oauth' | 'password' | 'qr_code' | 'saml' | 'two_factor_authentication' | 'web_session' | 'other' Tag identifying the union variant.

TeamLogLoginSuccessDetails

Signed in.
Type:
  • Object
Properties:
Name Type Argument Description
login_method TeamLogLoginMethod Login method.
is_emm_managed boolean <optional>
 Tells if the login device is EMM managed. Might be missing due to historical data gap.

TeamLogLoginSuccessType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogLogoutDetails

Signed out.
Type:
  • Object
Properties:
Name Type Argument Description
login_id string <optional>
 Login session id.

TeamLogLogoutType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberAddExternalIdDetails

Added an external ID for team member.
Type:
  • Object
Properties:
Name Type Description
new_value string Current external id.

TeamLogMemberAddExternalIdType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberAddNameDetails

Added team member name.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogUserNameLogInfo New user's name.

TeamLogMemberAddNameType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberChangeAdminRoleDetails

Changed team member admin role.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogAdminRole <optional>
 New admin role. This field is relevant when the admin role is changed or whenthe user role changes from no admin rights to with admin rights.
previous_value TeamLogAdminRole <optional>
 Previous admin role. This field is relevant when the admin role is changed or when the admin role is removed.

TeamLogMemberChangeAdminRoleType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberChangeEmailDetails

Changed team member email.
Type:
  • Object
Properties:
Name Type Argument Description
new_value string New email.
previous_value string <optional>
 Previous email. Might be missing due to historical data gap.

TeamLogMemberChangeEmailType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberChangeExternalIdDetails

Changed the external ID for team member.
Type:
  • Object
Properties:
Name Type Description
new_value string Current external id.
previous_value string Old external id.

TeamLogMemberChangeExternalIdType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberChangeMembershipTypeDetails

Changed membership type (limited/full) of member.
Type:
  • Object
Properties:
Name Type Description
prev_value TeamLogTeamMembershipType Previous membership type.
new_value TeamLogTeamMembershipType New membership type.

TeamLogMemberChangeMembershipTypeType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberChangeNameDetails

Changed team member name.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogUserNameLogInfo New user's name.
previous_value TeamLogUserNameLogInfo <optional>
 Previous user's name. Might be missing due to historical data gap.

TeamLogMemberChangeNameType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberChangeResellerRoleDetails

Changed team member reseller role.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogResellerRole New reseller role. This field is relevant when the reseller role is changed.
previous_value TeamLogResellerRole Previous reseller role. This field is relevant when the reseller role is changed or when the reseller role is removed.

TeamLogMemberChangeResellerRoleType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberChangeStatusDetails

Changed member status (invited, joined, suspended, etc.).
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogMemberStatus New member status.
previous_value TeamLogMemberStatus <optional>
 Previous member status. Might be missing due to historical data gap.
action TeamLogActionDetails <optional>
 Additional information indicating the action taken that caused status change.
new_team string <optional>
 The user's new team name. This field is relevant when the user is transferred off the team.
previous_team string <optional>
 The user's previous team name. This field is relevant when the user is transferred onto the team.

TeamLogMemberChangeStatusType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberDeleteManualContactsDetails

Cleared manually added contacts.
Type:
  • Object

TeamLogMemberDeleteManualContactsType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberDeleteProfilePhotoDetails

Deleted team member profile photo.
Type:
  • Object

TeamLogMemberDeleteProfilePhotoType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberPermanentlyDeleteAccountContentsDetails

Permanently deleted contents of deleted team member account.
Type:
  • Object

TeamLogMemberPermanentlyDeleteAccountContentsType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberRemoveActionType

Type:
  • Object
Properties:
Name Type Description
.tag 'delete' | 'leave' | 'offboard' | 'offboard_and_retain_team_folders' | 'other' Tag identifying the union variant.

TeamLogMemberRemoveExternalIdDetails

Removed the external ID for team member.
Type:
  • Object
Properties:
Name Type Description
previous_value string Old external id.

TeamLogMemberRemoveExternalIdType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberRequestsChangePolicyDetails

Changed whether users can find team when not invited.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogMemberRequestsPolicy New member change requests policy.
previous_value TeamLogMemberRequestsPolicy <optional>
 Previous member change requests policy. Might be missing due to historical data gap.

TeamLogMemberRequestsChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberRequestsPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'auto_accept' | 'disabled' | 'require_approval' | 'other' Tag identifying the union variant.

TeamLogMemberSendInvitePolicy

Policy for controlling whether team members can send team invites
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'everyone' | 'specific_members' | 'other' Tag identifying the union variant.

TeamLogMemberSendInvitePolicyChangedDetails

Changed member send invite policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogMemberSendInvitePolicy New team member send invite policy.
previous_value TeamLogMemberSendInvitePolicy Previous team member send invite policy.

TeamLogMemberSendInvitePolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberSetProfilePhotoDetails

Set team member profile photo.
Type:
  • Object

TeamLogMemberSetProfilePhotoType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberSpaceLimitsAddCustomQuotaDetails

Set custom member space limit.
Type:
  • Object
Properties:
Name Type Description
new_value number New custom quota value in bytes.

TeamLogMemberSpaceLimitsAddCustomQuotaType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberSpaceLimitsAddExceptionDetails

Added members to member space limit exception list.
Type:
  • Object

TeamLogMemberSpaceLimitsAddExceptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberSpaceLimitsChangeCapsTypePolicyDetails

Changed member space limit type for team.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogSpaceCapsType Previous space limit type.
new_value TeamLogSpaceCapsType New space limit type.

TeamLogMemberSpaceLimitsChangeCapsTypePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberSpaceLimitsChangeCustomQuotaDetails

Changed custom member space limit.
Type:
  • Object
Properties:
Name Type Description
previous_value number Previous custom quota value in bytes.
new_value number New custom quota value in bytes.

TeamLogMemberSpaceLimitsChangeCustomQuotaType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberSpaceLimitsChangePolicyDetails

Changed team default member space limit.
Type:
  • Object
Properties:
Name Type Argument Description
previous_value number <optional>
 Previous team default limit value in bytes. Might be missing due to historical data gap.
new_value number <optional>
 New team default limit value in bytes. Might be missing due to historical data gap.

TeamLogMemberSpaceLimitsChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberSpaceLimitsChangeStatusDetails

Changed space limit status.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogSpaceLimitsStatus Previous storage quota status.
new_value TeamLogSpaceLimitsStatus New storage quota status.

TeamLogMemberSpaceLimitsChangeStatusType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberSpaceLimitsRemoveCustomQuotaDetails

Removed custom member space limit.
Type:
  • Object

TeamLogMemberSpaceLimitsRemoveCustomQuotaType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberSpaceLimitsRemoveExceptionDetails

Removed members from member space limit exception list.
Type:
  • Object

TeamLogMemberSpaceLimitsRemoveExceptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberStatus

Type:
  • Object
Properties:
Name Type Description
.tag 'active' | 'invited' | 'moved_to_another_team' | 'not_joined' | 'removed' | 'suspended' | 'other' Tag identifying the union variant.

TeamLogMemberSuggestDetails

Suggested person to add to team.
Type:
  • Object
Properties:
Name Type Description
suggested_members Array.<Object> suggested users emails.

TeamLogMemberSuggestionsChangePolicyDetails

Enabled/disabled option for team members to suggest people to add to team.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogMemberSuggestionsPolicy New team member suggestions policy.
previous_value TeamLogMemberSuggestionsPolicy <optional>
 Previous team member suggestions policy. Might be missing due to historical data gap.

TeamLogMemberSuggestionsChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberSuggestionsPolicy

Member suggestions policy
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogMemberSuggestType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberTransferAccountContentsDetails

Transferred contents of deleted member account to another member.
Type:
  • Object

TeamLogMemberTransferAccountContentsType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMemberTransferredInternalFields

Internal only - fields for target team computations
Type:
  • Object
Properties:
Name Type Description
source_team_id string Internal only - team user was moved from.
target_team_id string Internal only - team user was moved to.

TeamLogMicrosoftOfficeAddinChangePolicyDetails

Enabled/disabled Microsoft Office add-in.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogMicrosoftOfficeAddinPolicy New Microsoft Office addin policy.
previous_value TeamLogMicrosoftOfficeAddinPolicy <optional>
 Previous Microsoft Office addin policy. Might be missing due to historical data gap.

TeamLogMicrosoftOfficeAddinChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogMicrosoftOfficeAddinPolicy

Microsoft Office addin policy
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogMissingDetails

An indication that an error occurred while retrieving the event. Some attributes of the event may be omitted as a result.
Type:
  • Object
Properties:
Name Type Argument Description
source_event_fields string <optional>
 All the data that could be retrieved and converted from the source event.

TeamLogMobileDeviceSessionLogInfo

Information about linked Dropbox mobile client sessions
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'mobile_device_session' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
device_name string The device name.
client_type TeamMobileClientPlatform The mobile application type.
ip_address string <optional>
 The IP address of the last activity from this session.
created Timestamp <optional>
 The time this session was created.
updated Timestamp <optional>
 The time of the last activity from this session.
session_info TeamLogMobileSessionLogInfo <optional>
 Mobile session unique id.
client_version string <optional>
 The Dropbox client version.
os_version string <optional>
 The hosting OS version.
last_carrier string <optional>
 last carrier used by the device.

TeamLogMobileSessionLogInfo

Mobile session.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'mobile' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
session_id string <optional>
 Session ID.

TeamLogNamespaceRelativePathLogInfo

Namespace relative path details.
Type:
  • Object
Properties:
Name Type Argument Description
ns_id string <optional>
 Namespace ID.
relative_path string <optional>
 A path relative to the specified namespace ID.
is_shared_namespace boolean <optional>
 True if the namespace is shared.

TeamLogNetworkControlChangePolicyDetails

Enabled/disabled network control.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogNetworkControlPolicy New network control policy.
previous_value TeamLogNetworkControlPolicy <optional>
 Previous network control policy. Might be missing due to historical data gap.

TeamLogNetworkControlChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNetworkControlPolicy

Network control policy
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogNoExpirationLinkGenCreateReportDetails

Report created: Links created with no expiration.
Type:
  • Object
Properties:
Name Type Description
start_date Timestamp Report start date.
end_date Timestamp Report end date.

TeamLogNoExpirationLinkGenCreateReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNoExpirationLinkGenReportFailedDetails

Couldn't create report: Links created with no expiration.
Type:
  • Object
Properties:
Name Type Description
failure_reason TeamTeamReportFailureReason Failure reason.

TeamLogNoExpirationLinkGenReportFailedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNonTeamMemberLogInfo

Non team member's logged information.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'non_team_member' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
account_id string <optional>
 User unique ID.
display_name string <optional>
 User display name.
email string <optional>
 User email address.

TeamLogNonTrustedTeamDetails

The email to which the request was sent
Type:
  • Object
Properties:
Name Type Description
team string The email to which the request was sent.

TeamLogNoPasswordLinkGenCreateReportDetails

Report created: Links created without passwords.
Type:
  • Object
Properties:
Name Type Description
start_date Timestamp Report start date.
end_date Timestamp Report end date.

TeamLogNoPasswordLinkGenCreateReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNoPasswordLinkGenReportFailedDetails

Couldn't create report: Links created without passwords.
Type:
  • Object
Properties:
Name Type Description
failure_reason TeamTeamReportFailureReason Failure reason.

TeamLogNoPasswordLinkGenReportFailedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNoPasswordLinkViewCreateReportDetails

Report created: Views of links without passwords.
Type:
  • Object
Properties:
Name Type Description
start_date Timestamp Report start date.
end_date Timestamp Report end date.

TeamLogNoPasswordLinkViewCreateReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNoPasswordLinkViewReportFailedDetails

Couldn't create report: Views of links without passwords.
Type:
  • Object
Properties:
Name Type Description
failure_reason TeamTeamReportFailureReason Failure reason.

TeamLogNoPasswordLinkViewReportFailedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNoteAclInviteOnlyDetails

Changed Paper doc to invite-only.
Type:
  • Object

TeamLogNoteAclInviteOnlyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNoteAclLinkDetails

Changed Paper doc to link-accessible.
Type:
  • Object

TeamLogNoteAclLinkType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNoteAclTeamLinkDetails

Changed Paper doc to link-accessible for team.
Type:
  • Object

TeamLogNoteAclTeamLinkType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNoteSharedDetails

Shared Paper doc.
Type:
  • Object

TeamLogNoteSharedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogNoteShareReceiveDetails

Shared received Paper doc.
Type:
  • Object

TeamLogNoteShareReceiveType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogObjectLabelAddedDetails

Added a label.
Type:
  • Object
Properties:
Name Type Description
label_type TeamLogLabelType Labels mark a file or folder.

TeamLogObjectLabelAddedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogObjectLabelRemovedDetails

Removed a label.
Type:
  • Object
Properties:
Name Type Description
label_type TeamLogLabelType Labels mark a file or folder.

TeamLogObjectLabelRemovedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogObjectLabelUpdatedValueDetails

Updated a label's value.
Type:
  • Object
Properties:
Name Type Description
label_type TeamLogLabelType Labels mark a file or folder.

TeamLogObjectLabelUpdatedValueType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogOpenNoteSharedDetails

Opened shared Paper doc.
Type:
  • Object

TeamLogOpenNoteSharedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogOrganizationDetails

More details about the organization.
Type:
  • Object
Properties:
Name Type Description
organization string The name of the organization.

TeamLogOrganizationName

The name of the organization
Type:
  • Object
Properties:
Name Type Description
organization string The name of the organization.

TeamLogOrganizeFolderWithTidyDetails

Organized a folder with multi-file organize.
Type:
  • Object

TeamLogOrganizeFolderWithTidyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogOriginLogInfo

The origin from which the actor performed the action.
Type:
  • Object
Properties:
Name Type Argument Description
access_method TeamLogAccessMethodLogInfo The method that was used to perform the action.
geo_location TeamLogGeoLocationLogInfo <optional>
 Geographic location details.

TeamLogOutdatedLinkViewCreateReportDetails

Report created: Views of old links.
Type:
  • Object
Properties:
Name Type Description
start_date Timestamp Report start date.
end_date Timestamp Report end date.

TeamLogOutdatedLinkViewCreateReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogOutdatedLinkViewReportFailedDetails

Couldn't create report: Views of old links.
Type:
  • Object
Properties:
Name Type Description
failure_reason TeamTeamReportFailureReason Failure reason.

TeamLogOutdatedLinkViewReportFailedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperAccessType

Type:
  • Object
Properties:
Name Type Description
.tag 'commenter' | 'editor' | 'viewer' | 'other' Tag identifying the union variant.

TeamLogPaperAdminExportStartDetails

Exported all team Paper docs.
Type:
  • Object

TeamLogPaperAdminExportStartType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperChangeDeploymentPolicyDetails

Changed whether Dropbox Paper, when enabled, is deployed to all members or to specific members.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamPoliciesPaperDeploymentPolicy New Dropbox Paper deployment policy.
previous_value TeamPoliciesPaperDeploymentPolicy <optional>
 Previous Dropbox Paper deployment policy. Might be missing due to historical data gap.

TeamLogPaperChangeDeploymentPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperChangeMemberLinkPolicyDetails

Changed whether non-members can view Paper docs with link.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogPaperMemberPolicy New paper external link accessibility policy.

TeamLogPaperChangeMemberLinkPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperChangeMemberPolicyDetails

Changed whether members can share Paper docs outside team, and if docs are accessible only by team members or anyone by default.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogPaperMemberPolicy New paper external accessibility policy.
previous_value TeamLogPaperMemberPolicy <optional>
 Previous paper external accessibility policy. Might be missing due to historical data gap.

TeamLogPaperChangeMemberPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperChangePolicyDetails

Enabled/disabled Dropbox Paper for team.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamPoliciesPaperEnabledPolicy New Dropbox Paper policy.
previous_value TeamPoliciesPaperEnabledPolicy <optional>
 Previous Dropbox Paper policy. Might be missing due to historical data gap.

TeamLogPaperChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperContentAddMemberDetails

Added users and/or groups to Paper doc/folder.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperContentAddMemberType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperContentAddToFolderDetails

Added Paper doc/folder to folder.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
target_asset_index number Target asset position in the Assets list.
parent_asset_index number Parent asset position in the Assets list.

TeamLogPaperContentAddToFolderType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperContentArchiveDetails

Archived Paper doc/folder.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperContentArchiveType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperContentCreateDetails

Created Paper doc/folder.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperContentCreateType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperContentPermanentlyDeleteDetails

Permanently deleted Paper doc/folder.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperContentPermanentlyDeleteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperContentRemoveFromFolderDetails

Removed Paper doc/folder from folder.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
target_asset_index number <optional>
 Target asset position in the Assets list.
parent_asset_index number <optional>
 Parent asset position in the Assets list.

TeamLogPaperContentRemoveFromFolderType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperContentRemoveMemberDetails

Removed users and/or groups from Paper doc/folder.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperContentRemoveMemberType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperContentRenameDetails

Renamed Paper doc/folder.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperContentRenameType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperContentRestoreDetails

Restored archived Paper doc/folder.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperContentRestoreType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDefaultFolderPolicy

Policy to set default access for newly created Paper folders.
Type:
  • Object
Properties:
Name Type Description
.tag 'everyone_in_team' | 'invite_only' | 'other' Tag identifying the union variant.

TeamLogPaperDefaultFolderPolicyChangedDetails

Changed Paper Default Folder Policy setting for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogPaperDefaultFolderPolicy New Paper Default Folder Policy.
previous_value TeamLogPaperDefaultFolderPolicy Previous Paper Default Folder Policy.

TeamLogPaperDefaultFolderPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDesktopPolicy

Policy for controlling if team members can use Paper Desktop
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogPaperDesktopPolicyChangedDetails

Enabled/disabled Paper Desktop for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogPaperDesktopPolicy New Paper Desktop policy.
previous_value TeamLogPaperDesktopPolicy Previous Paper Desktop policy.

TeamLogPaperDesktopPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocAddCommentDetails

Added Paper doc comment.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
comment_text string <optional>
 Comment text.

TeamLogPaperDocAddCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocChangeMemberRoleDetails

Changed member permissions for Paper doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
access_type TeamLogPaperAccessType Paper doc access type.

TeamLogPaperDocChangeMemberRoleType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocChangeSharingPolicyDetails

Changed sharing setting for Paper doc.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
public_sharing_policy string <optional>
 Sharing policy with external users.
team_sharing_policy string <optional>
 Sharing policy with team.

TeamLogPaperDocChangeSharingPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocChangeSubscriptionDetails

Followed/unfollowed Paper doc.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
new_subscription_level string New doc subscription level.
previous_subscription_level string <optional>
 Previous doc subscription level. Might be missing due to historical data gap.

TeamLogPaperDocChangeSubscriptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocDeleteCommentDetails

Deleted Paper doc comment.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
comment_text string <optional>
 Comment text.

TeamLogPaperDocDeleteCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocDeletedDetails

Archived Paper doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocDeletedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocDownloadDetails

Downloaded Paper doc in specific format.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
export_file_format TeamLogPaperDownloadFormat Export file format.

TeamLogPaperDocDownloadType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocEditCommentDetails

Edited Paper doc comment.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
comment_text string <optional>
 Comment text.

TeamLogPaperDocEditCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocEditDetails

Edited Paper doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocEditType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocFollowedDetails

Followed Paper doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocFollowedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocMentionDetails

Mentioned user in Paper doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocMentionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocOwnershipChangedDetails

Transferred ownership of Paper doc.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
new_owner_user_id string New owner.
old_owner_user_id string <optional>
 Previous owner.

TeamLogPaperDocOwnershipChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocRequestAccessDetails

Requested access to Paper doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocRequestAccessType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocResolveCommentDetails

Resolved Paper doc comment.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
comment_text string <optional>
 Comment text.

TeamLogPaperDocResolveCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocRevertDetails

Restored Paper doc to previous version.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocRevertType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocSlackShareDetails

Shared Paper doc via Slack.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocSlackShareType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocTeamInviteDetails

Shared Paper doc with users and/or groups.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocTeamInviteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocTrashedDetails

Deleted Paper doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocTrashedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocumentLogInfo

Paper document's logged information.
Type:
  • Object
Properties:
Name Type Description
doc_id string Papers document Id.
doc_title string Paper document title.

TeamLogPaperDocUnresolveCommentDetails

Unresolved Paper doc comment.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
comment_text string <optional>
 Comment text.

TeamLogPaperDocUnresolveCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocUntrashedDetails

Restored Paper doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocUntrashedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDocViewDetails

Viewed Paper doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperDocViewType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperDownloadFormat

Type:
  • Object
Properties:
Name Type Description
.tag 'docx' | 'html' | 'markdown' | 'pdf' | 'other' Tag identifying the union variant.

TeamLogPaperEnabledUsersGroupAdditionDetails

Added users to Paper-enabled users list.
Type:
  • Object

TeamLogPaperEnabledUsersGroupAdditionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperEnabledUsersGroupRemovalDetails

Removed users from Paper-enabled users list.
Type:
  • Object

TeamLogPaperEnabledUsersGroupRemovalType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperExternalViewAllowDetails

Changed Paper external sharing setting to anyone.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperExternalViewAllowType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperExternalViewDefaultTeamDetails

Changed Paper external sharing setting to default team.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperExternalViewDefaultTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperExternalViewForbidDetails

Changed Paper external sharing setting to team-only.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperExternalViewForbidType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperFolderChangeSubscriptionDetails

Followed/unfollowed Paper folder.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
new_subscription_level string New folder subscription level.
previous_subscription_level string <optional>
 Previous folder subscription level. Might be missing due to historical data gap.

TeamLogPaperFolderChangeSubscriptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperFolderDeletedDetails

Archived Paper folder.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperFolderDeletedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperFolderFollowedDetails

Followed Paper folder.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperFolderFollowedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperFolderLogInfo

Paper folder's logged information.
Type:
  • Object
Properties:
Name Type Description
folder_id string Papers folder Id.
folder_name string Paper folder name.

TeamLogPaperFolderTeamInviteDetails

Shared Paper folder with users and/or groups.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperFolderTeamInviteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperMemberPolicy

Policy for controlling if team members can share Paper documents externally.
Type:
  • Object
Properties:
Name Type Description
.tag 'anyone_with_link' | 'only_team' | 'team_and_explicitly_shared' | 'other' Tag identifying the union variant.

TeamLogPaperPublishedLinkChangePermissionDetails

Changed permissions for published doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
new_permission_level string New permission level.
previous_permission_level string Previous permission level.

TeamLogPaperPublishedLinkChangePermissionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperPublishedLinkCreateDetails

Published doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperPublishedLinkCreateType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperPublishedLinkDisabledDetails

Unpublished doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperPublishedLinkDisabledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPaperPublishedLinkViewDetails

Viewed published doc.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogPaperPublishedLinkViewType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogParticipantLogInfo

A user or group
Type:
  • Object
Properties:
Name Type Argument Description
group TeamLogGroupLogInfo <optional>
 Available if .tag is group. Group details.
user TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 Available if .tag is user. A user with a Dropbox account.
.tag 'group' | 'user' | 'other' Tag identifying the union variant.

TeamLogPassPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'allow' | 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogPasswordChangeDetails

Changed password.
Type:
  • Object

TeamLogPasswordChangeType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPasswordResetAllDetails

Reset all team member passwords.
Type:
  • Object

TeamLogPasswordResetAllType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPasswordResetDetails

Reset password.
Type:
  • Object

TeamLogPasswordResetType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPasswordStrengthRequirementsChangePolicyDetails

Changed team password strength requirements.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamPoliciesPasswordStrengthPolicy Old password strength policy.
new_value TeamPoliciesPasswordStrengthPolicy New password strength policy.

TeamLogPasswordStrengthRequirementsChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPathLogInfo

Path's details.
Type:
  • Object
Properties:
Name Type Argument Description
namespace_relative TeamLogNamespaceRelativePathLogInfo Path relative to the namespace containing the content.
contextual string <optional>
 Fully qualified path relative to event's context.

TeamLogPendingSecondaryEmailAddedDetails

Added pending secondary email.
Type:
  • Object
Properties:
Name Type Description
secondary_email string New pending secondary email.

TeamLogPendingSecondaryEmailAddedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPermanentDeleteChangePolicyDetails

Enabled/disabled ability of team members to permanently delete content.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogContentPermanentDeletePolicy New permanent delete content policy.
previous_value TeamLogContentPermanentDeletePolicy <optional>
 Previous permanent delete content policy. Might be missing due to historical data gap.

TeamLogPermanentDeleteChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogPlacementRestriction

Type:
  • Object
Properties:
Name Type Description
.tag 'australia_only' | 'europe_only' | 'japan_only' | 'none' | 'uk_only' | 'us_s3_only' | 'other' Tag identifying the union variant.

TeamLogPolicyType

Type:
  • Object
Properties:
Name Type Description
.tag 'disposition' | 'retention' | 'other' Tag identifying the union variant.

TeamLogPrimaryTeamRequestAcceptedDetails

Team merge request acceptance details shown to the primary team
Type:
  • Object
Properties:
Name Type Description
secondary_team string The secondary team name.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogPrimaryTeamRequestCanceledDetails

Team merge request cancellation details shown to the primary team
Type:
  • Object
Properties:
Name Type Description
secondary_team string The secondary team name.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogPrimaryTeamRequestExpiredDetails

Team merge request expiration details shown to the primary team
Type:
  • Object
Properties:
Name Type Description
secondary_team string The secondary team name.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogPrimaryTeamRequestReminderDetails

Team merge request reminder details shown to the primary team
Type:
  • Object
Properties:
Name Type Description
secondary_team string The secondary team name.
sent_to string The name of the primary team admin the request was sent to.

TeamLogQuickActionType

Quick action type.
Type:
  • Object
Properties:
Name Type Description
.tag 'delete_shared_link' | 'reset_password' | 'restore_file_or_folder' | 'unlink_app' | 'unlink_device' | 'unlink_session' | 'other' Tag identifying the union variant.

TeamLogRecipientsConfiguration

Recipients Configuration
Type:
  • Object
Properties:
Name Type Argument Description
recipient_setting_type TeamLogAlertRecipientsSettingType <optional>
 Recipients setting type.
emails Array.<Object> <optional>
 A list of user emails to notify.
groups Array.<string> <optional>
 A list of groups to notify.

TeamLogRelocateAssetReferencesLogInfo

Provides the indices of the source asset and the destination asset for a relocate action.
Type:
  • Object
Properties:
Name Type Description
src_asset_index number Source asset position in the Assets list.
dest_asset_index number Destination asset position in the Assets list.

TeamLogResellerLogInfo

Reseller information.
Type:
  • Object
Properties:
Name Type Description
reseller_name string Reseller name.
reseller_email string Reseller email.

TeamLogResellerRole

Type:
  • Object
Properties:
Name Type Description
.tag 'not_reseller' | 'reseller_admin' | 'other' Tag identifying the union variant.

TeamLogResellerSupportChangePolicyDetails

Enabled/disabled reseller support.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogResellerSupportPolicy New Reseller support policy.
previous_value TeamLogResellerSupportPolicy Previous Reseller support policy.

TeamLogResellerSupportChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogResellerSupportPolicy

Policy for controlling if reseller can access the admin console as administrator
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogResellerSupportSessionEndDetails

Ended reseller support session.
Type:
  • Object

TeamLogResellerSupportSessionEndType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogResellerSupportSessionStartDetails

Started reseller support session.
Type:
  • Object

TeamLogResellerSupportSessionStartType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogRewindFolderDetails

Rewound a folder.
Type:
  • Object
Properties:
Name Type Description
rewind_folder_target_ts_ms Timestamp Folder was Rewound to this date.

TeamLogRewindFolderType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogRewindPolicy

Policy for controlling whether team members can rewind
Type:
  • Object
Properties:
Name Type Description
.tag 'admins_only' | 'everyone' | 'other' Tag identifying the union variant.

TeamLogRewindPolicyChangedDetails

Changed Rewind policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogRewindPolicy New Dropbox Rewind policy.
previous_value TeamLogRewindPolicy Previous Dropbox Rewind policy.

TeamLogRewindPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSecondaryEmailDeletedDetails

Deleted secondary email.
Type:
  • Object
Properties:
Name Type Description
secondary_email string Deleted secondary email.

TeamLogSecondaryEmailDeletedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSecondaryEmailVerifiedDetails

Verified secondary email.
Type:
  • Object
Properties:
Name Type Description
secondary_email string Verified secondary email.

TeamLogSecondaryEmailVerifiedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSecondaryMailsPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogSecondaryMailsPolicyChangedDetails

Secondary mails policy changed.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogSecondaryMailsPolicy Previous secondary mails policy.
new_value TeamLogSecondaryMailsPolicy New secondary mails policy.

TeamLogSecondaryMailsPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSecondaryTeamRequestAcceptedDetails

Team merge request acceptance details shown to the secondary team
Type:
  • Object
Properties:
Name Type Description
primary_team string The primary team name.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogSecondaryTeamRequestCanceledDetails

Team merge request cancellation details shown to the secondary team
Type:
  • Object
Properties:
Name Type Description
sent_to string The email of the primary team admin that the request was sent to.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogSecondaryTeamRequestExpiredDetails

Team merge request expiration details shown to the secondary team
Type:
  • Object
Properties:
Name Type Description
sent_to string The email of the primary team admin the request was sent to.

TeamLogSecondaryTeamRequestReminderDetails

Team merge request reminder details shown to the secondary team
Type:
  • Object
Properties:
Name Type Description
sent_to string The email of the primary team admin the request was sent to.

TeamLogSendForSignaturePolicy

Policy for controlling team access to send for signature feature
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogSendForSignaturePolicyChangedDetails

Changed send for signature policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogSendForSignaturePolicy New send for signature policy.
previous_value TeamLogSendForSignaturePolicy Previous send for signature policy.

TeamLogSendForSignaturePolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSessionLogInfo

Session's logged information.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "web" | "desktop" | "mobile" Tag identifying the subtype variant.
session_id string <optional>
 Session ID.

TeamLogSfAddGroupDetails

Added team to shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.
team_name string Team name.
sharing_permission string <optional>
 Sharing permission.

TeamLogSfAddGroupType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfAllowNonMembersToViewSharedLinksDetails

Allowed non-collaborators to view links to files in shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.
shared_folder_type string <optional>
 Shared folder type.

TeamLogSfAllowNonMembersToViewSharedLinksType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfExternalInviteWarnDetails

Set team members to see warning before sharing folders outside team.
Type:
  • Object
Properties:
Name Type Argument Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.
new_sharing_permission string <optional>
 New sharing permission.
previous_sharing_permission string <optional>
 Previous sharing permission.

TeamLogSfExternalInviteWarnType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfFbInviteChangeRoleDetails

Changed Facebook user's role in shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.
previous_sharing_permission string <optional>
 Previous sharing permission.
new_sharing_permission string <optional>
 New sharing permission.

TeamLogSfFbInviteChangeRoleType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfFbInviteDetails

Invited Facebook users to shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.
sharing_permission string <optional>
 Sharing permission.

TeamLogSfFbInviteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfFbUninviteDetails

Uninvited Facebook user from shared folder.
Type:
  • Object
Properties:
Name Type Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.

TeamLogSfFbUninviteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfInviteGroupDetails

Invited group to shared folder.
Type:
  • Object
Properties:
Name Type Description
target_asset_index number Target asset position in the Assets list.

TeamLogSfInviteGroupType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfTeamGrantAccessDetails

Granted access to shared folder.
Type:
  • Object
Properties:
Name Type Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.

TeamLogSfTeamGrantAccessType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfTeamInviteChangeRoleDetails

Changed team member's role in shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.
new_sharing_permission string <optional>
 New sharing permission.
previous_sharing_permission string <optional>
 Previous sharing permission.

TeamLogSfTeamInviteChangeRoleType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfTeamInviteDetails

Invited team members to shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.
sharing_permission string <optional>
 Sharing permission.

TeamLogSfTeamInviteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfTeamJoinDetails

Joined team member's shared folder.
Type:
  • Object
Properties:
Name Type Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.

TeamLogSfTeamJoinFromOobLinkDetails

Joined team member's shared folder from link.
Type:
  • Object
Properties:
Name Type Argument Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.
token_key string <optional>
 Shared link token key.
sharing_permission string <optional>
 Sharing permission.

TeamLogSfTeamJoinFromOobLinkType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfTeamJoinType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSfTeamUninviteDetails

Unshared folder with team member.
Type:
  • Object
Properties:
Name Type Description
target_asset_index number Target asset position in the Assets list.
original_folder_name string Original shared folder name.

TeamLogSfTeamUninviteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentAddInviteesDetails

Invited user to Dropbox and added them to shared file/folder.
Type:
  • Object
Properties:
Name Type Description
shared_content_access_level SharingAccessLevel Shared content access level.
invitees Array.<Object> A list of invitees.

TeamLogSharedContentAddInviteesType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentAddLinkExpiryDetails

Added expiration date to link for shared file/folder.
Type:
  • Object
Properties:
Name Type Argument Description
new_value Timestamp <optional>
 New shared content link expiration date. Might be missing due to historical data gap.

TeamLogSharedContentAddLinkExpiryType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentAddLinkPasswordDetails

Added password to link for shared file/folder.
Type:
  • Object

TeamLogSharedContentAddLinkPasswordType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentAddMemberDetails

Added users and/or groups to shared file/folder.
Type:
  • Object
Properties:
Name Type Description
shared_content_access_level SharingAccessLevel Shared content access level.

TeamLogSharedContentAddMemberType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentChangeDownloadsPolicyDetails

Changed whether members can download shared file/folder.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogDownloadPolicyType New downloads policy.
previous_value TeamLogDownloadPolicyType <optional>
 Previous downloads policy. Might be missing due to historical data gap.

TeamLogSharedContentChangeDownloadsPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentChangeInviteeRoleDetails

Changed access type of invitee to shared file/folder before invite was accepted.
Type:
  • Object
Properties:
Name Type Argument Description
new_access_level SharingAccessLevel New access level.
invitee string The invitee whose role was changed.
previous_access_level SharingAccessLevel <optional>
 Previous access level. Might be missing due to historical data gap.

TeamLogSharedContentChangeInviteeRoleType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentChangeLinkAudienceDetails

Changed link audience of shared file/folder.
Type:
  • Object
Properties:
Name Type Argument Description
new_value SharingLinkAudience New link audience value.
previous_value SharingLinkAudience <optional>
 Previous link audience value.

TeamLogSharedContentChangeLinkAudienceType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentChangeLinkExpiryDetails

Changed link expiration of shared file/folder.
Type:
  • Object
Properties:
Name Type Argument Description
new_value Timestamp <optional>
 New shared content link expiration date. Might be missing due to historical data gap.
previous_value Timestamp <optional>
 Previous shared content link expiration date. Might be missing due to historical data gap.

TeamLogSharedContentChangeLinkExpiryType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentChangeLinkPasswordDetails

Changed link password of shared file/folder.
Type:
  • Object

TeamLogSharedContentChangeLinkPasswordType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentChangeMemberRoleDetails

Changed access type of shared file/folder member.
Type:
  • Object
Properties:
Name Type Argument Description
new_access_level SharingAccessLevel New access level.
previous_access_level SharingAccessLevel <optional>
 Previous access level. Might be missing due to historical data gap.

TeamLogSharedContentChangeMemberRoleType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentChangeViewerInfoPolicyDetails

Changed whether members can see who viewed shared file/folder.
Type:
  • Object
Properties:
Name Type Argument Description
new_value SharingViewerInfoPolicy New viewer info policy.
previous_value SharingViewerInfoPolicy <optional>
 Previous view info policy.

TeamLogSharedContentChangeViewerInfoPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentClaimInvitationDetails

Acquired membership of shared file/folder by accepting invite.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_link string <optional>
 Shared content link.

TeamLogSharedContentClaimInvitationType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentCopyDetails

Copied shared file/folder to own Dropbox.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_link string Shared content link.
shared_content_access_level SharingAccessLevel Shared content access level.
destination_path string The path where the member saved the content.
shared_content_owner TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 The shared content owner.

TeamLogSharedContentCopyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentDownloadDetails

Downloaded shared file/folder.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_link string Shared content link.
shared_content_access_level SharingAccessLevel Shared content access level.
shared_content_owner TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 The shared content owner.

TeamLogSharedContentDownloadType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentRelinquishMembershipDetails

Left shared file/folder.
Type:
  • Object

TeamLogSharedContentRelinquishMembershipType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentRemoveInviteesDetails

Removed invitee from shared file/folder before invite was accepted.
Type:
  • Object
Properties:
Name Type Description
invitees Array.<Object> A list of invitees.

TeamLogSharedContentRemoveInviteesType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentRemoveLinkExpiryDetails

Removed link expiration date of shared file/folder.
Type:
  • Object
Properties:
Name Type Argument Description
previous_value Timestamp <optional>
 Previous shared content link expiration date. Might be missing due to historical data gap.

TeamLogSharedContentRemoveLinkExpiryType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentRemoveLinkPasswordDetails

Removed link password of shared file/folder.
Type:
  • Object

TeamLogSharedContentRemoveLinkPasswordType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentRemoveMemberDetails

Removed user/group from shared file/folder.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_access_level SharingAccessLevel <optional>
 Shared content access level.

TeamLogSharedContentRemoveMemberType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentRequestAccessDetails

Requested access to shared file/folder.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_link string <optional>
 Shared content link.

TeamLogSharedContentRequestAccessType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentRestoreInviteesDetails

Restored shared file/folder invitees.
Type:
  • Object
Properties:
Name Type Description
shared_content_access_level SharingAccessLevel Shared content access level.
invitees Array.<Object> A list of invitees.

TeamLogSharedContentRestoreInviteesType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentRestoreMemberDetails

Restored users and/or groups to membership of shared file/folder.
Type:
  • Object
Properties:
Name Type Description
shared_content_access_level SharingAccessLevel Shared content access level.

TeamLogSharedContentRestoreMemberType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentUnshareDetails

Unshared file/folder by clearing membership.
Type:
  • Object

TeamLogSharedContentUnshareType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedContentViewDetails

Previewed shared file/folder.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_link string Shared content link.
shared_content_access_level SharingAccessLevel Shared content access level.
shared_content_owner TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 The shared content owner.

TeamLogSharedContentViewType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedFolderChangeLinkPolicyDetails

Changed who can access shared folder via link.
Type:
  • Object
Properties:
Name Type Argument Description
new_value SharingSharedLinkPolicy New shared folder link policy.
previous_value SharingSharedLinkPolicy <optional>
 Previous shared folder link policy. Might be missing due to historical data gap.

TeamLogSharedFolderChangeLinkPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedFolderChangeMembersInheritancePolicyDetails

Changed whether shared folder inherits members from parent folder.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogSharedFolderMembersInheritancePolicy New member inheritance policy.
previous_value TeamLogSharedFolderMembersInheritancePolicy <optional>
 Previous member inheritance policy. Might be missing due to historical data gap.

TeamLogSharedFolderChangeMembersInheritancePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedFolderChangeMembersManagementPolicyDetails

Changed who can add/remove members of shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
new_value SharingAclUpdatePolicy New members management policy.
previous_value SharingAclUpdatePolicy <optional>
 Previous members management policy. Might be missing due to historical data gap.

TeamLogSharedFolderChangeMembersManagementPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedFolderChangeMembersPolicyDetails

Changed who can become member of shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
new_value SharingMemberPolicy New external invite policy.
previous_value SharingMemberPolicy <optional>
 Previous external invite policy. Might be missing due to historical data gap.

TeamLogSharedFolderChangeMembersPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedFolderCreateDetails

Created shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
target_ns_id string <optional>
 Target namespace ID.

TeamLogSharedFolderCreateType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedFolderDeclineInvitationDetails

Declined team member's invite to shared folder.
Type:
  • Object

TeamLogSharedFolderDeclineInvitationType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedFolderMembersInheritancePolicy

Specifies if a shared folder inherits its members from the parent folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'dont_inherit_members' | 'inherit_members' | 'other' Tag identifying the union variant.

TeamLogSharedFolderMountDetails

Added shared folder to own Dropbox.
Type:
  • Object

TeamLogSharedFolderMountType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedFolderNestDetails

Changed parent of shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
previous_parent_ns_id string <optional>
 Previous parent namespace ID.
new_parent_ns_id string <optional>
 New parent namespace ID.
previous_ns_path string <optional>
 Previous namespace path.
new_ns_path string <optional>
 New namespace path.

TeamLogSharedFolderNestType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedFolderTransferOwnershipDetails

Transferred ownership of shared folder to another member.
Type:
  • Object
Properties:
Name Type Argument Description
new_owner_email string The email address of the new shared folder owner.
previous_owner_email string <optional>
 The email address of the previous shared folder owner.

TeamLogSharedFolderTransferOwnershipType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedFolderUnmountDetails

Deleted shared folder from Dropbox.
Type:
  • Object

TeamLogSharedFolderUnmountType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkAccessLevel

Shared link access level.
Type:
  • Object
Properties:
Name Type Description
.tag 'none' | 'reader' | 'writer' | 'other' Tag identifying the union variant.

TeamLogSharedLinkAddExpiryDetails

Added shared link expiration date.
Type:
  • Object
Properties:
Name Type Description
new_value Timestamp New shared link expiration date.

TeamLogSharedLinkAddExpiryType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkChangeExpiryDetails

Changed shared link expiration date.
Type:
  • Object
Properties:
Name Type Argument Description
new_value Timestamp <optional>
 New shared link expiration date. Might be missing due to historical data gap.
previous_value Timestamp <optional>
 Previous shared link expiration date. Might be missing due to historical data gap.

TeamLogSharedLinkChangeExpiryType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkChangeVisibilityDetails

Changed visibility of shared link.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogSharedLinkVisibility New shared link visibility.
previous_value TeamLogSharedLinkVisibility <optional>
 Previous shared link visibility. Might be missing due to historical data gap.

TeamLogSharedLinkChangeVisibilityType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkCopyDetails

Added file/folder to Dropbox from shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_link_owner TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 Shared link owner details. Might be missing due to historical data gap.

TeamLogSharedLinkCopyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkCreateDetails

Created shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_link_access_level TeamLogSharedLinkAccessLevel <optional>
 Defines who can access the shared link. Might be missing due to historical data gap.

TeamLogSharedLinkCreateType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkDisableDetails

Removed shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_link_owner TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 Shared link owner details. Might be missing due to historical data gap.

TeamLogSharedLinkDisableType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkDownloadDetails

Downloaded file/folder from shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_link_owner TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 Shared link owner details. Might be missing due to historical data gap.

TeamLogSharedLinkDownloadType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkRemoveExpiryDetails

Removed shared link expiration date.
Type:
  • Object
Properties:
Name Type Argument Description
previous_value Timestamp <optional>
 Previous shared link expiration date. Might be missing due to historical data gap.

TeamLogSharedLinkRemoveExpiryType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkSettingsAddExpirationDetails

Added an expiration date to the shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_access_level SharingAccessLevel Shared content access level.
shared_content_link string <optional>
 Shared content link.
new_value Timestamp <optional>
 New shared content link expiration date. Might be missing due to historical data gap.

TeamLogSharedLinkSettingsAddExpirationType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkSettingsAddPasswordDetails

Added a password to the shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_access_level SharingAccessLevel Shared content access level.
shared_content_link string <optional>
 Shared content link.

TeamLogSharedLinkSettingsAddPasswordType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkSettingsAllowDownloadDisabledDetails

Disabled downloads.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_access_level SharingAccessLevel Shared content access level.
shared_content_link string <optional>
 Shared content link.

TeamLogSharedLinkSettingsAllowDownloadDisabledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkSettingsAllowDownloadEnabledDetails

Enabled downloads.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_access_level SharingAccessLevel Shared content access level.
shared_content_link string <optional>
 Shared content link.

TeamLogSharedLinkSettingsAllowDownloadEnabledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkSettingsChangeAudienceDetails

Changed the audience of the shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_access_level SharingAccessLevel Shared content access level.
new_value SharingLinkAudience New link audience value.
shared_content_link string <optional>
 Shared content link.
previous_value SharingLinkAudience <optional>
 Previous link audience value.

TeamLogSharedLinkSettingsChangeAudienceType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkSettingsChangeExpirationDetails

Changed the expiration date of the shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_access_level SharingAccessLevel Shared content access level.
shared_content_link string <optional>
 Shared content link.
new_value Timestamp <optional>
 New shared content link expiration date. Might be missing due to historical data gap.
previous_value Timestamp <optional>
 Previous shared content link expiration date. Might be missing due to historical data gap.

TeamLogSharedLinkSettingsChangeExpirationType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkSettingsChangePasswordDetails

Changed the password of the shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_access_level SharingAccessLevel Shared content access level.
shared_content_link string <optional>
 Shared content link.

TeamLogSharedLinkSettingsChangePasswordType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkSettingsRemoveExpirationDetails

Removed the expiration date from the shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_access_level SharingAccessLevel Shared content access level.
shared_content_link string <optional>
 Shared content link.
previous_value Timestamp <optional>
 Previous shared link expiration date. Might be missing due to historical data gap.

TeamLogSharedLinkSettingsRemoveExpirationType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkSettingsRemovePasswordDetails

Removed the password from the shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_content_access_level SharingAccessLevel Shared content access level.
shared_content_link string <optional>
 Shared content link.

TeamLogSharedLinkSettingsRemovePasswordType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkShareDetails

Added members as audience of shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_link_owner TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 Shared link owner details. Might be missing due to historical data gap.
external_users Array.<TeamLogExternalUserLogInfo> <optional>
 Users without a Dropbox account that were added as shared link audience.

TeamLogSharedLinkShareType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkViewDetails

Opened shared link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_link_owner TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 Shared link owner details. Might be missing due to historical data gap.

TeamLogSharedLinkViewType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharedLinkVisibility

Defines who has access to a shared link.
Type:
  • Object
Properties:
Name Type Description
.tag 'no_one' | 'password' | 'public' | 'team_only' | 'other' Tag identifying the union variant.

TeamLogSharedNoteOpenedDetails

Opened shared Paper doc.
Type:
  • Object

TeamLogSharedNoteOpenedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharingChangeFolderJoinPolicyDetails

Changed whether team members can join shared folders owned outside team.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogSharingFolderJoinPolicy New external join policy.
previous_value TeamLogSharingFolderJoinPolicy <optional>
 Previous external join policy. Might be missing due to historical data gap.

TeamLogSharingChangeFolderJoinPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharingChangeLinkAllowChangeExpirationPolicyDetails

Changed the allow remove or change expiration policy for the links shared outside of the team.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogEnforceLinkPasswordPolicy To.
previous_value TeamLogEnforceLinkPasswordPolicy <optional>
 From.

TeamLogSharingChangeLinkAllowChangeExpirationPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharingChangeLinkDefaultExpirationPolicyDetails

Changed the default expiration for the links shared outside of the team.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogDefaultLinkExpirationDaysPolicy To.
previous_value TeamLogDefaultLinkExpirationDaysPolicy <optional>
 From.

TeamLogSharingChangeLinkDefaultExpirationPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharingChangeLinkEnforcePasswordPolicyDetails

Changed the password requirement for the links shared outside of the team.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogChangeLinkExpirationPolicy To.
previous_value TeamLogChangeLinkExpirationPolicy <optional>
 From.

TeamLogSharingChangeLinkEnforcePasswordPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharingChangeLinkPolicyDetails

Changed whether members can share links outside team, and if links are accessible only by team members or anyone by default.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogSharingLinkPolicy New external link accessibility policy.
previous_value TeamLogSharingLinkPolicy <optional>
 Previous external link accessibility policy. Might be missing due to historical data gap.

TeamLogSharingChangeLinkPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharingChangeMemberPolicyDetails

Changed whether members can share files/folders outside team.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogSharingMemberPolicy New external invite policy.
previous_value TeamLogSharingMemberPolicy <optional>
 Previous external invite policy. Might be missing due to historical data gap.

TeamLogSharingChangeMemberPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSharingFolderJoinPolicy

Policy for controlling if team members can join shared folders owned by non team members.
Type:
  • Object
Properties:
Name Type Description
.tag 'from_anyone' | 'from_team_only' | 'other' Tag identifying the union variant.

TeamLogSharingLinkPolicy

Policy for controlling if team members can share links externally
Type:
  • Object
Properties:
Name Type Description
.tag 'default_no_one' | 'default_private' | 'default_public' | 'only_private' | 'other' Tag identifying the union variant.

TeamLogSharingMemberPolicy

External sharing policy
Type:
  • Object
Properties:
Name Type Description
.tag 'allow' | 'forbid' | 'forbid_with_exclusions' | 'other' Tag identifying the union variant.

TeamLogShmodelDisableDownloadsDetails

Disabled downloads for link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_link_owner TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 Shared link owner details. Might be missing due to historical data gap.

TeamLogShmodelDisableDownloadsType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShmodelEnableDownloadsDetails

Enabled downloads for link.
Type:
  • Object
Properties:
Name Type Argument Description
shared_link_owner TeamLogTeamMemberLogInfo | TeamLogTrustedNonTeamMemberLogInfo | TeamLogNonTeamMemberLogInfo | TeamLogUserLogInfo <optional>
 Shared link owner details. Might be missing due to historical data gap.

TeamLogShmodelEnableDownloadsType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShmodelGroupShareDetails

Shared link with group.
Type:
  • Object

TeamLogShmodelGroupShareType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseAccessGrantedDetails

Granted access to showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseAccessGrantedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseAddMemberDetails

Added member to showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseAddMemberType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseArchivedDetails

Archived showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseArchivedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseChangeDownloadPolicyDetails

Enabled/disabled downloading files from Dropbox Showcase for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogShowcaseDownloadPolicy New Dropbox Showcase download policy.
previous_value TeamLogShowcaseDownloadPolicy Previous Dropbox Showcase download policy.

TeamLogShowcaseChangeDownloadPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseChangeEnabledPolicyDetails

Enabled/disabled Dropbox Showcase for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogShowcaseEnabledPolicy New Dropbox Showcase policy.
previous_value TeamLogShowcaseEnabledPolicy Previous Dropbox Showcase policy.

TeamLogShowcaseChangeEnabledPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseChangeExternalSharingPolicyDetails

Enabled/disabled sharing Dropbox Showcase externally for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogShowcaseExternalSharingPolicy New Dropbox Showcase external sharing policy.
previous_value TeamLogShowcaseExternalSharingPolicy Previous Dropbox Showcase external sharing policy.

TeamLogShowcaseChangeExternalSharingPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseCreatedDetails

Created showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseCreatedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseDeleteCommentDetails

Deleted showcase comment.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
comment_text string <optional>
 Comment text.

TeamLogShowcaseDeleteCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseDocumentLogInfo

Showcase document's logged information.
Type:
  • Object
Properties:
Name Type Description
showcase_id string Showcase document Id.
showcase_title string Showcase document title.

TeamLogShowcaseDownloadPolicy

Policy for controlling if files can be downloaded from Showcases by team members
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogShowcaseEditCommentDetails

Edited showcase comment.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
comment_text string <optional>
 Comment text.

TeamLogShowcaseEditCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseEditedDetails

Edited showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseEditedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseEnabledPolicy

Policy for controlling whether Showcase is enabled.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogShowcaseExternalSharingPolicy

Policy for controlling if team members can share Showcases externally.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogShowcaseFileAddedDetails

Added file to showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseFileAddedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseFileDownloadDetails

Downloaded file from showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.
download_type string Showcase download type.

TeamLogShowcaseFileDownloadType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseFileRemovedDetails

Removed file from showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseFileRemovedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseFileViewDetails

Viewed file in showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseFileViewType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcasePermanentlyDeletedDetails

Permanently deleted showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcasePermanentlyDeletedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcasePostCommentDetails

Added showcase comment.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
comment_text string <optional>
 Comment text.

TeamLogShowcasePostCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseRemoveMemberDetails

Removed member from showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseRemoveMemberType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseRenamedDetails

Renamed showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseRenamedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseRequestAccessDetails

Requested access to showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseRequestAccessType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseResolveCommentDetails

Resolved showcase comment.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
comment_text string <optional>
 Comment text.

TeamLogShowcaseResolveCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseRestoredDetails

Unarchived showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseRestoredType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseTrashedDeprecatedDetails

Deleted showcase (old version).
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseTrashedDeprecatedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseTrashedDetails

Deleted showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseTrashedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseUnresolveCommentDetails

Unresolved showcase comment.
Type:
  • Object
Properties:
Name Type Argument Description
event_uuid string Event unique identifier.
comment_text string <optional>
 Comment text.

TeamLogShowcaseUnresolveCommentType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseUntrashedDeprecatedDetails

Restored showcase (old version).
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseUntrashedDeprecatedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseUntrashedDetails

Restored showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseUntrashedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogShowcaseViewDetails

Viewed showcase.
Type:
  • Object
Properties:
Name Type Description
event_uuid string Event unique identifier.

TeamLogShowcaseViewType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSignInAsSessionEndDetails

Ended admin sign-in-as session.
Type:
  • Object

TeamLogSignInAsSessionEndType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSignInAsSessionStartDetails

Started admin sign-in-as session.
Type:
  • Object

TeamLogSignInAsSessionStartType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSmarterSmartSyncPolicyChangedDetails

Changed automatic Smart Sync setting for team.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamPoliciesSmarterSmartSyncPolicyState Previous automatic Smart Sync setting.
new_value TeamPoliciesSmarterSmartSyncPolicyState New automatic Smart Sync setting.

TeamLogSmarterSmartSyncPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSmartSyncChangePolicyDetails

Changed default Smart Sync setting for team members.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamPoliciesSmartSyncPolicy <optional>
 New smart sync policy.
previous_value TeamPoliciesSmartSyncPolicy <optional>
 Previous smart sync policy.

TeamLogSmartSyncChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSmartSyncCreateAdminPrivilegeReportDetails

Created Smart Sync non-admin devices report.
Type:
  • Object

TeamLogSmartSyncCreateAdminPrivilegeReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSmartSyncNotOptOutDetails

Opted team into Smart Sync.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogSmartSyncOptOutPolicy Previous Smart Sync opt out policy.
new_value TeamLogSmartSyncOptOutPolicy New Smart Sync opt out policy.

TeamLogSmartSyncNotOptOutType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSmartSyncOptOutDetails

Opted team out of Smart Sync.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogSmartSyncOptOutPolicy Previous Smart Sync opt out policy.
new_value TeamLogSmartSyncOptOutPolicy New Smart Sync opt out policy.

TeamLogSmartSyncOptOutPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'opted_out' | 'other' Tag identifying the union variant.

TeamLogSmartSyncOptOutType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSpaceCapsType

Space limit alert policy
Type:
  • Object
Properties:
Name Type Description
.tag 'hard' | 'off' | 'soft' | 'other' Tag identifying the union variant.

TeamLogSpaceLimitsStatus

Type:
  • Object
Properties:
Name Type Description
.tag 'near_quota' | 'over_quota' | 'within_quota' | 'other' Tag identifying the union variant.

TeamLogSsoAddCertDetails

Added X.509 certificate for SSO.
Type:
  • Object
Properties:
Name Type Description
certificate_details TeamLogCertificate SSO certificate details.

TeamLogSsoAddCertType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoAddLoginUrlDetails

Added sign-in URL for SSO.
Type:
  • Object
Properties:
Name Type Description
new_value string New single sign-on login URL.

TeamLogSsoAddLoginUrlType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoAddLogoutUrlDetails

Added sign-out URL for SSO.
Type:
  • Object
Properties:
Name Type Argument Description
new_value string <optional>
 New single sign-on logout URL.

TeamLogSsoAddLogoutUrlType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoChangeCertDetails

Changed X.509 certificate for SSO.
Type:
  • Object
Properties:
Name Type Argument Description
new_certificate_details TeamLogCertificate New SSO certificate details.
previous_certificate_details TeamLogCertificate <optional>
 Previous SSO certificate details. Might be missing due to historical data gap.

TeamLogSsoChangeCertType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoChangeLoginUrlDetails

Changed sign-in URL for SSO.
Type:
  • Object
Properties:
Name Type Description
previous_value string Previous single sign-on login URL.
new_value string New single sign-on login URL.

TeamLogSsoChangeLoginUrlType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoChangeLogoutUrlDetails

Changed sign-out URL for SSO.
Type:
  • Object
Properties:
Name Type Argument Description
previous_value string <optional>
 Previous single sign-on logout URL. Might be missing due to historical data gap.
new_value string <optional>
 New single sign-on logout URL.

TeamLogSsoChangeLogoutUrlType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoChangePolicyDetails

Changed single sign-on setting for team.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamPoliciesSsoPolicy New single sign-on policy.
previous_value TeamPoliciesSsoPolicy <optional>
 Previous single sign-on policy. Might be missing due to historical data gap.

TeamLogSsoChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoChangeSamlIdentityModeDetails

Changed SAML identity mode for SSO.
Type:
  • Object
Properties:
Name Type Description
previous_value number Previous single sign-on identity mode.
new_value number New single sign-on identity mode.

TeamLogSsoChangeSamlIdentityModeType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoErrorDetails

Failed to sign in via SSO.
Type:
  • Object
Properties:
Name Type Description
error_details TeamLogFailureDetailsLogInfo Error details.

TeamLogSsoErrorType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoRemoveCertDetails

Removed X.509 certificate for SSO.
Type:
  • Object

TeamLogSsoRemoveCertType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoRemoveLoginUrlDetails

Removed sign-in URL for SSO.
Type:
  • Object
Properties:
Name Type Description
previous_value string Previous single sign-on login URL.

TeamLogSsoRemoveLoginUrlType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogSsoRemoveLogoutUrlDetails

Removed sign-out URL for SSO.
Type:
  • Object
Properties:
Name Type Description
previous_value string Previous single sign-on logout URL.

TeamLogSsoRemoveLogoutUrlType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogStartedEnterpriseAdminSessionDetails

Started enterprise admin session.
Type:
  • Object
Properties:
Name Type Description
federation_extra_details TeamLogFedExtraDetails More information about the organization or team.

TeamLogStartedEnterpriseAdminSessionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamActivityCreateReportDetails

Created team activity report.
Type:
  • Object
Properties:
Name Type Description
start_date Timestamp Report start date.
end_date Timestamp Report end date.

TeamLogTeamActivityCreateReportFailDetails

Couldn't generate team activity report.
Type:
  • Object
Properties:
Name Type Description
failure_reason TeamTeamReportFailureReason Failure reason.

TeamLogTeamActivityCreateReportFailType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamActivityCreateReportType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamBrandingPolicy

Policy for controlling team access to setting up branding feature
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogTeamBrandingPolicyChangedDetails

Changed team branding policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogTeamBrandingPolicy New team branding policy.
previous_value TeamLogTeamBrandingPolicy Previous team branding policy.

TeamLogTeamBrandingPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamDetails

More details about the team.
Type:
  • Object
Properties:
Name Type Description
team string The name of the team.

TeamLogTeamEvent

An audit log event.
Type:
  • Object
Properties:
Name Type Argument Description
timestamp Timestamp The Dropbox timestamp representing when the action was taken.
event_category TeamLogEventCategory The category that this type of action belongs to.
event_type TeamLogEventType The particular type of action taken.
details TeamLogEventDetails The variable event schema applicable to this type of action, instantiated with respect to this particular action.
actor TeamLogActorLogInfo <optional>
 The entity who actually performed the action. Might be missing due to historical data gap.
origin TeamLogOriginLogInfo <optional>
 The origin from which the actor performed the action including information about host, ip address, location, session, etc. If the action was performed programmatically via the API the origin represents the API client.
involve_non_team_member boolean <optional>
 True if the action involved a non team member either as the actor or as one of the affected users. Might be missing due to historical data gap.
context TeamLogContextLogInfo <optional>
 The user or team on whose behalf the actor performed the action. Might be missing due to historical data gap.
participants Array.<TeamLogParticipantLogInfo> <optional>
 Zero or more users and/or groups that are affected by the action. Note that this list doesn't include any actors or users in context.
assets Array.<TeamLogAssetLogInfo> <optional>
 Zero or more content assets involved in the action. Currently these include Dropbox files and folders but in the future we might add other asset types such as Paper documents, folders, projects, etc.

TeamLogTeamExtensionsPolicy

Policy for controlling whether App Integrations are enabled for the team.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogTeamExtensionsPolicyChangedDetails

Changed App Integrations setting for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogTeamExtensionsPolicy New Extensions policy.
previous_value TeamLogTeamExtensionsPolicy Previous Extensions policy.

TeamLogTeamExtensionsPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamFolderChangeStatusDetails

Changed archival status of team folder.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamTeamFolderStatus New team folder status.
previous_value TeamTeamFolderStatus <optional>
 Previous team folder status. Might be missing due to historical data gap.

TeamLogTeamFolderChangeStatusType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamFolderCreateDetails

Created team folder in active status.
Type:
  • Object

TeamLogTeamFolderCreateType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamFolderDowngradeDetails

Downgraded team folder to regular shared folder.
Type:
  • Object
Properties:
Name Type Description
target_asset_index number Target asset position in the Assets list.

TeamLogTeamFolderDowngradeType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamFolderPermanentlyDeleteDetails

Permanently deleted archived team folder.
Type:
  • Object

TeamLogTeamFolderPermanentlyDeleteType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamFolderRenameDetails

Renamed active/archived team folder.
Type:
  • Object
Properties:
Name Type Description
previous_folder_name string Previous folder name.
new_folder_name string New folder name.

TeamLogTeamFolderRenameType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamInviteDetails

Details about team invites
Type:
  • Object
Properties:
Name Type Argument Description
invite_method TeamLogInviteMethod How the user was invited to the team.
additional_license_purchase boolean <optional>
 True if the invitation incurred an additional license purchase.

TeamLogTeamLinkedAppLogInfo

Team linked app
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'team_linked_app' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
app_id string <optional>
 App unique ID.
display_name string <optional>
 App display name.

TeamLogTeamLogInfo

Team's logged information.
Type:
  • Object
Properties:
Name Type Description
display_name string Team display name.

TeamLogTeamMemberLogInfo

Team member's logged information.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'team_member' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
account_id string <optional>
 User unique ID.
display_name string <optional>
 User display name.
email string <optional>
 User email address.
team_member_id string <optional>
 Team member ID.
member_external_id string <optional>
 Team member external ID.
team TeamLogTeamLogInfo <optional>
 Details about this user’s team for enterprise event.

TeamLogTeamMembershipType

Type:
  • Object
Properties:
Name Type Description
.tag 'free' | 'full' | 'guest' | 'other' Tag identifying the union variant.

TeamLogTeamMergeFromDetails

Merged another team into this team.
Type:
  • Object
Properties:
Name Type Description
team_name string The name of the team that was merged into this team.

TeamLogTeamMergeFromType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestAcceptedDetails

Accepted a team merge request.
Type:
  • Object
Properties:
Name Type Description
request_accepted_details TeamLogTeamMergeRequestAcceptedExtraDetails Team merge request acceptance details.

TeamLogTeamMergeRequestAcceptedExtraDetails

Team merge request acceptance details
Type:
  • Object
Properties:
Name Type Argument Description
primary_team TeamLogPrimaryTeamRequestAcceptedDetails <optional>
 Available if .tag is primary_team. Team merge request accepted details shown to the primary team.
secondary_team TeamLogSecondaryTeamRequestAcceptedDetails <optional>
 Available if .tag is secondary_team. Team merge request accepted details shown to the secondary team.
.tag 'primary_team' | 'secondary_team' | 'other' Tag identifying the union variant.

TeamLogTeamMergeRequestAcceptedShownToPrimaryTeamDetails

Accepted a team merge request.
Type:
  • Object
Properties:
Name Type Description
secondary_team string The secondary team name.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogTeamMergeRequestAcceptedShownToPrimaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestAcceptedShownToSecondaryTeamDetails

Accepted a team merge request.
Type:
  • Object
Properties:
Name Type Description
primary_team string The primary team name.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogTeamMergeRequestAcceptedShownToSecondaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestAcceptedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestAutoCanceledDetails

Automatically canceled team merge request.
Type:
  • Object
Properties:
Name Type Argument Description
details string <optional>
 The cancellation reason.

TeamLogTeamMergeRequestAutoCanceledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestCanceledDetails

Canceled a team merge request.
Type:
  • Object
Properties:
Name Type Description
request_canceled_details TeamLogTeamMergeRequestCanceledExtraDetails Team merge request cancellation details.

TeamLogTeamMergeRequestCanceledExtraDetails

Team merge request cancellation details
Type:
  • Object
Properties:
Name Type Argument Description
primary_team TeamLogPrimaryTeamRequestCanceledDetails <optional>
 Available if .tag is primary_team. Team merge request cancellation details shown to the primary team.
secondary_team TeamLogSecondaryTeamRequestCanceledDetails <optional>
 Available if .tag is secondary_team. Team merge request cancellation details shown to the secondary team.
.tag 'primary_team' | 'secondary_team' | 'other' Tag identifying the union variant.

TeamLogTeamMergeRequestCanceledShownToPrimaryTeamDetails

Canceled a team merge request.
Type:
  • Object
Properties:
Name Type Description
secondary_team string The secondary team name.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogTeamMergeRequestCanceledShownToPrimaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestCanceledShownToSecondaryTeamDetails

Canceled a team merge request.
Type:
  • Object
Properties:
Name Type Description
sent_to string The email of the primary team admin that the request was sent to.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogTeamMergeRequestCanceledShownToSecondaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestCanceledType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestExpiredDetails

Team merge request expired.
Type:
  • Object
Properties:
Name Type Description
request_expired_details TeamLogTeamMergeRequestExpiredExtraDetails Team merge request expiration details.

TeamLogTeamMergeRequestExpiredExtraDetails

Team merge request expiration details
Type:
  • Object
Properties:
Name Type Argument Description
primary_team TeamLogPrimaryTeamRequestExpiredDetails <optional>
 Available if .tag is primary_team. Team merge request canceled details shown to the primary team.
secondary_team TeamLogSecondaryTeamRequestExpiredDetails <optional>
 Available if .tag is secondary_team. Team merge request canceled details shown to the secondary team.
.tag 'primary_team' | 'secondary_team' | 'other' Tag identifying the union variant.

TeamLogTeamMergeRequestExpiredShownToPrimaryTeamDetails

Team merge request expired.
Type:
  • Object
Properties:
Name Type Description
secondary_team string The secondary team name.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogTeamMergeRequestExpiredShownToPrimaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestExpiredShownToSecondaryTeamDetails

Team merge request expired.
Type:
  • Object
Properties:
Name Type Description
sent_to string The email of the primary team admin the request was sent to.

TeamLogTeamMergeRequestExpiredShownToSecondaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestExpiredType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestRejectedShownToPrimaryTeamDetails

Rejected a team merge request.
Type:
  • Object
Properties:
Name Type Description
secondary_team string The secondary team name.
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogTeamMergeRequestRejectedShownToPrimaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestRejectedShownToSecondaryTeamDetails

Rejected a team merge request.
Type:
  • Object
Properties:
Name Type Description
sent_by string The name of the secondary team admin who sent the request originally.

TeamLogTeamMergeRequestRejectedShownToSecondaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestReminderDetails

Sent a team merge request reminder.
Type:
  • Object
Properties:
Name Type Description
request_reminder_details TeamLogTeamMergeRequestReminderExtraDetails Team merge request reminder details.

TeamLogTeamMergeRequestReminderExtraDetails

Team merge request reminder details
Type:
  • Object
Properties:
Name Type Argument Description
primary_team TeamLogPrimaryTeamRequestReminderDetails <optional>
 Available if .tag is primary_team. Team merge request reminder details shown to the primary team.
secondary_team TeamLogSecondaryTeamRequestReminderDetails <optional>
 Available if .tag is secondary_team. Team merge request reminder details shown to the secondary team.
.tag 'primary_team' | 'secondary_team' | 'other' Tag identifying the union variant.

TeamLogTeamMergeRequestReminderShownToPrimaryTeamDetails

Sent a team merge request reminder.
Type:
  • Object
Properties:
Name Type Description
secondary_team string The secondary team name.
sent_to string The name of the primary team admin the request was sent to.

TeamLogTeamMergeRequestReminderShownToPrimaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestReminderShownToSecondaryTeamDetails

Sent a team merge request reminder.
Type:
  • Object
Properties:
Name Type Description
sent_to string The email of the primary team admin the request was sent to.

TeamLogTeamMergeRequestReminderShownToSecondaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestReminderType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestRevokedDetails

Canceled the team merge.
Type:
  • Object
Properties:
Name Type Description
team string The name of the other team.

TeamLogTeamMergeRequestRevokedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestSentShownToPrimaryTeamDetails

Requested to merge their Dropbox team into yours.
Type:
  • Object
Properties:
Name Type Description
secondary_team string The secondary team name.
sent_to string The name of the primary team admin the request was sent to.

TeamLogTeamMergeRequestSentShownToPrimaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeRequestSentShownToSecondaryTeamDetails

Requested to merge your team into another Dropbox team.
Type:
  • Object
Properties:
Name Type Description
sent_to string The email of the primary team admin the request was sent to.

TeamLogTeamMergeRequestSentShownToSecondaryTeamType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamMergeToDetails

Merged this team into another team.
Type:
  • Object
Properties:
Name Type Description
team_name string The name of the team that this team was merged into.

TeamLogTeamMergeToType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamName

Team name details
Type:
  • Object
Properties:
Name Type Description
team_display_name string Team's display name.
team_legal_name string Team's legal name.

TeamLogTeamProfileAddBackgroundDetails

Added team background to display on shared link headers.
Type:
  • Object

TeamLogTeamProfileAddBackgroundType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamProfileAddLogoDetails

Added team logo to display on shared link headers.
Type:
  • Object

TeamLogTeamProfileAddLogoType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamProfileChangeBackgroundDetails

Changed team background displayed on shared link headers.
Type:
  • Object

TeamLogTeamProfileChangeBackgroundType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamProfileChangeDefaultLanguageDetails

Changed default language for team.
Type:
  • Object
Properties:
Name Type Description
new_value string New team's default language.
previous_value string Previous team's default language.

TeamLogTeamProfileChangeDefaultLanguageType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamProfileChangeLogoDetails

Changed team logo displayed on shared link headers.
Type:
  • Object

TeamLogTeamProfileChangeLogoType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamProfileChangeNameDetails

Changed team name.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogTeamName New team name.
previous_value TeamLogTeamName <optional>
 Previous teams name. Might be missing due to historical data gap.

TeamLogTeamProfileChangeNameType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamProfileRemoveBackgroundDetails

Removed team background displayed on shared link headers.
Type:
  • Object

TeamLogTeamProfileRemoveBackgroundType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamProfileRemoveLogoDetails

Removed team logo displayed on shared link headers.
Type:
  • Object

TeamLogTeamProfileRemoveLogoType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamSelectiveSyncPolicy

Policy for controlling whether team selective sync is enabled for team.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogTeamSelectiveSyncPolicyChangedDetails

Enabled/disabled Team Selective Sync for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogTeamSelectiveSyncPolicy New Team Selective Sync policy.
previous_value TeamLogTeamSelectiveSyncPolicy Previous Team Selective Sync policy.

TeamLogTeamSelectiveSyncPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamSelectiveSyncSettingsChangedDetails

Changed sync default.
Type:
  • Object
Properties:
Name Type Description
previous_value FilesSyncSetting Previous value.
new_value FilesSyncSetting New value.

TeamLogTeamSelectiveSyncSettingsChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTeamSharingWhitelistSubjectsChangedDetails

Edited the approved list for sharing externally.
Type:
  • Object
Properties:
Name Type Description
added_whitelist_subjects Array.<string> Domains or emails added to the approved list for sharing externally.
removed_whitelist_subjects Array.<string> Domains or emails removed from the approved list for sharing externally.

TeamLogTeamSharingWhitelistSubjectsChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTfaAddBackupPhoneDetails

Added backup phone for two-step verification.
Type:
  • Object

TeamLogTfaAddBackupPhoneType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTfaAddExceptionDetails

Added members to two factor authentication exception list.
Type:
  • Object

TeamLogTfaAddExceptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTfaAddSecurityKeyDetails

Added security key for two-step verification.
Type:
  • Object

TeamLogTfaAddSecurityKeyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTfaChangeBackupPhoneDetails

Changed backup phone for two-step verification.
Type:
  • Object

TeamLogTfaChangeBackupPhoneType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTfaChangePolicyDetails

Changed two-step verification setting for team.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamPoliciesTwoStepVerificationPolicy New change policy.
previous_value TeamPoliciesTwoStepVerificationPolicy <optional>
 Previous change policy. Might be missing due to historical data gap.

TeamLogTfaChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTfaChangeStatusDetails

Enabled/disabled/changed two-step verification setting.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogTfaConfiguration The new two factor authentication configuration.
previous_value TeamLogTfaConfiguration <optional>
 The previous two factor authentication configuration. Might be missing due to historical data gap.
used_rescue_code boolean <optional>
 Used two factor authentication rescue code. This flag is relevant when the two factor authentication configuration is disabled.

TeamLogTfaChangeStatusType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTfaConfiguration

Two factor authentication configuration. Note: the enabled option is deprecated.
Type:
  • Object
Properties:
Name Type Description
.tag 'authenticator' | 'disabled' | 'enabled' | 'sms' | 'other' Tag identifying the union variant.

TeamLogTfaRemoveBackupPhoneDetails

Removed backup phone for two-step verification.
Type:
  • Object

TeamLogTfaRemoveBackupPhoneType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTfaRemoveExceptionDetails

Removed members from two factor authentication exception list.
Type:
  • Object

TeamLogTfaRemoveExceptionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTfaRemoveSecurityKeyDetails

Removed security key for two-step verification.
Type:
  • Object

TeamLogTfaRemoveSecurityKeyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTfaResetDetails

Reset two-step verification for team member.
Type:
  • Object

TeamLogTfaResetType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTimeUnit

Type:
  • Object
Properties:
Name Type Description
.tag 'days' | 'hours' | 'milliseconds' | 'minutes' | 'months' | 'seconds' | 'weeks' | 'years' | 'other' Tag identifying the union variant.

TeamLogTrustedNonTeamMemberLogInfo

User that is not a member of the team but considered trusted.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'trusted_non_team_member' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
trusted_non_team_member_type TeamLogTrustedNonTeamMemberType Indicates the type of the member of a trusted team.
account_id string <optional>
 User unique ID.
display_name string <optional>
 User display name.
email string <optional>
 User email address.
team TeamLogTeamLogInfo <optional>
 Details about this user's trusted team.

TeamLogTrustedNonTeamMemberType

Type:
  • Object
Properties:
Name Type Description
.tag 'enterprise_admin' | 'multi_instance_admin' | 'other' Tag identifying the union variant.

TeamLogTrustedTeamsRequestAction

Type:
  • Object
Properties:
Name Type Description
.tag 'accepted' | 'declined' | 'expired' | 'invited' | 'revoked' | 'other' Tag identifying the union variant.

TeamLogTrustedTeamsRequestState

Type:
  • Object
Properties:
Name Type Description
.tag 'invited' | 'linked' | 'unlinked' | 'other' Tag identifying the union variant.

TeamLogTwoAccountChangePolicyDetails

Enabled/disabled option for members to link personal Dropbox account and team account to same computer.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogTwoAccountPolicy New two account policy.
previous_value TeamLogTwoAccountPolicy <optional>
 Previous two account policy. Might be missing due to historical data gap.

TeamLogTwoAccountChangePolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogTwoAccountPolicy

Policy for pairing personal account to work account
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogUndoNamingConventionDetails

Reverted naming convention.
Type:
  • Object

TeamLogUndoNamingConventionType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogUndoOrganizeFolderWithTidyDetails

Removed multi-file organize.
Type:
  • Object

TeamLogUndoOrganizeFolderWithTidyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogUserLinkedAppLogInfo

User linked app
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'user_linked_app' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
app_id string <optional>
 App unique ID.
display_name string <optional>
 App display name.

TeamLogUserLogInfo

User's logged information.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "team_member" | "trusted_non_team_member" | "non_team_member" Tag identifying the subtype variant.
account_id string <optional>
 User unique ID.
display_name string <optional>
 User display name.
email string <optional>
 User email address.

TeamLogUserNameLogInfo

User's name logged information
Type:
  • Object
Properties:
Name Type Argument Description
given_name string Given name.
surname string Surname.
locale string <optional>
 Locale. Might be missing due to historical data gap.

TeamLogUserOrTeamLinkedAppLogInfo

User or team linked app. Used when linked type is missing due to historical data gap.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'user_or_team_linked_app' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
app_id string <optional>
 App unique ID.
display_name string <optional>
 App display name.

TeamLogUserTagsAddedDetails

Tagged a file.
Type:
  • Object
Properties:
Name Type Description
values Array.<string> values.

TeamLogUserTagsAddedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogUserTagsRemovedDetails

Removed tags.
Type:
  • Object
Properties:
Name Type Description
values Array.<string> values.

TeamLogUserTagsRemovedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogViewerInfoPolicyChangedDetails

Changed team policy for viewer info.
Type:
  • Object
Properties:
Name Type Description
previous_value TeamLogPassPolicy Previous Viewer Info policy.
new_value TeamLogPassPolicy New Viewer Info policy.

TeamLogViewerInfoPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogWatermarkingPolicy

Policy for controlling team access to watermarking feature
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamLogWatermarkingPolicyChangedDetails

Changed watermarking policy for team.
Type:
  • Object
Properties:
Name Type Description
new_value TeamLogWatermarkingPolicy New watermarking policy.
previous_value TeamLogWatermarkingPolicy Previous watermarking policy.

TeamLogWatermarkingPolicyChangedType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogWebDeviceSessionLogInfo

Information on active web sessions
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'web_device_session' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
user_agent string Information on the hosting device.
os string Information on the hosting operating system.
browser string Information on the browser used for this web session.
ip_address string <optional>
 The IP address of the last activity from this session.
created Timestamp <optional>
 The time this session was created.
updated Timestamp <optional>
 The time of the last activity from this session.
session_info TeamLogWebSessionLogInfo <optional>
 Web session unique id.

TeamLogWebSessionLogInfo

Web session.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'web' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
session_id string <optional>
 Session ID.

TeamLogWebSessionsChangeActiveSessionLimitDetails

Changed limit on active sessions per member.
Type:
  • Object
Properties:
Name Type Description
previous_value string Previous max number of concurrent active sessions policy.
new_value string New max number of concurrent active sessions policy.

TeamLogWebSessionsChangeActiveSessionLimitType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogWebSessionsChangeFixedLengthPolicyDetails

Changed how long members can stay signed in to Dropbox.com.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogWebSessionsFixedLengthPolicy <optional>
 New session length policy. Might be missing due to historical data gap.
previous_value TeamLogWebSessionsFixedLengthPolicy <optional>
 Previous session length policy. Might be missing due to historical data gap.

TeamLogWebSessionsChangeFixedLengthPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogWebSessionsChangeIdleLengthPolicyDetails

Changed how long team members can be idle while signed in to Dropbox.com.
Type:
  • Object
Properties:
Name Type Argument Description
new_value TeamLogWebSessionsIdleLengthPolicy <optional>
 New idle length policy. Might be missing due to historical data gap.
previous_value TeamLogWebSessionsIdleLengthPolicy <optional>
 Previous idle length policy. Might be missing due to historical data gap.

TeamLogWebSessionsChangeIdleLengthPolicyType

Type:
  • Object
Properties:
Name Type Description
description string

TeamLogWebSessionsFixedLengthPolicy

Web sessions fixed length policy.
Type:
  • Object
Properties:
Name Type Argument Description
defined TeamLogDurationLogInfo <optional>
 Available if .tag is defined. Defined fixed session length.
.tag 'defined' | 'undefined' | 'other' Tag identifying the union variant.

TeamLogWebSessionsIdleLengthPolicy

Web sessions idle length policy.
Type:
  • Object
Properties:
Name Type Argument Description
defined TeamLogDurationLogInfo <optional>
 Available if .tag is defined. Defined idle session length.
.tag 'defined' | 'undefined' | 'other' Tag identifying the union variant.

TeamMemberAccess

Specify access type a member should have when joined to a group.
Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg Identity of a user.
access_type TeamGroupAccessType Access type.

TeamMemberAddArg

Type:
  • Object
Properties:
Name Type Argument Description
member_email string
member_given_name string <optional>
 Member's first name.
member_surname string <optional>
 Member's last name.
member_external_id string <optional>
 External ID for member.
member_persistent_id string <optional>
 Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.
send_welcome_email boolean Whether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves.
is_directory_restricted boolean <optional>
 Whether a user is directory restricted.
role TeamAdminTier

TeamMemberAddArgBase

Type:
  • Object
Properties:
Name Type Argument Description
member_email string
member_given_name string <optional>
 Member's first name.
member_surname string <optional>
 Member's last name.
member_external_id string <optional>
 External ID for member.
member_persistent_id string <optional>
 Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.
send_welcome_email boolean Whether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves.
is_directory_restricted boolean <optional>
 Whether a user is directory restricted.

TeamMemberAddResult

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.
Type:
  • Object
Properties:
Name Type Argument Description
team_license_limit string <optional>
 Available if .tag is team_license_limit. Team is already full. The organization has no available licenses.
free_team_member_limit_reached string <optional>
 Available if .tag is free_team_member_limit_reached. Team is already full. The free team member limit has been reached.
user_already_on_team string <optional>
 Available if .tag is user_already_on_team. 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.
user_on_another_team string <optional>
 Available if .tag is user_on_another_team. 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.
user_already_paired string <optional>
 Available if .tag is user_already_paired. User is already paired.
user_migration_failed string <optional>
 Available if .tag is user_migration_failed. User migration has failed.
duplicate_external_member_id string <optional>
 Available if .tag is duplicate_external_member_id. A user with the given external member ID already exists on the team (including in recoverable state).
duplicate_member_persistent_id string <optional>
 Available if .tag is duplicate_member_persistent_id. A user with the given persistent ID already exists on the team (including in recoverable state).
persistent_id_disabled string <optional>
 Available if .tag is persistent_id_disabled. Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.
user_creation_failed string <optional>
 Available if .tag is user_creation_failed. User creation has failed.
success TeamTeamMemberInfo <optional>
 Available if .tag is success. Describes a user that was successfully added to the team.
.tag 'team_license_limit' | 'free_team_member_limit_reached' | 'user_already_on_team' | 'user_on_another_team' | 'user_already_paired' | 'user_migration_failed' | 'duplicate_external_member_id' | 'duplicate_member_persistent_id' | 'persistent_id_disabled' | 'user_creation_failed' | 'success' Tag identifying the union variant.

TeamMemberAddResultBase

Type:
  • Object
Properties:
Name Type Argument Description
team_license_limit string <optional>
 Available if .tag is team_license_limit. Team is already full. The organization has no available licenses.
free_team_member_limit_reached string <optional>
 Available if .tag is free_team_member_limit_reached. Team is already full. The free team member limit has been reached.
user_already_on_team string <optional>
 Available if .tag is user_already_on_team. 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.
user_on_another_team string <optional>
 Available if .tag is user_on_another_team. 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.
user_already_paired string <optional>
 Available if .tag is user_already_paired. User is already paired.
user_migration_failed string <optional>
 Available if .tag is user_migration_failed. User migration has failed.
duplicate_external_member_id string <optional>
 Available if .tag is duplicate_external_member_id. A user with the given external member ID already exists on the team (including in recoverable state).
duplicate_member_persistent_id string <optional>
 Available if .tag is duplicate_member_persistent_id. A user with the given persistent ID already exists on the team (including in recoverable state).
persistent_id_disabled string <optional>
 Available if .tag is persistent_id_disabled. Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.
user_creation_failed string <optional>
 Available if .tag is user_creation_failed. User creation has failed.
.tag 'team_license_limit' | 'free_team_member_limit_reached' | 'user_already_on_team' | 'user_on_another_team' | 'user_already_paired' | 'user_migration_failed' | 'duplicate_external_member_id' | 'duplicate_member_persistent_id' | 'persistent_id_disabled' | 'user_creation_failed' Tag identifying the union variant.

TeamMemberAddV2Arg

Type:
  • Object
Properties:
Name Type Argument Description
member_email string
member_given_name string <optional>
 Member's first name.
member_surname string <optional>
 Member's last name.
member_external_id string <optional>
 External ID for member.
member_persistent_id string <optional>
 Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.
send_welcome_email boolean Whether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves.
is_directory_restricted boolean <optional>
 Whether a user is directory restricted.
role_ids Array.<Object> <optional>

TeamMemberAddV2Result

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.
Type:
  • Object
Properties:
Name Type Argument Description
team_license_limit string <optional>
 Available if .tag is team_license_limit. Team is already full. The organization has no available licenses.
free_team_member_limit_reached string <optional>
 Available if .tag is free_team_member_limit_reached. Team is already full. The free team member limit has been reached.
user_already_on_team string <optional>
 Available if .tag is user_already_on_team. 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.
user_on_another_team string <optional>
 Available if .tag is user_on_another_team. 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.
user_already_paired string <optional>
 Available if .tag is user_already_paired. User is already paired.
user_migration_failed string <optional>
 Available if .tag is user_migration_failed. User migration has failed.
duplicate_external_member_id string <optional>
 Available if .tag is duplicate_external_member_id. A user with the given external member ID already exists on the team (including in recoverable state).
duplicate_member_persistent_id string <optional>
 Available if .tag is duplicate_member_persistent_id. A user with the given persistent ID already exists on the team (including in recoverable state).
persistent_id_disabled string <optional>
 Available if .tag is persistent_id_disabled. Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.
user_creation_failed string <optional>
 Available if .tag is user_creation_failed. User creation has failed.
success TeamTeamMemberInfoV2 <optional>
 Available if .tag is success. Describes a user that was successfully added to the team.
.tag 'team_license_limit' | 'free_team_member_limit_reached' | 'user_already_on_team' | 'user_on_another_team' | 'user_already_paired' | 'user_migration_failed' | 'duplicate_external_member_id' | 'duplicate_member_persistent_id' | 'persistent_id_disabled' | 'user_creation_failed' | 'success' | 'other' Tag identifying the union variant.

TeamMemberDevices

Information on devices of a team's member.
Type:
  • Object
Properties:
Name Type Argument Description
team_member_id string The member unique Id.
web_sessions Array.<TeamActiveWebSession> <optional>
 List of web sessions made by this team member.
desktop_clients Array.<TeamDesktopClientSession> <optional>
 List of desktop clients by this team member.
mobile_clients Array.<TeamMobileClientSession> <optional>
 List of mobile clients by this team member.

TeamMemberLinkedApps

Information on linked applications of a team member.
Type:
  • Object
Properties:
Name Type Description
team_member_id string The member unique Id.
linked_api_apps Array.<TeamApiApp> List of third party applications linked by this team member.

TeamMemberProfile

Basic member profile.
Type:
  • Object
Properties:
Name Type Argument Description
team_member_id string ID of user as a member of a team.
email string Email address of user.
email_verified boolean Is true if the user's email is verified to be owned by the user.
status TeamTeamMemberStatus The user's status as a member of a specific team.
name UsersName Representations for a person's name.
membership_type TeamTeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
external_id string <optional>
 External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id.
account_id string <optional>
 A user's account identifier.
secondary_emails Array.<SecondaryEmailsSecondaryEmail> <optional>
 Secondary emails of a user.
invited_on Timestamp <optional>
 The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited).
joined_on Timestamp <optional>
 The date and time the user joined as a member of a specific team.
suspended_on Timestamp <optional>
 The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended).
persistent_id string <optional>
 Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.
is_directory_restricted boolean <optional>
 Whether the user is a directory restricted user.
profile_photo_url string <optional>
 URL for the photo representing the user, if one is set.

TeamMembersAddArg

Type:
  • Object
Properties:
Name Type Description
new_members Array.<TeamMemberAddArg> Details of new members to be added to the team.
force_async boolean Whether to force the add to happen asynchronously.

TeamMembersAddArgBase

Type:
  • Object
Properties:
Name Type Description
force_async boolean Whether to force the add to happen asynchronously.

TeamMembersAddJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete Array.<TeamMemberAddResult> <optional>
 Available if .tag is complete. The asynchronous job has finished. For each member that was specified in the parameter :type:`MembersAddArg` that was provided to :route:`members/add`, a corresponding item is returned in this list.
failed string <optional>
 Available if .tag is failed. The asynchronous job returned an error. The string contains an error message.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

TeamMembersAddJobStatusV2Result

Type:
  • Object
Properties:
Name Type Argument Description
complete Array.<TeamMemberAddV2Result> <optional>
 Available if .tag is complete. The asynchronous job has finished. For each member that was specified in the parameter :type:`MembersAddArg` that was provided to :route:`members/add:2`, a corresponding item is returned in this list.
failed string <optional>
 Available if .tag is failed. The asynchronous job returned an error. The string contains an error message.
.tag 'in_progress' | 'complete' | 'failed' | 'other' Tag identifying the union variant.

TeamMembersAddLaunch

Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
complete Array.<TeamMemberAddResult> <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' Tag identifying the union variant.

TeamMembersAddLaunchV2Result

Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
complete Array.<TeamMemberAddV2Result> <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' | 'other' Tag identifying the union variant.

TeamMembersAddV2Arg

Type:
  • Object
Properties:
Name Type Description
new_members Array.<TeamMemberAddV2Arg> Details of new members to be added to the team.
force_async boolean Whether to force the add to happen asynchronously.

TeamMembersDataTransferArg

Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg Identity of user to remove/suspend/have their files moved.
transfer_dest_id TeamUserSelectorArg Files from the deleted member account will be transferred to this user.
transfer_admin_id TeamUserSelectorArg Errors during the transfer process will be sent via email to this user.

TeamMembersDeactivateArg

Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg Identity of user to remove/suspend/have their files moved.
wipe_data boolean If provided, controls if the user's data will be deleted on their linked devices.

TeamMembersDeactivateBaseArg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg Identity of user to remove/suspend/have their files moved.

TeamMembersDeactivateError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_not_in_team' | 'other' Tag identifying the union variant.

TeamMembersDeleteProfilePhotoArg

Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg Identity of the user whose profile photo will be deleted.

TeamMembersDeleteProfilePhotoError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_not_in_team' | 'set_profile_disallowed' | 'other' Tag identifying the union variant.

TeamMemberSelectorError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_not_in_team' Tag identifying the union variant.

TeamMembersGetAvailableTeamMemberRolesResult

Available TeamMemberRole for the connected team. To be used with members/set_admin_permissions:2.
Type:
  • Object
Properties:
Name Type Description
roles Array.<TeamTeamMemberRole> Available roles.

TeamMembersGetInfoArgs

Type:
  • Object
Properties:
Name Type Description
members Array.<TeamUserSelectorArg> List of team members.

TeamMembersGetInfoError

Type:
  • Object
Properties:
Name Type Description
.tag 'other' Tag identifying the union variant.

TeamMembersGetInfoItem

Describes a result obtained for a single user whose id was specified in the parameter of members/get_info.
Type:
  • Object
Properties:
Name Type Argument Description
id_not_found string <optional>
 Available if .tag is id_not_found. An ID that was provided as a parameter to :route:`members/get_info` or :route:`members/get_info:2`, 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.
member_info TeamTeamMemberInfo <optional>
 Available if .tag is member_info. Info about a team member.
.tag 'id_not_found' | 'member_info' Tag identifying the union variant.

TeamMembersGetInfoItemBase

Type:
  • Object
Properties:
Name Type Argument Description
id_not_found string <optional>
 Available if .tag is id_not_found. An ID that was provided as a parameter to :route:`members/get_info` or :route:`members/get_info:2`, 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.
.tag 'id_not_found' Tag identifying the union variant.

TeamMembersGetInfoItemV2

Describes a result obtained for a single user whose id was specified in the parameter of members/get_info:2.
Type:
  • Object
Properties:
Name Type Argument Description
id_not_found string <optional>
 Available if .tag is id_not_found. An ID that was provided as a parameter to :route:`members/get_info` or :route:`members/get_info:2`, 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.
member_info TeamTeamMemberInfoV2 <optional>
 Available if .tag is member_info. Info about a team member.
.tag 'id_not_found' | 'member_info' | 'other' Tag identifying the union variant.

TeamMembersGetInfoV2Arg

Type:
  • Object
Properties:
Name Type Description
members Array.<TeamUserSelectorArg> List of team members.

TeamMembersGetInfoV2Result

Type:
  • Object
Properties:
Name Type Description
members_info Array.<TeamMembersGetInfoItemV2> List of team members info.

TeamMembersInfo

Type:
  • Object
Properties:
Name Type Description
team_member_ids Array.<Object> Team member IDs of the users under this hold.
permanently_deleted_users number The number of permanently deleted users that were under this hold.

TeamMembersListArg

Type:
  • Object
Properties:
Name Type Description
limit number Number of results to return per call.
include_removed boolean Whether to return removed members.

TeamMembersListContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string Indicates from what point to get the next set of members.

TeamMembersListContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_cursor' | 'other' Tag identifying the union variant.

TeamMembersListError

Type:
  • Object
Properties:
Name Type Description
.tag 'other' Tag identifying the union variant.

TeamMembersListResult

Type:
  • Object
Properties:
Name Type Description
members Array.<TeamTeamMemberInfo> List of team members.
cursor string Pass the cursor into members/list/continue to obtain the additional members.
has_more boolean Is true if there are additional team members that have not been returned yet. An additional call to members/list/continue can retrieve them.

TeamMembersListV2Result

Type:
  • Object
Properties:
Name Type Description
members Array.<TeamTeamMemberInfoV2> List of team members.
cursor string Pass the cursor into members/list/continue:2 to obtain the additional members.
has_more boolean Is true if there are additional team members that have not been returned yet. An additional call to members/list/continue:2 can retrieve them.

TeamMembersRecoverArg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg Identity of user to recover.

TeamMembersRecoverError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_unrecoverable' | 'user_not_in_team' | 'team_license_limit' | 'other' Tag identifying the union variant.

TeamMembersRemoveArg

Type:
  • Object
Properties:
Name Type Argument Description
user TeamUserSelectorArg Identity of user to remove/suspend/have their files moved.
wipe_data boolean If provided, controls if the user's data will be deleted on their linked devices.
transfer_dest_id TeamUserSelectorArg <optional>
 If provided, files from the deleted member account will be transferred to this user.
transfer_admin_id TeamUserSelectorArg <optional>
 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.
keep_account boolean 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.
retain_team_shares boolean 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.

TeamMembersRemoveError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_not_in_team' | 'other' | 'removed_and_transfer_dest_should_differ' | 'removed_and_transfer_admin_should_differ' | 'transfer_dest_user_not_found' | 'transfer_dest_user_not_in_team' | 'transfer_admin_user_not_in_team' | 'transfer_admin_user_not_found' | 'unspecified_transfer_admin_id' | 'transfer_admin_is_not_admin' | 'recipient_not_verified' | 'remove_last_admin' | 'cannot_keep_account_and_transfer' | 'cannot_keep_account_and_delete_data' | 'email_address_too_long_to_be_disabled' | 'cannot_keep_invited_user_account' | 'cannot_retain_shares_when_data_wiped' | 'cannot_retain_shares_when_no_account_kept' | 'cannot_retain_shares_when_team_external_sharing_off' | 'cannot_keep_account' | 'cannot_keep_account_under_legal_hold' | 'cannot_keep_account_required_to_sign_tos' Tag identifying the union variant.

TeamMembersSendWelcomeError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_not_in_team' | 'other' Tag identifying the union variant.

TeamMembersSetPermissions2Arg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Type:
  • Object
Properties:
Name Type Argument Description
user TeamUserSelectorArg Identity of user whose role will be set.
new_roles Array.<Object> <optional>
 The new roles for the member. Send empty list to make user member only. For now, only up to one role is allowed.

TeamMembersSetPermissions2Error

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'last_admin' | 'user_not_in_team' | 'cannot_set_permissions' | 'role_not_found' | 'other' Tag identifying the union variant.

TeamMembersSetPermissions2Result

Type:
  • Object
Properties:
Name Type Argument Description
team_member_id string The member ID of the user to which the change was applied.
roles Array.<TeamTeamMemberRole> <optional>
 The roles after the change. Empty in case the user become a non-admin.

TeamMembersSetPermissionsArg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg Identity of user whose role will be set.
new_role TeamAdminTier The new role of the member.

TeamMembersSetPermissionsError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'last_admin' | 'user_not_in_team' | 'cannot_set_permissions' | 'team_license_limit' | 'other' Tag identifying the union variant.

TeamMembersSetPermissionsResult

Type:
  • Object
Properties:
Name Type Description
team_member_id string The member ID of the user to which the change was applied.
role TeamAdminTier The role after the change.

TeamMembersSetProfileArg

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.
Type:
  • Object
Properties:
Name Type Argument Description
user TeamUserSelectorArg Identity of user whose profile will be set.
new_email string <optional>
 New email for member.
new_external_id string <optional>
 New external ID for member.
new_given_name string <optional>
 New given name for member.
new_surname string <optional>
 New surname for member.
new_persistent_id string <optional>
 New persistent ID. This field only available to teams using persistent ID SAML configuration.
new_is_directory_restricted boolean <optional>
 New value for whether the user is a directory restricted user.

TeamMembersSetProfileError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_not_in_team' | 'external_id_and_new_external_id_unsafe' | 'no_new_data_specified' | 'email_reserved_for_other_user' | 'external_id_used_by_other_user' | 'set_profile_disallowed' | 'param_cannot_be_empty' | 'persistent_id_disabled' | 'persistent_id_used_by_other_user' | 'directory_restricted_off' | 'other' Tag identifying the union variant.

TeamMembersSetProfilePhotoArg

Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg Identity of the user whose profile photo will be set.
photo AccountPhotoSourceArg Image to set as the member's new profile photo.

TeamMembersSetProfilePhotoError

Type:
  • Object
Properties:
Name Type Argument Description
photo_error AccountSetProfilePhotoError <optional>
 Available if .tag is photo_error.
.tag 'user_not_found' | 'user_not_in_team' | 'set_profile_disallowed' | 'photo_error' | 'other' Tag identifying the union variant.

TeamMembersSuspendError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_not_in_team' | 'other' | 'suspend_inactive_user' | 'suspend_last_admin' | 'team_license_limit' Tag identifying the union variant.

TeamMembersTransferFilesError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_not_in_team' | 'other' | 'removed_and_transfer_dest_should_differ' | 'removed_and_transfer_admin_should_differ' | 'transfer_dest_user_not_found' | 'transfer_dest_user_not_in_team' | 'transfer_admin_user_not_in_team' | 'transfer_admin_user_not_found' | 'unspecified_transfer_admin_id' | 'transfer_admin_is_not_admin' | 'recipient_not_verified' Tag identifying the union variant.

TeamMembersTransferFormerMembersFilesError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_not_in_team' | 'other' | 'removed_and_transfer_dest_should_differ' | 'removed_and_transfer_admin_should_differ' | 'transfer_dest_user_not_found' | 'transfer_dest_user_not_in_team' | 'transfer_admin_user_not_in_team' | 'transfer_admin_user_not_found' | 'unspecified_transfer_admin_id' | 'transfer_admin_is_not_admin' | 'recipient_not_verified' | 'user_data_is_being_transferred' | 'user_not_removed' | 'user_data_cannot_be_transferred' | 'user_data_already_transferred' Tag identifying the union variant.

TeamMembersUnsuspendArg

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg Identity of user to unsuspend.

TeamMembersUnsuspendError

Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' | 'user_not_in_team' | 'other' | 'unsuspend_non_suspended_member' | 'team_license_limit' Tag identifying the union variant.

TeamMobileClientPlatform

Type:
  • Object
Properties:
Name Type Description
.tag 'iphone' | 'ipad' | 'android' | 'windows_phone' | 'blackberry' | 'other' Tag identifying the union variant.

TeamMobileClientSession

Information about linked Dropbox mobile client sessions.
Type:
  • Object
Properties:
Name Type Argument Description
session_id string The session id.
device_name string The device name.
client_type TeamMobileClientPlatform The mobile application type.
ip_address string <optional>
 The IP address of the last activity from this session.
country string <optional>
 The country from which the last activity from this session was made.
created Timestamp <optional>
 The time this session was created.
updated Timestamp <optional>
 The time of the last activity from this session.
client_version string <optional>
 The dropbox client version.
os_version string <optional>
 The hosting OS version.
last_carrier string <optional>
 last carrier used by the device.

TeamNamespaceMetadata

Properties of a namespace.
Type:
  • Object
Properties:
Name Type Argument Description
name string The name of this namespace.
namespace_id string The ID of this namespace.
namespace_type TeamNamespaceType The type of this namespace.
team_member_id string <optional>
 If this is a team member or app folder, the ID of the owning team member. Otherwise, this field is not present.

TeamNamespaceType

Type:
  • Object
Properties:
Name Type Description
.tag 'app_folder' | 'shared_folder' | 'team_folder' | 'team_member_folder' | 'other' Tag identifying the union variant.

TeamPoliciesCameraUploadsPolicyState

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamPoliciesComputerBackupPolicyState

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'default' | 'other' Tag identifying the union variant.

TeamPoliciesEmmState

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'optional' | 'required' | 'other' Tag identifying the union variant.

TeamPoliciesExternalDriveBackupPolicyState

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'default' | 'other' Tag identifying the union variant.

TeamPoliciesFileLockingPolicyState

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamPoliciesFileProviderMigrationPolicyState

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'default' | 'other' Tag identifying the union variant.

TeamPoliciesGroupCreation

Type:
  • Object
Properties:
Name Type Description
.tag 'admins_and_members' | 'admins_only' Tag identifying the union variant.

TeamPoliciesOfficeAddInPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamPoliciesPaperDefaultFolderPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'everyone_in_team' | 'invite_only' | 'other' Tag identifying the union variant.

TeamPoliciesPaperDeploymentPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'full' | 'partial' | 'other' Tag identifying the union variant.

TeamPoliciesPaperDesktopPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamPoliciesPaperEnabledPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'unspecified' | 'other' Tag identifying the union variant.

TeamPoliciesPasswordControlMode

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamPoliciesPasswordStrengthPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'minimal_requirements' | 'moderate_password' | 'strong_password' | 'other' Tag identifying the union variant.

TeamPoliciesRolloutMethod

Type:
  • Object
Properties:
Name Type Description
.tag 'unlink_all' | 'unlink_most_inactive' | 'add_member_to_exceptions' Tag identifying the union variant.

TeamPoliciesSharedFolderJoinPolicy

Policy governing which shared folders a team member can join.
Type:
  • Object
Properties:
Name Type Description
.tag 'from_team_only' | 'from_anyone' | 'other' Tag identifying the union variant.

TeamPoliciesSharedFolderMemberPolicy

Policy governing who can be a member of a folder shared by a team member.
Type:
  • Object
Properties:
Name Type Description
.tag 'team' | 'anyone' | 'other' Tag identifying the union variant.

TeamPoliciesSharedLinkCreatePolicy

Policy governing the visibility of shared links. This policy can apply to newly created shared links, or all shared links.
Type:
  • Object
Properties:
Name Type Description
.tag 'default_public' | 'default_team_only' | 'team_only' | 'default_no_one' | 'other' Tag identifying the union variant.

TeamPoliciesShowcaseDownloadPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamPoliciesShowcaseEnabledPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamPoliciesShowcaseExternalSharingPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamPoliciesSmarterSmartSyncPolicyState

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamPoliciesSmartSyncPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'local' | 'on_demand' | 'other' Tag identifying the union variant.

TeamPoliciesSsoPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'optional' | 'required' | 'other' Tag identifying the union variant.

TeamPoliciesSuggestMembersPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'disabled' | 'enabled' | 'other' Tag identifying the union variant.

TeamPoliciesTeamMemberPolicies

Policies governing team members.
Type:
  • Object
Properties:
Name Type Description
sharing TeamPoliciesTeamSharingPolicies Policies governing sharing.
emm_state TeamPoliciesEmmState This describes the Enterprise Mobility Management (EMM) state for this team. This information can be used to understand if an organization is integrating with a third-party EMM vendor to further manage and apply restrictions upon the team's Dropbox usage on mobile devices. This is a new feature and in the future we'll be adding more new fields and additional documentation.
office_addin TeamPoliciesOfficeAddInPolicy The admin policy around the Dropbox Office Add-In for this team.
suggest_members_policy TeamPoliciesSuggestMembersPolicy The team policy on if teammembers are allowed to suggest users for admins to invite to the team.

TeamPoliciesTeamSharingPolicies

Policies governing sharing within and outside of the team.
Type:
  • Object
Properties:
Name Type Description
shared_folder_member_policy TeamPoliciesSharedFolderMemberPolicy - Who can join folders shared by team members.
shared_folder_join_policy TeamPoliciesSharedFolderJoinPolicy Which shared folders team members can join.
shared_link_create_policy TeamPoliciesSharedLinkCreatePolicy Who can view shared links owned by team members.
group_creation_policy TeamPoliciesGroupCreation Who can create groups.

TeamPoliciesTwoStepVerificationPolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'require_tfa_enable' | 'require_tfa_disable' | 'other' Tag identifying the union variant.

TeamPoliciesTwoStepVerificationState

Type:
  • Object
Properties:
Name Type Description
.tag 'required' | 'optional' | 'disabled' | 'other' Tag identifying the union variant.

TeamRemoveCustomQuotaResult

User result for setting member custom quota.
Type:
  • Object
Properties:
Name Type Argument Description
success TeamUserSelectorArg <optional>
 Available if .tag is success. Successfully removed user.
invalid_user TeamUserSelectorArg <optional>
 Available if .tag is invalid_user. Invalid user (not in team).
.tag 'success' | 'invalid_user' | 'other' Tag identifying the union variant.

TeamRemovedStatus

Type:
  • Object
Properties:
Name Type Description
is_recoverable boolean True if the removed team member is recoverable.
is_disconnected boolean True if the team member's account was converted to individual account.

TeamResendSecondaryEmailResult

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.
Type:
  • Object
Properties:
Name Type Argument Description
success string <optional>
 Available if .tag is success. A verification email was successfully sent to the secondary email address.
not_pending string <optional>
 Available if .tag is not_pending. This secondary email address is not pending for the user.
rate_limited string <optional>
 Available if .tag is rate_limited. Too many emails are being sent to this email address. Please try again later.
.tag 'success' | 'not_pending' | 'rate_limited' | 'other' Tag identifying the union variant.

TeamResendVerificationEmailArg

Type:
  • Object
Properties:
Name Type Description
emails_to_resend Array.<TeamUserSecondaryEmailsArg> List of users and secondary emails to resend verification emails to.

TeamResendVerificationEmailResult

List of users and resend results.
Type:
  • Object
Properties:
Name Type Description
results Array.<TeamUserResendResult>

TeamRevokeDesktopClientArg

Type:
  • Object
Properties:
Name Type Description
session_id string The session id.
team_member_id string The unique id of the member owning the device.
delete_on_unlink boolean Whether to delete all files of the account (this is possible only if supported by the desktop client and will be made the next time the client access the account).

TeamRevokeDeviceSessionArg

Type:
  • Object
Properties:
Name Type Argument Description
web_session TeamDeviceSessionArg <optional>
 Available if .tag is web_session. End an active session.
desktop_client TeamRevokeDesktopClientArg <optional>
 Available if .tag is desktop_client. Unlink a linked desktop device.
mobile_client TeamDeviceSessionArg <optional>
 Available if .tag is mobile_client. Unlink a linked mobile device.
.tag 'web_session' | 'desktop_client' | 'mobile_client' Tag identifying the union variant.

TeamRevokeDeviceSessionBatchArg

Type:
  • Object
Properties:
Name Type Description
revoke_devices Array.<TeamRevokeDeviceSessionArg>

TeamRevokeDeviceSessionBatchError

Type:
  • Object
Properties:
Name Type Description
.tag 'other' Tag identifying the union variant.

TeamRevokeDeviceSessionBatchResult

Type:
  • Object
Properties:
Name Type Description
revoke_devices_status Array.<TeamRevokeDeviceSessionStatus>

TeamRevokeDeviceSessionError

Type:
  • Object
Properties:
Name Type Description
.tag 'device_session_not_found' | 'member_not_found' | 'other' Tag identifying the union variant.

TeamRevokeDeviceSessionStatus

Type:
  • Object
Properties:
Name Type Argument Description
success boolean Result of the revoking request.
error_type TeamRevokeDeviceSessionError <optional>
 The error cause in case of a failure.

TeamRevokeLinkedApiAppArg

Type:
  • Object
Properties:
Name Type Description
app_id string The application's unique id.
team_member_id string The unique id of the member owning the device.
keep_app_folder boolean This flag is not longer supported, the application dedicated folder (in case the application uses one) will be kept.

TeamRevokeLinkedApiAppBatchArg

Type:
  • Object
Properties:
Name Type Description
revoke_linked_app Array.<TeamRevokeLinkedApiAppArg>

TeamRevokeLinkedAppBatchError

Error returned by linked_apps/revoke_linked_app_batch.
Type:
  • Object
Properties:
Name Type Description
.tag 'other' Tag identifying the union variant.

TeamRevokeLinkedAppBatchResult

Type:
  • Object
Properties:
Name Type Description
revoke_linked_app_status Array.<TeamRevokeLinkedAppStatus>

TeamRevokeLinkedAppError

Error returned by linked_apps/revoke_linked_app.
Type:
  • Object
Properties:
Name Type Description
.tag 'app_not_found' | 'member_not_found' | 'app_folder_removal_not_supported' | 'other' Tag identifying the union variant.

TeamRevokeLinkedAppStatus

Type:
  • Object
Properties:
Name Type Argument Description
success boolean Result of the revoking request.
error_type TeamRevokeLinkedAppError <optional>
 The error cause in case of a failure.

TeamSetCustomQuotaArg

Type:
  • Object
Properties:
Name Type Description
users_and_quotas Array.<TeamUserCustomQuotaArg> List of users and their custom quotas.

TeamSetCustomQuotaError

Error returned when setting member custom quota.
Type:
  • Object
Properties:
Name Type Description
.tag 'too_many_users' | 'other' | 'some_users_are_excluded' Tag identifying the union variant.

TeamSharingAllowlistAddArgs

Structure representing Approve List entries. Domain and emails are supported. At least one entry of any supported type is required.
Type:
  • Object
Properties:
Name Type Argument Description
domains Array.<string> <optional>
 List of domains represented by valid string representation (RFC-1034/5).
emails Array.<string> <optional>
 List of emails represented by valid string representation (RFC-5322/822).

TeamSharingAllowlistAddError

Type:
  • Object
Properties:
Name Type Argument Description
malformed_entry string <optional>
 Available if .tag is malformed_entry. One of provided values is not valid.
entries_already_exist string <optional>
 Available if .tag is entries_already_exist. Entries already exists.
.tag 'malformed_entry' | 'no_entries_provided' | 'too_many_entries_provided' | 'team_limit_reached' | 'unknown_error' | 'entries_already_exist' | 'other' Tag identifying the union variant.

TeamSharingAllowlistAddResponse

This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone.
Type:
  • Object

TeamSharingAllowlistListArg

Type:
  • Object
Properties:
Name Type Description
limit number The number of entries to fetch at one time.

TeamSharingAllowlistListContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned from a previous call to sharing_allowlist/list or sharing_allowlist/list/continue.

TeamSharingAllowlistListContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_cursor' | 'other' Tag identifying the union variant.

TeamSharingAllowlistListError

This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone.
Type:
  • Object

TeamSharingAllowlistListResponse

Type:
  • Object
Properties:
Name Type Description
domains Array.<string> List of domains represented by valid string representation (RFC-1034/5).
emails Array.<string> List of emails represented by valid string representation (RFC-5322/822).
cursor string If this is nonempty, there are more entries that can be fetched with sharing_allowlist/list/continue.
has_more boolean if true indicates that more entries can be fetched with sharing_allowlist/list/continue.

TeamSharingAllowlistRemoveArgs

Type:
  • Object
Properties:
Name Type Argument Description
domains Array.<string> <optional>
 List of domains represented by valid string representation (RFC-1034/5).
emails Array.<string> <optional>
 List of emails represented by valid string representation (RFC-5322/822).

TeamSharingAllowlistRemoveError

Type:
  • Object
Properties:
Name Type Argument Description
malformed_entry string <optional>
 Available if .tag is malformed_entry. One of provided values is not valid.
entries_do_not_exist string <optional>
 Available if .tag is entries_do_not_exist. One or more provided values do not exist.
.tag 'malformed_entry' | 'entries_do_not_exist' | 'no_entries_provided' | 'too_many_entries_provided' | 'unknown_error' | 'other' Tag identifying the union variant.

TeamSharingAllowlistRemoveResponse

This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone.
Type:
  • Object

TeamStorageBucket

Describes the number of users in a specific storage bucket.
Type:
  • Object
Properties:
Name Type Description
bucket string The name of the storage bucket. For example, '1G' is a bucket of users with storage size up to 1 Giga.
users number The number of people whose storage is in the range of this storage bucket.

TeamTeamFolderAccessError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_team_folder_id' | 'no_access' | 'other' Tag identifying the union variant.

TeamTeamFolderActivateError

Type:
  • Object
Properties:
Name Type Argument Description
access_error TeamTeamFolderAccessError <optional>
 Available if .tag is access_error.
status_error TeamTeamFolderInvalidStatusError <optional>
 Available if .tag is status_error.
team_shared_dropbox_error TeamTeamFolderTeamSharedDropboxError <optional>
 - Available if .tag is team_shared_dropbox_error.
.tag 'access_error' | 'status_error' | 'team_shared_dropbox_error' | 'other' Tag identifying the union variant.

TeamTeamFolderArchiveArg

Type:
  • Object
Properties:
Name Type Description
team_folder_id string The ID of the team folder.
force_async_off boolean Whether to force the archive to happen synchronously.

TeamTeamFolderArchiveError

Type:
  • Object
Properties:
Name Type Argument Description
access_error TeamTeamFolderAccessError <optional>
 Available if .tag is access_error.
status_error TeamTeamFolderInvalidStatusError <optional>
 Available if .tag is status_error.
team_shared_dropbox_error TeamTeamFolderTeamSharedDropboxError <optional>
 - Available if .tag is team_shared_dropbox_error.
.tag 'access_error' | 'status_error' | 'team_shared_dropbox_error' | 'other' Tag identifying the union variant.

TeamTeamFolderArchiveJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete TeamTeamFolderMetadata <optional>
 Available if .tag is complete. The archive job has finished. The value is the metadata for the resulting team folder.
failed TeamTeamFolderArchiveError <optional>
 Available if .tag is failed. Error occurred while performing an asynchronous job from :route:`team_folder/archive`.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

TeamTeamFolderArchiveLaunch

Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. 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.
complete TeamTeamFolderMetadata <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' Tag identifying the union variant.

TeamTeamFolderCreateArg

Type:
  • Object
Properties:
Name Type Argument Description
name string Name for the new team folder.
sync_setting FilesSyncSettingArg <optional>
 The sync setting to apply to this team folder. Only permitted if the team has team selective sync enabled.

TeamTeamFolderCreateError

Type:
  • Object
Properties:
Name Type Argument Description
sync_settings_error FilesSyncSettingsError <optional>
 Available if .tag is sync_settings_error. An error occurred setting the sync settings.
.tag 'invalid_folder_name' | 'folder_name_already_used' | 'folder_name_reserved' | 'sync_settings_error' | 'other' Tag identifying the union variant.

TeamTeamFolderGetInfoItem

Type:
  • Object
Properties:
Name Type Argument Description
id_not_found string <optional>
 Available if .tag is id_not_found. An ID that was provided as a parameter to :route:`team_folder/get_info` did not match any of the team's team folders.
team_folder_metadata TeamTeamFolderMetadata <optional>
 Available if .tag is team_folder_metadata. Properties of a team folder.
.tag 'id_not_found' | 'team_folder_metadata' Tag identifying the union variant.

TeamTeamFolderIdArg

Type:
  • Object
Properties:
Name Type Description
team_folder_id string The ID of the team folder.

TeamTeamFolderIdListArg

Type:
  • Object
Properties:
Name Type Description
team_folder_ids Array.<Object> The list of team folder IDs.

TeamTeamFolderInvalidStatusError

Type:
  • Object
Properties:
Name Type Description
.tag 'active' | 'archived' | 'archive_in_progress' | 'other' Tag identifying the union variant.

TeamTeamFolderListArg

Type:
  • Object
Properties:
Name Type Description
limit number The maximum number of results to return per request.

TeamTeamFolderListContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string Indicates from what point to get the next set of team folders.

TeamTeamFolderListContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_cursor' | 'other' Tag identifying the union variant.

TeamTeamFolderListError

Type:
  • Object
Properties:
Name Type Description
access_error TeamTeamFolderAccessError

TeamTeamFolderListResult

Result for team_folder/list and team_folder/list/continue.
Type:
  • Object
Properties:
Name Type Description
team_folders Array.<TeamTeamFolderMetadata> List of all team folders in the authenticated team.
cursor string Pass the cursor into team_folder/list/continue to obtain additional team folders.
has_more boolean Is true if there are additional team folders that have not been returned yet. An additional call to team_folder/list/continue can retrieve them.

TeamTeamFolderMetadata

Properties of a team folder.
Type:
  • Object
Properties:
Name Type Description
team_folder_id string The ID of the team folder.
name string The name of the team folder.
status TeamTeamFolderStatus The status of the team folder.
is_team_shared_dropbox boolean True if this team folder is a shared team root.
sync_setting FilesSyncSetting The sync setting applied to this team folder.
content_sync_settings Array.<FilesContentSyncSetting> Sync settings applied to contents of this team folder.

TeamTeamFolderPermanentlyDeleteError

Type:
  • Object
Properties:
Name Type Argument Description
access_error TeamTeamFolderAccessError <optional>
 Available if .tag is access_error.
status_error TeamTeamFolderInvalidStatusError <optional>
 Available if .tag is status_error.
team_shared_dropbox_error TeamTeamFolderTeamSharedDropboxError <optional>
 - Available if .tag is team_shared_dropbox_error.
.tag 'access_error' | 'status_error' | 'team_shared_dropbox_error' | 'other' Tag identifying the union variant.

TeamTeamFolderRenameArg

Type:
  • Object
Properties:
Name Type Description
team_folder_id string The ID of the team folder.
name string New team folder name.

TeamTeamFolderRenameError

Type:
  • Object
Properties:
Name Type Argument Description
access_error TeamTeamFolderAccessError <optional>
 Available if .tag is access_error.
status_error TeamTeamFolderInvalidStatusError <optional>
 Available if .tag is status_error.
team_shared_dropbox_error TeamTeamFolderTeamSharedDropboxError <optional>
 - Available if .tag is team_shared_dropbox_error.
.tag 'access_error' | 'status_error' | 'team_shared_dropbox_error' | 'other' | 'invalid_folder_name' | 'folder_name_already_used' | 'folder_name_reserved' Tag identifying the union variant.

TeamTeamFolderStatus

Type:
  • Object
Properties:
Name Type Description
.tag 'active' | 'archived' | 'archive_in_progress' | 'other' Tag identifying the union variant.

TeamTeamFolderTeamSharedDropboxError

Type:
  • Object
Properties:
Name Type Description
.tag 'disallowed' | 'other' Tag identifying the union variant.

TeamTeamFolderUpdateSyncSettingsArg

Type:
  • Object
Properties:
Name Type Argument Description
team_folder_id string The ID of the team folder.
sync_setting FilesSyncSettingArg <optional>
 Sync setting to apply to the team folder itself. Only meaningful if the team folder is not a shared team root.
content_sync_settings Array.<FilesContentSyncSettingArg> <optional>
 Sync settings to apply to contents of this team folder.

TeamTeamFolderUpdateSyncSettingsError

Type:
  • Object
Properties:
Name Type Argument Description
access_error TeamTeamFolderAccessError <optional>
 Available if .tag is access_error.
status_error TeamTeamFolderInvalidStatusError <optional>
 Available if .tag is status_error.
team_shared_dropbox_error TeamTeamFolderTeamSharedDropboxError <optional>
 - Available if .tag is team_shared_dropbox_error.
sync_settings_error FilesSyncSettingsError <optional>
 Available if .tag is sync_settings_error. An error occurred setting the sync settings.
.tag 'access_error' | 'status_error' | 'team_shared_dropbox_error' | 'other' | 'sync_settings_error' Tag identifying the union variant.

TeamTeamGetInfoResult

Type:
  • Object
Properties:
Name Type Description
name string The name of the team.
team_id string The ID of the team.
num_licensed_users number The number of licenses available to the team.
num_provisioned_users number The number of accounts that have been invited or are already active members of the team.
num_used_licenses number The number of licenses used on the team.
policies TeamPoliciesTeamMemberPolicies

TeamTeamMemberInfo

Information about a team member.
Type:
  • Object
Properties:
Name Type Description
profile TeamTeamMemberProfile Profile of a user as a member of a team.
role TeamAdminTier The user's role in the team.

TeamTeamMemberInfoV2

Information about a team member.
Type:
  • Object
Properties:
Name Type Argument Description
profile TeamTeamMemberProfile Profile of a user as a member of a team.
roles Array.<TeamTeamMemberRole> <optional>
 The user's roles in the team.

TeamTeamMemberInfoV2Result

Information about a team member, after the change, like at members/set_profile:2.
Type:
  • Object
Properties:
Name Type Description
member_info TeamTeamMemberInfoV2 Member info, after the change.

TeamTeamMemberProfile

Profile of a user as a member of a team.
Type:
  • Object
Properties:
Name Type Argument Description
team_member_id string ID of user as a member of a team.
email string Email address of user.
email_verified boolean Is true if the user's email is verified to be owned by the user.
status TeamTeamMemberStatus The user's status as a member of a specific team.
name UsersName Representations for a person's name.
membership_type TeamTeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
groups Array.<Object> List of group IDs of groups that the user belongs to.
member_folder_id string The namespace id of the user's root folder.
external_id string <optional>
 External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id.
account_id string <optional>
 A user's account identifier.
secondary_emails Array.<SecondaryEmailsSecondaryEmail> <optional>
 Secondary emails of a user.
invited_on Timestamp <optional>
 The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited).
joined_on Timestamp <optional>
 The date and time the user joined as a member of a specific team.
suspended_on Timestamp <optional>
 The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended).
persistent_id string <optional>
 Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.
is_directory_restricted boolean <optional>
 Whether the user is a directory restricted user.
profile_photo_url string <optional>
 URL for the photo representing the user, if one is set.

TeamTeamMemberRole

A role which can be attached to a team member. This replaces AdminTier; each AdminTier corresponds to a new TeamMemberRole with a matching name.
Type:
  • Object
Properties:
Name Type Description
role_id string A string containing encoded role ID. For roles defined by Dropbox, this is the same across all teams.
name string The role display name.
description string Role description. Describes which permissions come with this role.

TeamTeamMembershipType

Type:
  • Object
Properties:
Name Type Description
.tag 'full' | 'limited' Tag identifying the union variant.

TeamTeamMemberStatus

The user's status as a member of a specific team.
Type:
  • Object
Properties:
Name Type Argument Description
removed TeamRemovedStatus <optional>
 Available if .tag is removed. User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
.tag 'active' | 'invited' | 'suspended' | 'removed' Tag identifying the union variant.

TeamTeamNamespacesListArg

Type:
  • Object
Properties:
Name Type Description
limit number Specifying a value here has no effect.

TeamTeamNamespacesListContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string Indicates from what point to get the next set of team-accessible namespaces.

TeamTeamNamespacesListContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_arg' | 'other' | 'invalid_cursor' Tag identifying the union variant.

TeamTeamNamespacesListError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_arg' | 'other' Tag identifying the union variant.

TeamTeamNamespacesListResult

Result for namespaces/list.
Type:
  • Object
Properties:
Name Type Description
namespaces Array.<TeamNamespaceMetadata> List of all namespaces the team can access.
cursor string Pass the cursor into namespaces/list/continue to obtain additional namespaces. Note that duplicate namespaces may be returned.
has_more boolean Is true if there are additional namespaces that have not been returned yet.

TeamTeamReportFailureReason

Type:
  • Object
Properties:
Name Type Description
.tag 'temporary_error' | 'many_reports_at_once' | 'too_much_data' | 'other' Tag identifying the union variant.

TeamTokenGetAuthenticatedAdminError

Error returned by token/get_authenticated_admin.
Type:
  • Object
Properties:
Name Type Description
.tag 'mapping_not_found' | 'admin_not_active' | 'other' Tag identifying the union variant.

TeamTokenGetAuthenticatedAdminResult

Results for token/get_authenticated_admin.
Type:
  • Object
Properties:
Name Type Description
admin_profile TeamTeamMemberProfile The admin who authorized the token.

TeamUploadApiRateLimitValue

The value for Feature.upload_api_rate_limit.
Type:
  • Object
Properties:
Name Type Argument Description
limit number <optional>
 Available if .tag is limit. The number of upload API calls allowed per month.
.tag 'unlimited' | 'limit' | 'other' Tag identifying the union variant.

TeamUserAddResult

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.
Type:
  • Object
Properties:
Name Type Argument Description
success TeamUserSecondaryEmailsResult <optional>
 Available if .tag is success. Describes a user and the results for each attempt to add a secondary email.
invalid_user TeamUserSelectorArg <optional>
 Available if .tag is invalid_user. Specified user is not a valid target for adding secondary emails.
unverified TeamUserSelectorArg <optional>
 Available if .tag is unverified. Secondary emails can only be added to verified users.
placeholder_user TeamUserSelectorArg <optional>
 Available if .tag is placeholder_user. Secondary emails cannot be added to placeholder users.
.tag 'success' | 'invalid_user' | 'unverified' | 'placeholder_user' | 'other' Tag identifying the union variant.

TeamUserCustomQuotaArg

User and their required custom quota in GB (1 TB = 1024 GB).
Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg
quota_gb number

TeamUserCustomQuotaResult

User and their custom quota in GB (1 TB = 1024 GB). No quota returns if the user has no custom quota set.
Type:
  • Object
Properties:
Name Type Argument Description
user TeamUserSelectorArg
quota_gb number <optional>

TeamUserDeleteEmailsResult

Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg
results Array.<TeamDeleteSecondaryEmailResult>

TeamUserDeleteResult

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.
Type:
  • Object
Properties:
Name Type Argument Description
success TeamUserDeleteEmailsResult <optional>
 Available if .tag is success. Describes a user and the results for each attempt to delete a secondary email.
invalid_user TeamUserSelectorArg <optional>
 Available if .tag is invalid_user. Specified user is not a valid target for deleting secondary emails.
.tag 'success' | 'invalid_user' | 'other' Tag identifying the union variant.

TeamUserResendEmailsResult

Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg
results Array.<TeamResendSecondaryEmailResult>

TeamUserResendResult

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.
Type:
  • Object
Properties:
Name Type Argument Description
success TeamUserResendEmailsResult <optional>
 Available if .tag is success. Describes a user and the results for each attempt to resend verification emails.
invalid_user TeamUserSelectorArg <optional>
 Available if .tag is invalid_user. Specified user is not a valid target for resending verification emails.
.tag 'success' | 'invalid_user' | 'other' Tag identifying the union variant.

TeamUserSecondaryEmailsArg

User and a list of secondary emails.
Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg
secondary_emails Array.<Object>

TeamUserSecondaryEmailsResult

Type:
  • Object
Properties:
Name Type Description
user TeamUserSelectorArg
results Array.<TeamAddSecondaryEmailResult>

TeamUserSelectorArg

Argument for selecting a single user, either by team_member_id, external_id or email.
Type:
  • Object
Properties:
Name Type Argument Description
team_member_id string <optional>
 Available if .tag is team_member_id.
external_id string <optional>
 Available if .tag is external_id.
email string <optional>
 Available if .tag is email.
.tag 'team_member_id' | 'external_id' | 'email' Tag identifying the union variant.

TeamUserSelectorError

Error that can be returned whenever a struct derived from UserSelectorArg is used.
Type:
  • Object
Properties:
Name Type Description
.tag 'user_not_found' Tag identifying the union variant.

TeamUsersSelectorArg

Argument for selecting a list of users, either by team_member_ids, external_ids or emails.
Type:
  • Object
Properties:
Name Type Argument Description
team_member_ids Array.<Object> <optional>
 Available if .tag is team_member_ids. List of member IDs.
external_ids Array.<Object> <optional>
 Available if .tag is external_ids. List of external user IDs.
emails Array.<Object> <optional>
 Available if .tag is emails. List of email addresses.
.tag 'team_member_ids' | 'external_ids' | 'emails' Tag identifying the union variant.

Timestamp

Type:
  • string

UserMessage

User-friendly error message.
Type:
  • Object
Properties:
Name Type Description
text string The message.
locale string

UsersAccount

The amount of detail revealed about an account depends on the user being queried and the user making the query.
Type:
  • Object
Properties:
Name Type Argument Description
account_id string The user's unique Dropbox ID.
name UsersName Details of a user's name.
email string The user's email address. Do not rely on this without checking the email_verified field. Even then, it's possible that the user has since lost access to their email.
email_verified boolean Whether the user has verified their email address.
disabled boolean Whether the user has been disabled.
profile_photo_url string <optional>
 URL for the photo representing the user, if one is set.

UsersBasicAccount

Basic information about any account.
Type:
  • Object
Properties:
Name Type Argument Description
account_id string The user's unique Dropbox ID.
name UsersName Details of a user's name.
email string The user's email address. Do not rely on this without checking the email_verified field. Even then, it's possible that the user has since lost access to their email.
email_verified boolean Whether the user has verified their email address.
disabled boolean Whether the user has been disabled.
is_teammate boolean Whether this user is a teammate of the current user. If this account is the current user's account, then this will be true.
profile_photo_url string <optional>
 URL for the photo representing the user, if one is set.
team_member_id string <optional>
 The user's unique team member id. This field will only be present if the user is part of a team and is_teammate is true.

UsersCommonAccountType

What type of account this user has.
Type:
  • Object
Properties:
Name Type Description
.tag 'basic' | 'pro' | 'business' Tag identifying the union variant.

UsersFileLockingValue

The value for UserFeature.file_locking.
Type:
  • Object
Properties:
Name Type Argument Description
enabled boolean <optional>
 Available if .tag is enabled. When this value is True, the user can lock files in shared directories. When the value is False the user can unlock the files they have locked or request to unlock files locked by others.
.tag 'enabled' | 'other' Tag identifying the union variant.

UsersFullAccount

Detailed information about the current user's account.
Type:
  • Object
Properties:
Name Type Argument Description
account_id string The user's unique Dropbox ID.
name UsersName Details of a user's name.
email string The user's email address. Do not rely on this without checking the email_verified field. Even then, it's possible that the user has since lost access to their email.
email_verified boolean Whether the user has verified their email address.
disabled boolean Whether the user has been disabled.
locale string The language that the user specified. Locale tags will be IETF language tags http://en.wikipedia.org/wiki/IETF_language_tag.
referral_link string The user's referral link https://www.dropbox.com/referrals.
is_paired boolean Whether the user has a personal and work account. If the current account is personal, then team will always be null, but is_paired will indicate if a work account is linked.
account_type UsersCommonAccountType What type of account this user has.
root_info CommonTeamRootInfo | CommonUserRootInfo | CommonRootInfo - The root info for this account.
profile_photo_url string <optional>
 URL for the photo representing the user, if one is set.
country string <optional>
 The user's two-letter country code, if available. Country codes are based on ISO 3166-1 http://en.wikipedia.org/wiki/ISO_3166-1.
team UsersFullTeam <optional>
 If this account is a member of a team, information about that team.
team_member_id string <optional>
 This account's unique team member id. This field will only be present if team is present.

UsersFullTeam

Detailed information about a team.
Type:
  • Object
Properties:
Name Type Description
id string The team's unique ID.
name string The name of the team.
sharing_policies TeamPoliciesTeamSharingPolicies Team policies governing sharing.
office_addin_policy TeamPoliciesOfficeAddInPolicy Team policy governing the use of the Office Add-In.

UsersGetAccountArg

Type:
  • Object
Properties:
Name Type Description
account_id string A user's account identifier.

UsersGetAccountBatchArg

Type:
  • Object
Properties:
Name Type Description
account_ids Array.<Object> List of user account identifiers. Should not contain any duplicate account IDs.

UsersGetAccountBatchError

Type:
  • Object
Properties:
Name Type Argument Description
no_account string <optional>
 Available if .tag is no_account. The value is an account ID specified in :field:`GetAccountBatchArg.account_ids` that does not exist.
.tag 'no_account' | 'other' Tag identifying the union variant.

UsersGetAccountError

Type:
  • Object
Properties:
Name Type Description
.tag 'no_account' | 'other' Tag identifying the union variant.

UsersIndividualSpaceAllocation

Type:
  • Object
Properties:
Name Type Description
allocated number The total space allocated to the user's account (bytes).

UsersName

Representations for a person's name to assist with internationalization.
Type:
  • Object
Properties:
Name Type Description
given_name string Also known as a first name.
surname string Also known as a last name or family name.
familiar_name string Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name string A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name string An abbreviated form of the person's name. Their initials in most locales.

UsersPaperAsFilesValue

The value for UserFeature.paper_as_files.
Type:
  • Object
Properties:
Name Type Argument Description
enabled boolean <optional>
 Available if .tag is enabled. When this value is true, the user's Paper docs are accessible in Dropbox with the .paper extension and must be accessed via the /files endpoints. When this value is false, the user's Paper docs are stored separate from Dropbox files and folders and should be accessed via the /paper endpoints.
.tag 'enabled' | 'other' Tag identifying the union variant.

UsersSpaceAllocation

Space is allocated differently based on the type of account.
Type:
  • Object
Properties:
Name Type Argument Description
individual UsersIndividualSpaceAllocation <optional>
 Available if .tag is individual. The user's space allocation applies only to their individual account.
team UsersTeamSpaceAllocation <optional>
 Available if .tag is team. The user shares space with other members of their team.
.tag 'individual' | 'team' | 'other' Tag identifying the union variant.

UsersSpaceUsage

Information about a user's space usage and quota.
Type:
  • Object
Properties:
Name Type Description
used number The user's total space usage (bytes).
allocation UsersSpaceAllocation The user's space allocation.

UsersTeam

Information about a team.
Type:
  • Object
Properties:
Name Type Description
id string The team's unique ID.
name string The name of the team.

UsersTeamSpaceAllocation

Type:
  • Object
Properties:
Name Type Description
used number The total space currently used by the user's team (bytes).
allocated number The total space allocated to the user's team (bytes).
user_within_team_space_allocated number The total space allocated to the user within its team allocated space (0 means that no restriction is imposed on the user's quota within its team).
user_within_team_space_limit_type TeamCommonMemberSpaceLimitType - The type of the space limit imposed on the team member (off, alert_only, stop_sync).
user_within_team_space_used_cached number An accurate cached calculation of a team member's total space usage (bytes).

UsersUserFeature

A set of features that a Dropbox User account may have configured.
Type:
  • Object
Properties:
Name Type Description
.tag 'paper_as_files' | 'file_locking' | 'other' Tag identifying the union variant.

UsersUserFeaturesGetValuesBatchArg

Type:
  • Object
Properties:
Name Type Description
features Array.<UsersUserFeature> A list of features in UserFeature. If the list is empty, this route will return UserFeaturesGetValuesBatchError.

UsersUserFeaturesGetValuesBatchError

Type:
  • Object
Properties:
Name Type Description
.tag 'empty_features_list' | 'other' Tag identifying the union variant.

UsersUserFeaturesGetValuesBatchResult

Type:
  • Object
Properties:
Name Type Description
values Array.<UsersUserFeatureValue>

UsersUserFeatureValue

Values that correspond to entries in UserFeature.
Type:
  • Object
Properties:
Name Type Argument Description
paper_as_files UsersPaperAsFilesValue <optional>
 Available if .tag is paper_as_files.
file_locking UsersFileLockingValue <optional>
 Available if .tag is file_locking.
.tag 'paper_as_files' | 'file_locking' | 'other' Tag identifying the union variant.