Create User

Create a new user.

External Documentation

To learn more, visit the Zscaler Authentication Service documentation.

​

Basic Parameters

Parameter	Description
Department ID	The ID of the department to assign to the user.
Display Name	The display name of the user.
Login Name	The unique login name of the user.
Primary Email	The primary email address of the user.
Status	When selected, the user is active. When cleared, the user is disabled.

​

Advanced Parameters

Parameter	Description
Custom Attributes	The user-defined custom attributes to assign to the user. Note: If Custom Attributes are defined in the tenant but not set as required, you must pass {} in the request. For example: { “additionalProp1” : “string” }
First Name	The first name of the user.
Last Name	The last name of the user.
Secondary Email	The secondary email address of the user.

​

Example Output

{
	"loginName": "[e-mail]",
	"displayName": "Test",
	"firstName": "Jane",
	"lastName": "Smith",
	"primaryEmail": "[e-mail]",
	"secondaryEmail": "[e-mail]",
	"department": {},
	"status": true,
	"customAttrsInfo": {
		"IntegrationTest": "value_123"
	},
	"id": "abc123def456g",
	"source": "API",
	"idp": {
		"id": "xyz789uvw012m",
		"name": "Example IdP"
	}
}