Sign in

v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB
Agents

Create a New Agent

Create a new IT Agent user in your SysAid account. This person will be able to access and manage service records. For aditional permissions, see the Edit Administrator article.

post/agents

Query parameters

sendPasswordNotificationboolean

Choose whether to send a password notification email to the new Agent.

Request body

firstNamestring required

The user's first name.

lastNamestring

The user's last name.

displayNamestring

The user's display name

userEmailstring

The user's email address.

isDisabledboolean

Indicates if the user is disabled

companyIdnumber nullable

Unique ID of the company the user works for

departmentIdnumber nullable

Unique ID of the department the user belongs to

locationIdnumber nullable

Unique ID of the location associated with the user

timezonestring

The time zone of the user

languagestring

The language used by the user (default is "en")

workPhonestring

User's work phone number/extension

mobilestring

User's mobile number

receiveSRNotificationsboolean

Enable or disable automatic SR email notifications

enablePortalLoginboolean

Enable login to the End User Portal

managerIdinteger
supervisorLevel'none' | 'department' | 'company'

Enable the user to have access to other's ssp tickets

jobTitlestring nullable

User's job title

permissionType'user' | 'group'

Defines whether the Agent's permissions should be inherited from a group or set directly for this user.

userNamestring required

The name of the user as provided by the SysAdmin

initialPasswordstring

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.

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "displayName": "John Doe",
  "userEmail": "johndoe@sysaid.com",
  "companyId": 342,
  "departmentId": 342,
  "locationId": 342,
  "timezone": "Asia/Jerusalem",
  "language": "en",
  "managerId": 234,
  "supervisorLevel": "department",
  "jobTitle": "Engineering Director",
  "permissionType": "user",
  "userName": "johndoe",
  "company": {
    "name": "Alpha",
    "address": "123 Main Street",
    "address2": "Apt. 4B",
    "city": "Washington",
    "state": "Virginia",
    "country": "USA",
    "fax": "555-555-1234",
    "notes": "Some notes about the company.",
    "emailAccount": "company@mail.com",
    "expirationDate": "30-12-2120",
    "agreementId": 5,
    "agreementStartDate": "22-10-2025",
    "agreementEndDate": "01-08-2024",
    "customFields": {
      "company_cust_int_field": 5
    },
    "version": 5,
    "id": 1
  },
  "groups": [
    {
      "name": "IT Support",
      "supportLevel": 3,
      "companyId": 1001,
      "email": "support@example.com",
      "receiveAutomaticSrEmailNotifications": true,
      "canBeAssignedToServiceRecord": true,
      "id": 123
    }
  ]
}

Response

Agent created successfully

successboolean
userIdinteger

The user's unique ID within SysAid

Example response

{
  "success": true,
  "userId": 342
}