- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- AccessProposal
- RoleAndView
- Try it!
List the AccessProposals on a file. Note: Only approvers are able to list AccessProposals on a file. If the user is not an approver, returns a 403.
HTTP request
GET https://www.googleapis.com/drive/v3/files/{fileId}/accessproposals
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
file |
Required. The id of the item the request is on. |
Query parameters
Parameters | |
---|---|
page |
Optional. The continuation token on the list of access requests. |
page |
Optional. The number of results per page |
Request body
The request body must be empty.
Response body
The response to an Access Proposal list request.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"accessProposals": [
{
object ( |
Fields | |
---|---|
access |
The list of Access Proposals. This field is only populated in v3 and v3beta. |
next |
The continuation token for the next page of results. This will be absent if the end of the results list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/docs
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.readonly
Some scopes are restricted and require a security assessment for your app to use them. For more information, see the Authorization guide.
AccessProposal
The Access Proposal resource for outstanding access proposals on a file
JSON representation |
---|
{
"fileId": string,
"proposalId": string,
"requesterEmailAddress": string,
"recipientEmailAddress": string,
"rolesAndViews": [
{
object ( |
Fields | |
---|---|
file |
The file id that the proposal for access is on |
proposal |
The id of the access proposal |
requester |
The email address of the requesting user |
recipient |
The email address of the user that will receive permissions if accepted |
roles |
A wrapper for the role and view of an access proposal. |
request |
The message that the requester added to the proposal |
create |
The creation time A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
RoleAndView
A wrapper for the role and view of an access proposal.
JSON representation |
---|
{ "role": string, "view": string } |
Fields | |
---|---|
role |
The role that was proposed by the requester New values may be added in the future, but the following are currently possible: * |
view |
Indicates the view for this access proposal. Only populated for proposals that belong to a view. |