Google: Drive accessproposals schemas
4 Google schemas with complete fields and constraints.
← Drive accessproposals operations · All schemas
Approves or denies an access proposal For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request message for resolving an AccessProposal on a file. |
action | string | Optional | Required. The action to take on the access proposal. One of: ACTION_UNSPECIFIED, ACCEPT, DENY |
role | array | Optional | Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action. |
role[] | string | Each item | |
sendNotification | boolean | Optional | Optional. Whether to send an email to the requester when the access proposal is denied or accepted. |
view | string | Optional | Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported. |
List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file If the user isn't an approver, a 403 error is returned — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The response to an access proposal list request. |
accessProposals | array | Optional | The list of access proposals. This field is only populated in Drive API v3. |
accessProposals[] | Model | Each item | Expand Retrieves an access proposal by ID For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access) — response body |
nextPageToken | string | Optional | 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. |
Retrieves an access proposal by ID For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Manage outstanding access proposals on a file. |
createTime | string | Optional | The creation time. Format: google-datetime |
fileId | string | Optional | The file ID that the proposal for access is on. |
proposalId | string | Optional | The ID of the access proposal. |
recipientEmailAddress | string | Optional | The email address of the user that will receive permissions, if accepted. |
requestMessage | string | Optional | The message that the requester added to the proposal. |
requesterEmailAddress | string | Optional | The email address of the requesting user. |
rolesAndViews | array | Optional | A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). |
rolesAndViews[] | Model | Each item | Expand Retrieves an access proposal by ID For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access) — response body — roles And Views item |
Retrieves an access proposal by ID For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access) — response body — roles And Views item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). |
role | string | Optional | The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader` |
view | string | Optional | Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported. |