users_guest

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

Overview

Name	users_guest
Type	Resource
Id	googleadmin.directory.users_guest

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_guest	insert			Create a guest user with access to a subset of Workspace capabilities. This feature is currently in Open Beta.

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

INSERT examples

create_guest

Create a guest user with access to a subset of Workspace capabilities. This feature is currently in Open Beta.

INSERT INTO googleadmin.directory.users_guest (
data__primaryGuestEmail,
data__customer
)
SELECT 
'{{ primaryGuestEmail }}',
'{{ customer }}'
RETURNING
id,
name,
addresses,
agreedToTerms,
aliases,
archivalTime,
archived,
changePasswordAtNextLogin,
creationTime,
customSchemas,
customerId,
deletionTime,
emails,
etag,
externalIds,
gender,
guestAccountInfo,
hashFunction,
ims,
includeInGlobalAddressList,
ipWhitelisted,
isAdmin,
isDelegatedAdmin,
isEnforcedIn2Sv,
isEnrolledIn2Sv,
isGuestUser,
isMailboxSetup,
keywords,
kind,
languages,
lastLoginTime,
locations,
nonEditableAliases,
notes,
orgUnitPath,
organizations,
password,
phones,
posixAccounts,
primaryEmail,
recoveryEmail,
recoveryPhone,
relations,
sshPublicKeys,
suspended,
suspensionReason,
suspensionTime,
thumbnailPhotoEtag,
thumbnailPhotoUrl,
websites
;

Manifest

# Description fields are for documentation purposes
- name: users_guest
props:
  - name: primaryGuestEmail
    value: "{{ primaryGuestEmail }}"
    description: |
      Required. External email of the guest user being created.
  - name: customer
    value: "{{ customer }}"
    description: |
      Optional. Immutable ID of the Google Workspace account. Only required when request is created by a service account. Defaults to the authenticated user's customer ID otherwise.