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.

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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	fileId, proposalId		Retrieves an AccessProposal by ID.
list	select	fileId	pageToken, pageSize	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.
resolve	exec	fileId, proposalId		Used to approve or deny an Access Proposal.

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 AccessProposal by ID.

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

list

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.

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

Lifecycle Methods

resolve

Used to approve or deny an Access Proposal.

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