In CloudM Automate, you can create, delete, or update users and groups individually or in bulk via CSV or Google Sheets. Each operation requires specific mandatory fields and adheres to Google Workspace directory logic.
Mandatory fields & CSV structure
Your CSV only needs to contain the mandatory headers for the specific action you are performing. You do not need to include every header from a full export. Removing optional columns reduces processing errors.
Always save your file with UTF-8 encoding to ensure special characters in names or OU paths are processed correctly.
Exporting
Exporting data allows you to generate a template containing existing IDs and Organisational Unit (OU) paths, reducing manual entry errors.
Pro tip
Performing an export from a specific OU is the most reliable way to find hard-to-know values such as Parent Paths or system-generated Group IDs, ensuring your import matches the directory exactly.
- Navigate to the Organisational Unit you wish to manage.
- In the Actions menu, select Export Items.
- Choose CSV (email attachment) or Google Sheet (deposited into Google Drive).
For new creations, you can use the Downloadable Bulk Template File.
Importing
Only one import can run at any one time. Use Check Import Status from the OU Actions menu to confirm whether an import is already in progress before starting a new one.
You can import from your My Drive or a Shared Drive.
Creation
Users
| Field | Value |
|---|---|
| Record Type |
USER
|
| Operation |
CREATE
|
| Id | The primary email address. |
| Given Name | User's first name. |
| Family Name | User's last name. |
| Password | Must adhere to your organisation's password complexity policies. |
Groups
| Field | Value |
|---|---|
| Record Type |
GROUP
|
| Operation |
CREATE
|
| Name | Display name of the group. |
| Primary group email address. | |
| IsDynamic |
TRUE
or
FALSE.
Requires compatible Google Workspace licensing.
|
Updating
Exported files default the Operation column to
UPDATE.
To avoid accidental overwrites, remove any headers that you do not intend to
modify.
Mandatory identifiers
| Type | Identifier |
|---|---|
| Users | Use the primary email address in the Id column. |
| Groups | Use the unique system Id (alphanumeric string) from the export. Do not edit this value. |
Deletion (offboarding)
Users
| Field | Value |
|---|---|
| Record Type |
USER
|
| Operation |
REMOVE
|
| Id | Primary email address. |
| Parent Path | The specific OU path where the user currently resides (found via Export). |
Groups
| Field | Value |
|---|---|
| Record Type |
GROUP
|
| Operation |
REMOVE
|
| Id | Unique system ID (found via Export). |
Password management
RESET_PASSWORD
Updates the directory password for the specified user.
| Field | Value |
|---|---|
| Operation |
RESET_PASSWORD
|
| Password | The new alphanumeric string. |
| ResetPassword |
TRUE
to force a password change at next login, or
FALSE.
|
FORCE_CHANGE_PASSWORD
Forces a password change for users authenticating directly via Google services.
| Field | Value |
|---|---|
| Operation |
FORCE_CHANGE_PASSWORD
|
| Id | Primary email address. |
Managing pre-defined fields
To manage custom values without overwriting existing data, add a column titled
Custom Field x - Operation.
This allows granular control over individual fields.
Example header logic:
Id,Record Type,Operation,Custom Field 2,Custom Field 2 - Operation user@domain.com,USER,UPDATE,XYZ321,CHANGE
Setting a field operation to
CHANGE
or
REMOVE
allows you to target only that specific custom field while other fields remain
untouched.
▶ Glossary
A full reference of all valid field names and accepted values for bulk import operations.
| Field name | Accepted values / format |
|---|---|
| Record Type |
USER or GROUP
|
| Operation |
CREATE,
UPDATE,
REMOVE,
RESET_PASSWORD,
FORCE_CHANGE_PASSWORD
|
| Id | For users, the primary email address. For groups, the unique system ID provided on export. Do not edit the group ID. |
| Given Name | Any alphanumeric string. |
| Additional Name | Any alphanumeric string. |
| Family Name | Any alphanumeric string. |
| Name Prefix |
Mr,
Mrs,
Miss,
Dr, or
Prof
|
| Nickname | Any alphanumeric string. |
| Short Name | Any alphanumeric string. |
| Maiden Name | Any alphanumeric string. |
| Birthday |
YYYY-MM-DD
|
| Gender |
MALE,
FEMALE, or
UNKNOWN
|
| Subject | Any alphanumeric string. |
| Notes | Any alphanumeric string. |
| Organization # - Department | Any alphanumeric string. |
| Organization # - Job Description | Any alphanumeric string. |
| Organization # - Name | Any alphanumeric string. |
| Organization # - Title | Any alphanumeric string. |
| Organization # - Employment Type | Any alphanumeric string. |
| Alias Operation |
REPLACE to replace all existing aliases, even if none are specified.
|
| Alias # | Any alphanumeric string. |
| Email # - Type |
General,
Work,
Home, or
Other. Prefix with * to set as primary.
|
| Email # - Value | A valid email address. |
| Parent Path | The destination Organisational Unit path. |
| Phone Operation |
REPLACE to replace all existing telephone numbers, even if none are specified.
|
| Phone # - Type |
Mobile,
Home,
Work,
Work_Mobile,
Callback,
Assistant,
Company,
Fax,
Home_Fax,
Work_Fax,
Other_Fax,
Pager,
Work_Pager,
Car,
Radio,
TTY_TDD,
ISDN,
Telex,
Other, or
Main. Prefix with * to set as primary.
|
| Phone # - Value | A valid phone number. |
| Address Operation |
REPLACE to replace all existing addresses, even if none are specified.
|
| Address # - Type |
Home,
Work, or
Other
|
| Address # - Formatted | An address spread over multiple lines (line breaks accepted). |
| Relation Operation |
REPLACE to replace all existing relations, even if none are specified.
|
| Relation # - Type |
Assistant or
Manager
|
| Relation # - Value | The name of the person. |
| IM Operation |
REPLACE to replace all existing IM addresses, even if none are specified.
|
| IM # - Type |
AIM,
Google Talk,
ICQ,
Jabber,
MSN,
Netmeeting,
QQ,
Skype, or
Yahoo
|
| IM # - Value | A valid IM address. |
| Website Operation |
REPLACE to replace all existing websites, even if none are specified.
|
| Website # - Type |
Blog,
Ftp,
Home,
Home_Page,
Other,
Profile, or
Work
|
| Website # - Value | A valid URL. |
| Custom Field Operation |
REPLACE to replace all existing custom fields, even if none are specified.
|
| Custom Field # - Type | Any string value matching your custom types. |
| Custom Field # - Value | Any alphanumeric string, or TRUE / FALSE depending on the custom field type. |
| Custom Field # - Operation |
ADD,
REMOVE, or
CHANGE
|
| Tag Operation |
REPLACE to replace all existing tags, even if none are specified.
|
| Tag # - Value | Any string value. |
| Tag # - Font Color | 6-character hex colour code (RRGGBB), e.g. ffffff. |
| Tag # - Back Color | 6-character hex colour code (RRGGBB), e.g. 0454cc. |
| Licence Product # - Value | A valid licence product ID (e.g. Google-Apps). Google Voice, Cloud Identity, and Cloud Identity Premium are not supported. |
| License SKU # - Value | A valid licence SKU ID (e.g. Google-Apps-Unlimited). Google Voice, Cloud Identity, and Cloud Identity Premium are not supported. |
| End Date | YYYY-MM-DD |
| Suspended |
TRUE or FALSE
|
| Hidden |
TRUE or FALSE
|
| Hold |
TRUE or FALSE
|
| Description | Any alphanumeric string. |
| Query | A valid search query within CloudM Automate. |
| Password | Any alphanumeric string adhering to your organisation's password policy. |
| ResetPassword |
TRUE to force a password change at next login, or FALSE. Applies to CloudM Automate SSO only.
|
Need help? Contact CloudM Support