Update user

Update the details of a user within your Zscaler environment.

Options

Field Definition Type Required

Pass Empty Values

Specifies whether empty values are passed to the remote system, instead of skipping an update to the field.

  • Yes: For any input field on the card that's blank or given a null value, the update includes the empty field. This clears any existing value on the remote system for that field.

  • No: For any input field on the card that's blank or given a null value, nothing is sent to the remote system for this field. Any existing value on the remote system remains unchanged.

Dropdown TRUE

Input

Field Definition Type Required

User

ID

Unique identifier of the user.

Text TRUE

First Name

Given name of the user.

Text FALSE

Last Name

Last name of the user.

Text FALSE

Secondary Email

A secondary email address of the user. The primary and secondary email address can't be the same.

Text FALSE

Login Name

The email address of the user with your Zscaler domain name.

Text FALSE

Primary Email

The email address of the user.

Text FALSE

Display Name

Name displayed for the user.

Text FALSE

Status

The status of the user.

  • Active

  • Inactive

Dropdown FALSE

Output

Field Definition Type

User

ID

Unique identifier of the user.

Text

Login Name

The email address of the user with your Zscaler domain name.

Text

Primary Email

The email address of the user.

Text

Display Name

Name displayed for the user.

Text

Status

If True, the user is active.

True/False

First Name

Given name of the user.

Text

Last Name

Last name of the user.

Text

Secondary Email

A secondary email address of the user. The primary and secondary email address can't be the same.

Text

Source

The source type where the user was created.

Text

Department

Object

ID

The unique identifier of the department.

Text

Name

The name of the department.

Text

Display Name

The name displayed for the department.

Text

Identity Provider

Object

ID

The unique identifier of the referenced entity or identity provider.

Text

Name

The name of the referenced entity or identity provider.

Text

Display Name

The name displayed for the referenced entity or identity provider.

Text

Custom Attributes

User-defined custom fields for the user.

Object

Response

Raw Output

The raw output returned by the Zscaler API.

Object