permissions

Creates, updates, deletes, gets or lists a permissions resource.

Overview

Name	permissions
Type	Resource
Id	googleworkspace.drivelabelsv2.permissions

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	Resource name of this permission.
audience	string	Audience to grant a role to. The magic value of audiences/default may be used to apply the role to the default audience in the context of the organization that owns the label.
email	string	Specifies the email address for a user or group principal. Not populated for audience principals. User and group permissions may only be inserted using an email address. On update requests, if email address is specified, no principal should be specified.
group	string	Group resource name.
person	string	Person resource name.
role	string	The role the principal should have. (LABEL_ROLE_UNSPECIFIED, READER, APPLIER, ORGANIZER, EDITOR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	labelsId, revisionsId	pageToken, useAdminAccess, pageSize	Lists a label's permissions.
create	insert	labelsId, revisionsId	useAdminAccess	Updates a label's permissions. If a permission for the indicated principal doesn't exist, a label permission is created, otherwise the existing permission is updated. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.
batch_update	update	labelsId, revisionsId		Updates label permissions. If a permission for the indicated principal doesn't exist, a label permission is created, otherwise the existing permission is updated. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.
delete	delete	labelsId, revisionsId, permissionsId	useAdminAccess	Deletes a label's permission. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.
batch_delete	delete	labelsId, revisionsId		Deletes label permissions. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.

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
labelsId	string
permissionsId	string
revisionsId	string
pageSize	integer (int32)
pageToken	string
useAdminAccess	boolean

SELECT examples

list

Lists a label's permissions.

SELECT
name,
audience,
email,
group,
person,
role
FROM googleworkspace.drivelabelsv2.permissions
WHERE labelsId = '{{ labelsId }}' -- required
AND revisionsId = '{{ revisionsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND useAdminAccess = '{{ useAdminAccess }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

create

Updates a label's permissions. If a permission for the indicated principal doesn't exist, a label permission is created, otherwise the existing permission is updated. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.

INSERT INTO googleworkspace.drivelabelsv2.permissions (
data__group,
data__role,
data__person,
data__audience,
data__name,
data__email,
labelsId,
revisionsId,
useAdminAccess
)
SELECT 
'{{ group }}',
'{{ role }}',
'{{ person }}',
'{{ audience }}',
'{{ name }}',
'{{ email }}',
'{{ labelsId }}',
'{{ revisionsId }}',
'{{ useAdminAccess }}'
RETURNING
name,
audience,
email,
group,
person,
role
;

Manifest

# Description fields are for documentation purposes
- name: permissions
props:
  - name: labelsId
    value: "{{ labelsId }}"
    description: Required parameter for the permissions resource.
  - name: revisionsId
    value: "{{ revisionsId }}"
    description: Required parameter for the permissions resource.
  - name: group
    value: "{{ group }}"
    description: |
      Group resource name.
  - name: role
    value: "{{ role }}"
    description: |
      The role the principal should have.
    valid_values: ['LABEL_ROLE_UNSPECIFIED', 'READER', 'APPLIER', 'ORGANIZER', 'EDITOR']
  - name: person
    value: "{{ person }}"
    description: |
      Person resource name.
  - name: audience
    value: "{{ audience }}"
    description: |
      Audience to grant a role to. The magic value of `audiences/default` may be used to apply the role to the default audience in the context of the organization that owns the label.
  - name: name
    value: "{{ name }}"
    description: |
      Resource name of this permission.
  - name: email
    value: "{{ email }}"
    description: |
      Specifies the email address for a user or group principal. Not populated for audience principals. User and group permissions may only be inserted using an email address. On update requests, if email address is specified, no principal should be specified.
  - name: useAdminAccess
    value: {{ useAdminAccess }}

UPDATE examples

batch_update

Updates label permissions. If a permission for the indicated principal doesn't exist, a label permission is created, otherwise the existing permission is updated. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.

UPDATE googleworkspace.drivelabelsv2.permissions
SET 
data__requests = '{{ requests }}',
data__useAdminAccess = {{ useAdminAccess }}
WHERE 
labelsId = '{{ labelsId }}' --required
AND revisionsId = '{{ revisionsId }}' --required
RETURNING
permissions;

DELETE examples

delete

Deletes a label's permission. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.

DELETE FROM googleworkspace.drivelabelsv2.permissions
WHERE labelsId = '{{ labelsId }}' --required
AND revisionsId = '{{ revisionsId }}' --required
AND permissionsId = '{{ permissionsId }}' --required
AND useAdminAccess = '{{ useAdminAccess }}'
;

batch_delete

Deletes label permissions. Permissions affect the label resource as a whole, aren't revisioned, and don't require publishing.

DELETE FROM googleworkspace.drivelabelsv2.permissions
WHERE labelsId = '{{ labelsId }}' --required
AND revisionsId = '{{ revisionsId }}' --required
;