Back to DropboxSharing - Get Shared Link Metadata
Get the shared link's metadata.
Input
type: object
properties:
data:
type: object
description: >
url: URL of the shared link.
path: 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: If the shared link has a password, this parameter can be
used.
properties:
url:
type: string
description: URL of the shared link.
path:
type: string
description: >-
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:
type: string
description: If the shared link has a password, this parameter can be used.
title: Data
Output
type: object
description: >
The metadata of a shared link.
url: URL of the shared link.
name: The linked file name (including extension). This never contains a slash.
link_permissions: The link's access permissions.
id: A unique identifier for the linked file.
expires: Expiration time, if set. By default the link won't expire.
path_lower: 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: 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: 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.
properties:
name:
type: string
description: The linked file name (including extension). This never contains a slash.
url:
type: string
description: URL of the shared link.
expires:
type: string
description: Expiration time, if set. By default the link won't expire.
path_lower:
type: string
description: >-
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.
content_owner_team_info:
type: object
description: |
Information about a team.
id: The team's unique ID.
name: The name of the team.
properties:
id:
type: string
description: The team's unique ID.
name:
type: string
description: The name of the team.
link_permissions:
type: object
description: >
can_revoke: Whether the caller can revoke the shared link.
resolved_visibility: 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).
requested_visibility: 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
:field:`resolved_visibility`. This is shown only if the caller is the
link's owner.
revoke_failure_reason: The failure reason for revoking the link. This
field will only be present if the :field:`can_revoke` is :val:`false`.
properties:
requested_visibility:
type: object
description: >
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 :type:`ResolvedVisibility` for more info on the
possible resolved visibility values of shared links.
public: Anyone who has received the link can access it. No login
required.
team_only: Only members of the same team can access the link. Login is
required.
password: A link-specific password is required to access the link.
Login is not required.
properties:
.tag:
title: Choice of RequestedVisibility
type: string
enum:
- public
- team_only
- password
resolved_visibility:
type: object
description: >
The actual access permissions values of shared links after taking into
account user preferences and the team and shared folder settings.
Check the :type:`RequestedVisibility` for more info on the possible
visibility values that can be set by the shared link's owner.
public: Anyone who has received the link can access it. No login
required.
team_only: Only members of the same team can access the link. Login is
required.
password: A link-specific password is required to access the link.
Login is not required.
team_and_password: Only members of the same team who have the
link-specific password can access the link. Login is required.
shared_folder_only: Only members of the shared folder containing the
linked file can access the link. Login is required.
other: None
properties:
.tag:
title: Choice of ResolvedVisibility
type: string
enum:
- public
- team_only
- password
- team_and_password
- shared_folder_only
- other
can_revoke:
type: boolean
description: Whether the caller can revoke the shared link.
revoke_failure_reason:
type: object
description: |
login_required: User is not logged in.
email_verify_required: User's email is not verified.
password_required: The link is password protected.
team_only: Access is allowed for team members only.
owner_only: Access is allowed for the shared link's owner only.
other: None
properties:
.tag:
title: Choice of SharedLinkAccessFailureReason
type: string
enum:
- login_required
- email_verify_required
- password_required
- team_only
- owner_only
- other
team_member_info:
type: object
description: >
Information about a team member.
team_info: Information about the member's team.
display_name: The display name of the user.
member_id: 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.
properties:
member_id:
type: string
description: >-
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.
display_name:
type: string
description: The display name of the user.
team_info:
type: object
description: |
Information about a team.
id: The team's unique ID.
name: The name of the team.
properties:
id:
type: string
description: The team's unique ID.
name:
type: string
description: The name of the team.
id:
type: string
description: A unique identifier for the linked file.