Update User

Update a user in Google Workspace.

Input

Field Definition Type Required
Update By
User ID Unique identifier of the user. String FALSE
User
First Name User's first name. For example, Henry. String FALSE
Last Name User's last name. For example, Dewer. String FALSE
Notes Notes for the user. String FALSE
Is Admin? Indicates whether a user has super administrator privileges (this field can only be edited in the Make User Admin action).
Caution

This input field is no longer available when the Update User action card is added to new or existing flows.

Boolean FALSE
Is Delegated Admin? Indicates whether a user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console.
Caution

This input field is no longer available when the Update User action card is added to new or existing flows.

Boolean FALSE
Included in Global Address List? Indicates whether a user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the administration help center. Boolean FALSE
Password Password for the user account (password requirements: minimum 8 characters, maximum 100 characters, may contain any combination of ASCII characters). Storing the user's password is optional when updating a user and should only be provided if the user is updating their account password. We recommend sending the password property value as a base 16 bit, hexidecimal-encoded hash value. If a hashFunction is specified, the password must be a valid hash key. The password value is never returned in the API's response body. String FALSE
Hash Format Determines the hash format of the password property; options are SHA-1, MD5, or CRYPT. Dropdown FALSE
Change Password At Next Login? Indicates whether a user is forced to change their password at next login (does not apply when SSO is configured with a third party identity provider). Boolean FALSE
IP Allow Listed? Indicates whether a user's IP address is allow listed. Boolean FALSE
Organization Unit Path

Full path to the organizational associated with the user.

A user's organizational unit determines to which Google Workspace services the user has access. If the user is moved to a new organization, the user's access changes.

The full path requires a leading slash (/).

For example, for an organization unit named sales_support under /corp/sales, the full organization unit path is /sales/sales_support. The organization key, corp is not required.

Note

You can't remove a user from an organizational unit. This field only allows you to change the organizational unit to which a user belongs.

String  
Custom Schema Name Name of a custom schema for a user. String FALSE
Custom Fields All fields from a custom schema for a user. String FALSE
Archive? Indicates whether to archive the user profile. Boolean FALSE

Output

Field Definition Type
Status Code Result of the operation. The HTTP status code is returned by the connector and indicates whether the action taken by the card succeeded or failed. For example:
  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request was not processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

Number

Related topics

Google Workspace Admin connector

Elements of Workflows

Google Workspace API documentation