accessproposals

Creates, updates, deletes, gets or lists an accessproposals resource.

Overview

Name	accessproposals
Type	Resource
Id	googleworkspace.drivev3.accessproposals

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
createTime	string (google-datetime)	The creation time.
fileId	string	The file ID that the proposal for access is on.
proposalId	string	The ID of the access proposal.
recipientEmailAddress	string	The email address of the user that will receive permissions, if accepted.
requestMessage	string	The message that the requester added to the proposal.
requesterEmailAddress	string	The email address of the requesting user.
rolesAndViews	array	A wrapper for the role and view of an access proposal. For more information, see Roles and permissions.

list

Name	Datatype	Description
createTime	string (google-datetime)	The creation time.
fileId	string	The file ID that the proposal for access is on.
proposalId	string	The ID of the access proposal.
recipientEmailAddress	string	The email address of the user that will receive permissions, if accepted.
requestMessage	string	The message that the requester added to the proposal.
requesterEmailAddress	string	The email address of the requesting user.
rolesAndViews	array	A wrapper for the role and view of an access proposal. For more information, see Roles and permissions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	fileId, proposalId		Retrieves an access proposal by ID. For more information, see Manage pending access proposals.
list	select	fileId	pageSize, pageToken	List the access proposals on a file. For more information, see Manage pending access proposals. Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.
resolve	exec	fileId, proposalId		Approves or denies an access proposal. For more information, see Manage pending access proposals.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
fileId	string
proposalId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Retrieves an access proposal by ID. For more information, see Manage pending access proposals.

SELECT
createTime,
fileId,
proposalId,
recipientEmailAddress,
requestMessage,
requesterEmailAddress,
rolesAndViews
FROM googleworkspace.drivev3.accessproposals
WHERE fileId = '{{ fileId }}' -- required
AND proposalId = '{{ proposalId }}' -- required
;

list

List the access proposals on a file. For more information, see Manage pending access proposals. Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.

SELECT
createTime,
fileId,
proposalId,
recipientEmailAddress,
requestMessage,
requesterEmailAddress,
rolesAndViews
FROM googleworkspace.drivev3.accessproposals
WHERE fileId = '{{ fileId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

Lifecycle Methods

resolve

Approves or denies an access proposal. For more information, see Manage pending access proposals.

EXEC googleworkspace.drivev3.accessproposals.resolve 
@fileId='{{ fileId }}' --required, 
@proposalId='{{ proposalId }}' --required 
@@json=
'{
"role": "{{ role }}", 
"view": "{{ view }}", 
"action": "{{ action }}", 
"sendNotification": {{ sendNotification }}
}'
;