Basic Parameters
| Parameter | Description |
|---|---|
| First Name | The first name of the user. |
| Password | The user’s initial password. |
| Username | The user’s username. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Email address for the user. | |
| Extra Fields | Any additional fields to add to the user. Can be one of: - permissions: which permissions the user should have - activated: whether the user’s account is activated (true/false) - manager_id: the ID of the user’s manager - employee_num: which number of employee the user is - company_id: the ID of the company the user belongs to - two_factor_enrolled: whether the user is enrolled in two-factor auth (true/false) - two_factor_optin: whether the user should have the option to enroll in two-factor auth (true/false) - department_id: the ID of the department the user belongs to - location_id: the ID of the location the user works in - remote: whether the user works remotely (true/false) - groups: ID of the group or groups the user should be associated with. Can be a single ID number of an array like [1,2,3] |
| Job Title | The user’s job title. |
| Last Name | The user’s last name. |
| Notes | Any additional notes to attach to the user. |
| Phone | The user’s phone number. |
Example Output
{
"status": "<string>",
"messages": "<string>",
"payload": {
"id": 29,
"avatar": "<string>",
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"username": "<string>",
"remote": false,
"locale": null,
"employee_num": null,
"manager": null,
"jobtitle": "<string>",
"vip": false,
"phone": null,
"website": null,
"address": null,
"city": "<string>",
"state": null,
"country": null,
"zip": null,
"email": "<string>",
"department": null,
"location": null,
"notes": "<string>",
"permissions": null,
"activated": false,
"autoassign_licenses": false,
"ldap_import": false,
"two_factor_enrolled": false,
"two_factor_optin": false,
"assets_count": 1,
"licenses_count": 1,
"accessories_count": 2,
"consumables_count": 2,
"manages_users_count": 1,
"manages_locations_count": 2,
"company": null,
"created_by": {
"id": 2,
"name": "<string>"
},
"created_at": {
"datetime": "2025-04-01 22:14:11",
"formatted": "Tue Apr 01, 2025 10:14PM"
},
"updated_at": {
"datetime": "2025-04-01 22:14:11",
"formatted": "Tue Apr 01, 2025 10:14PM"
},
"start_date": null,
"end_date": null,
"last_login": null,
"deleted_at": null,
"available_actions": {
"update": true,
"delete": true,
"clone": true,
"restore": false
},
"groups": null
}
}