Update

update user

52 variables
51 variables

update user

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage the provisioning of users on your domain

Input

This building block consumes 52 input parameters

  = Parameter name
  = Format

userKey STRING Required

Email or immutable ID of the user. If ID, it should match with id of user object

addresses ANY

Addresses of User

archived BOOLEAN

Indicates if user is archived

deletionTime DATE_TIME

phones ANY

Phone numbers of User

isMailboxSetup BOOLEAN

Output only. Is mailbox setup (Read-only)

creationTime DATE_TIME

User's G Suite account creation time. (Read-only)

isEnrolledIn2Sv BOOLEAN

Output only. Is enrolled in 2-step verification (Read-only)

thumbnailPhotoEtag STRING

Output only. ETag of the user's photo (Read-only)

suspended BOOLEAN

Indicates if user is suspended

posixAccounts ANY

The POSIX accounts of User

emails ANY

Emails of User

externalIds ANY

The external Ids of User *

gender ANY

Gender of User

password STRING

User's password

hashFunction STRING

Hash function name for password. Supported are MD5, SHA-1 and crypt

recoveryEmail STRING

Recovery email of the user

locations ANY

Locations of User

kind STRING

Output only. Kind of resource this is

aliases[] STRING

includeInGlobalAddressList BOOLEAN

Boolean indicating if user is included in Global Address List

suspensionReason STRING

Output only. Suspension reason if user is suspended (Read-only)

etag STRING

Output only. ETag of the resource

name OBJECT

name.fullName STRING

Full Name

name.givenName STRING

First Name

name.familyName STRING

Last Name

sshPublicKeys ANY

The SSH public keys of User

keywords ANY

Keywords of User

isAdmin BOOLEAN

Output only. Boolean indicating if the user is admin (Read-only)

customerId STRING

Output only. CustomerId of User (Read-only)

recoveryPhone STRING

Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212

ims ANY

User's Instant Messenger

id STRING

Unique identifier of User (Read-only)

nonEditableAliases[] STRING

notes ANY

Notes of User

relations ANY

The Relations of User *

customSchemas OBJECT

Custom fields of the user

customSchemas.customKey OBJECT

Add additional named properties

customSchemas.customKey.customKey.value ANY Required

JSON template for a set of custom properties (i.e. all fields in a particular schema)

primaryEmail STRING

username of User

websites ANY

Websites of User

orgUnitPath STRING

OrgUnit of User

thumbnailPhotoUrl STRING

Output only. Photo Url of the user (Read-only)

isEnforcedIn2Sv BOOLEAN

Output only. Is 2-step verification enforced (Read-only)

agreedToTerms BOOLEAN

Output only. Indicates if user has agreed to terms (Read-only)

organizations ANY

Organizations of User

changePasswordAtNextLogin BOOLEAN

Boolean indicating if the user should change password in next login

languages ANY

Languages of User

ipWhitelisted BOOLEAN

Boolean indicating if ip is whitelisted

lastLoginTime DATE_TIME

User's last login time. (Read-only)

isDelegatedAdmin BOOLEAN

Output only. Boolean indicating if the user is delegated admin (Read-only)

Output

This building block provides 51 output parameters

  = Parameter name
  = Format

addresses ANY

Addresses of User

archived BOOLEAN

Indicates if user is archived

deletionTime DATE_TIME

phones ANY

Phone numbers of User

isMailboxSetup BOOLEAN

Output only. Is mailbox setup (Read-only)

creationTime DATE_TIME

User's G Suite account creation time. (Read-only)

isEnrolledIn2Sv BOOLEAN

Output only. Is enrolled in 2-step verification (Read-only)

thumbnailPhotoEtag STRING

Output only. ETag of the user's photo (Read-only)

suspended BOOLEAN

Indicates if user is suspended

posixAccounts ANY

The POSIX accounts of User

emails ANY

Emails of User

externalIds ANY

The external Ids of User *

gender ANY

Gender of User

password STRING

User's password

hashFunction STRING

Hash function name for password. Supported are MD5, SHA-1 and crypt

recoveryEmail STRING

Recovery email of the user

locations ANY

Locations of User

kind STRING

Output only. Kind of resource this is

aliases[] STRING

includeInGlobalAddressList BOOLEAN

Boolean indicating if user is included in Global Address List

suspensionReason STRING

Output only. Suspension reason if user is suspended (Read-only)

etag STRING

Output only. ETag of the resource

name OBJECT

name.fullName STRING

Full Name

name.givenName STRING

First Name

name.familyName STRING

Last Name

sshPublicKeys ANY

The SSH public keys of User

keywords ANY

Keywords of User

isAdmin BOOLEAN

Output only. Boolean indicating if the user is admin (Read-only)

customerId STRING

Output only. CustomerId of User (Read-only)

recoveryPhone STRING

Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212

ims ANY

User's Instant Messenger

id STRING

Unique identifier of User (Read-only)

nonEditableAliases[] STRING

notes ANY

Notes of User

relations ANY

The Relations of User *

customSchemas OBJECT

Custom fields of the user

customSchemas.customKey OBJECT

Add additional named properties

customSchemas.customKey.customKey.value ANY

JSON template for a set of custom properties (i.e. all fields in a particular schema)

primaryEmail STRING

username of User

websites ANY

Websites of User

orgUnitPath STRING

OrgUnit of User

thumbnailPhotoUrl STRING

Output only. Photo Url of the user (Read-only)

isEnforcedIn2Sv BOOLEAN

Output only. Is 2-step verification enforced (Read-only)

agreedToTerms BOOLEAN

Output only. Indicates if user has agreed to terms (Read-only)

organizations ANY

Organizations of User

changePasswordAtNextLogin BOOLEAN

Boolean indicating if the user should change password in next login

languages ANY

Languages of User

ipWhitelisted BOOLEAN

Boolean indicating if ip is whitelisted

lastLoginTime DATE_TIME

User's last login time. (Read-only)

isDelegatedAdmin BOOLEAN

Output only. Boolean indicating if the user is delegated admin (Read-only)