ilert · Schema

User

Incident ManagementOn-Call AlertingAlert RoutingEscalation PoliciesOn-Call SchedulesStatus PagesHeartbeat MonitoringEvent ManagementDevOpsSREIT Operations

Properties

Name Type Description
id integer
firstName string
lastName string
email string
timezone object
position string
department string
avatarUrl string
language string
region string
role object
shiftColor string Optional hex-color code for the user's shifts in schedules calendars
mutedUntil string Date in ISO-8601
createdAt string Date in ISO-8601
updatedAt string Date in ISO-8601
View JSON Schema on GitHub

JSON Schema

user.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.ilert.com/schemas/User",
  "title": "User",
  "required": [
    "email",
    "firstName",
    "lastName"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "timezone": {
      "$ref": "#/components/schemas/TimeZone"
    },
    "position": {
      "type": "string"
    },
    "department": {
      "type": "string"
    },
    "avatarUrl": {
      "type": "string",
      "readOnly": true
    },
    "language": {
      "type": "string",
      "enum": [
        "de",
        "en"
      ]
    },
    "region": {
      "type": "string",
      "enum": [
        "DE",
        "GB",
        "CH",
        "CN",
        "IN",
        "US",
        "FR",
        "ES",
        "CA",
        "IE"
      ]
    },
    "role": {
      "$ref": "#/components/schemas/Role"
    },
    "shiftColor": {
      "type": "string",
      "description": "Optional hex-color code for the user's shifts in schedules calendars"
    },
    "mutedUntil": {
      "type": "string",
      "description": "Date in ISO-8601",
      "format": "date-time"
    },
    "createdAt": {
      "type": "string",
      "description": "Date in ISO-8601",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "description": "Date in ISO-8601",
      "format": "date-time"
    }
  }
}