Create a New End User

post

https://{account}.sysaidit.com/connect/v1/end-users

Creates a new end user in your SysAid account.

Query Params

sendPasswordNotification

boolean

Choose whether to send a password notification email to the new end user.

Body Params

firstName

string

required

length ≤ 64

The user's first name. Max length is 64 characters.

lastName

string

length ≤ 64

The user's last name. Max length is 64 characters.

displayName

string

The user's display name

userEmail

string

The user's email address.

isDisabled

boolean

A diasbled user is listed in the system, but does not have access to it. Default value is 'no' (user has access).

companyId

Unique ID of the company the user works for

departmentId

Unique ID of the department the user belongs to.

locationId

Unique ID of the location associated with the user.

timezone

string

The user's timezone. By default, the timezone will be set to the one chosen for your SysAid account.

language

string

The language used by the user. The default value is English.

workPhone

string

User's work phone number/extension

mobile

string

User's mobile number.

receiveSRNotifications

boolean

Enable or disable automatic service record email notifications when a service record is updated.

enablePortalLogin

boolean

Enable the user to log into the Self-Service Portal.

managerId

integer

Unique ID of the user's manager.

supervisorLevel

string

enum

Give the user access to Self-Service Portal service records created by other users.
There are 3 levels:

Regular user: Cannot view service records that do not belong to them (default).
Department: Can view service records created by anyone in their department.
Company: Can view service records created by anyone in the company.

Allowed:

jobTitle

string | null

The user's job title.

userName

string

required

The name of the user as set by the SysAdmin.

company

groups

array of objects

groups

initialPassword

string

length ≥ 8

User's password to log into SysAid. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, and one number or special character. If left empty, SysAid will auto-generate a password.

Responses

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201End user created successfully

400The request was invalid or cannot be served

401Authentication information is missing or invalid

403The server understood the request but refuses to authorize it

409The request could not be completed due to a conflict with the current state of the resource. This typically occurs when attempting to create a duplicate resource, update a resource that has been modified by another process, or when business rules prevent the operation.