Update User

Update a user in G Suite.

Input

Field Definition Type Required
Update By
User ID Unique identifier of the user String FALSE
User
First Name User's first name String FALSE
Last Name User's last name 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) 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. Boolean FALSE
Included in Global Address List? Indicates whether a user's profile is visible in the G Suite 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 charatcers, 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
Parent Organization Path

Organizational unit's parent path; for example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless parentOrgUnitId is set.

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 FALSE
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

Output

Field Definition Type
Status Code Success or failure of your HTTP request; here is a list of all status codes Number

Related topics

G Suite Admin connector

About the elements of Okta Workflows

G Suite API documentation