Create User

Create user in Google Workspace.

For more information, refer to the Google API document

Input

Field	Definition	Type	Required
User
First Name	User's first name.	Text	TRUE
Last Name	User's last name.	Text	TRUE
Primary Email	User's primary email address (must be unique and can't be an alias of another user).	Text	TRUE
Notes	Notes for the user.	Text	FALSE
Included in Global Address List?	Indicates whether the 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 Hide a user from the Directory.	True/False	FALSE
Password	Password for the user account (password requirements: minimum 8 characters, maximum 100 characters, may contain any combination of ASCII characters). We recommend sending the password property value as a base 16 bit, hexadecimal-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.	Text	TRUE
Hash Format	Hash format for the storage of the password property; options are SHA-1, MD5, or CRYPT.	Dropdown	FALSE
Change Password At Next Login?	Indicates whether the user is forced to change their password the next time they sign in (this doesn't apply when SSO is configured with a third-party identity provider).	True/False	FALSE
IP Allow Listed?	Indicates whether the user's IP address is allow listed.	True/False	FALSE
Organization Unit Path	Full path to the organizational that's 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 isn't required. 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.	Text	FALSE
Alias	Alias email address.	Text	FALSE
IM
IM Network ID	User's IM accounts (user may have multiple IM accounts but only one primary).	Text	FALSE
Type	Type of data returned.	Dropdown	FALSE
Custom Type	Required, user-defined value if IM type is custom.	Text	FALSE
Protocol	IM network (custom network or standard network).	option	FALSE
Custom Protocol	Required, user-defined value if the protocol is custom.	Text	FALSE
Email
Email Address	Email address of the user.	Text	FALSE
Type	Type of email address; options are home, work, custom, or other.	Dropdown	FALSE
Custom Type	Required, user-defined value if email address type selection is custom.	Text	FALSE
External ID
External ID	Unique external ID of the user.	Text	FALSE
Type	Type of external ID; options are account, customer, login_ID, network, organization, or custom.	Dropdown	FALSE
Custom Type	Required, user-defined value if address type selection is custom.	Text	FALSE
Relation
Relation Name	Name of the person the user is related to.	Text	FALSE
Type	Type of relation; options are admin_assistant, assistant, brother, child, domestic_partner, dotted_line_manager, exec_assistant, father, friend, manager, mother, parent, partner, referred_by, relative, sister, spouse, or custom.	Dropdown	FALSE
Custom Type	Required, user-defined value if type is custom.	Text	FALSE
Address
Street	Street portion of the user's address.	Text	FALSE
PO Box	User's post office box.	Text	FALSE
City	User's city of residence.	Text	FALSE
Region	User's geographic region.	Text	FALSE
Postal Code	Zip or postal code of the user's address.	Text	FALSE
Country	User's country of residence.	Text	FALSE
Country Code	Telephone prefix for user's country of residence (ISO 3166-1 standard).	Text	FALSE
Extended Address	Extended fields for addresses that includes a sub-region.	Text	FALSE
Formatted Address	Formatted version of the address.	Text	FALSE
Type	Type of physical address; options are home, work, custom, or other.	Dropdown	FALSE
Custom Type	Required, user-defined value if address type selection is custom	Text	FALSE
Organization
Organization Name	Name of the organization.	Text	FALSE
Description	Description of the organization.	Text	FALSE
Department	Department in the organization that the user is associated with (for example, sales or engineering).	Text	FALSE
Job Title	User's title in the organization (for example, member or engineer).	Text	FALSE
Location	Physical location of the organization. This doesn't have to be an address.	Text	FALSE
Symbol	Text string symbol of the organization (for example, Google's symbol is GOOG).	Text	FALSE
Cost Center	Cost center of the user's organization.	Text	FALSE
Domain	Domain that the organization belongs to.	Text	FALSE
Type	Type of organization; options are domain_only, school, work, unknown, or custom.	Dropdown	FALSE
Custom Type	Required, user-defined value if address type selection is custom.	Text	FALSE
Phone
Phone Number	Human-readable phone number (any telephone number format).	Text	FALSE
Type	Type of phone number; options are assistant, callback, car, company_main, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_ttd, work, work_fax, work_mobile, work_pager, or custom.	Dropdown	FALSE
Custom Type	Required, user-defined value if the type is custom.	Text	FALSE
Website
Website URL	URL of the website.	Text	FALSE
Type	Type or purpose of the website; options are app_install_page, blog, ftp, home, home_page, other, profile, reservations, work, or other.	Dropdown	FALSE
Licenses
Licenses	Product licenses that you want to assign to the user.	List of Objects	FALSE

Output

Field	Definition	Type
User ID	Unique identifier of the user.	Text

Create User

Input

Output

Related topics