External DocumentationTo learn more, visit the Google Admin Console documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Change Password At Next Login | Indicates if the user is forced to change their password at next login. This setting doesn’t apply when the user signs in via a third-party identity provider. |
| Customer ID | The unique ID for the customer’s Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account’s customer ID. The customer ID can be obtained by the List Users action. |
| Organizational Unit Path | The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/). |
| Password | The user’s password to update. |
| Suspend User | Select to suspend the user. |
| User Key | A unique identifier of the user to update. The value can be the user’s primary email address, alias email address, or unique user ID. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Additional Parameters | A JSON object for additional body parameters. Values specified in this parameter will override equivalent parameters. For example: |
| Delegated User Override | Perform the action on behalf of another user, overriding the delegated user defined in the connection. If not specified, the delegated user is the one provided in the connection. Has no effect when using an OAuth connection. NOTE: the connection details are not edited by this input. |
Example Output
{
"id": string,
"primaryEmail": string,
"password": value,
"hashFunction": string,
"isAdmin": boolean,
"isDelegatedAdmin": boolean,
"agreedToTerms": boolean,
"suspended": boolean,
"changePasswordAtNextLogin": boolean,
"ipWhitelisted": boolean,
"name": {
{
"fullName": string,
"familyName": string,
"givenName": string,
"displayName": string
}
},
"kind": string,
"etag": string,
"emails": value,
"externalIds": value,
"relations": value,
"aliases": [
string
],
"isMailboxSetup": boolean,
"customerId": string,
"addresses": value,
"organizations": value,
"lastLoginTime": string,
"phones": value,
"suspensionReason": string,
"thumbnailPhotoUrl": string,
"languages": value,
"posixAccounts": value,
"creationTime": string,
"nonEditableAliases": [
string
],
"sshPublicKeys": value,
"notes": value,
"websites": value,
"locations": value,
"includeInGlobalAddressList": boolean,
"keywords": value,
"deletionTime": string,
"gender": value,
"thumbnailPhotoEtag": string,
"ims": value,
"customSchemas": value,
"isEnrolledIn2Sv": boolean,
"isEnforcedIn2Sv": boolean,
"archived": boolean,
"orgUnitPath": string,
"recoveryEmail": string,
"recoveryPhone": string
}