OpsGenie · Schema

CreateUserRequest

AlertsIncident ManagementMonitoringOn-CallOperations

Properties

Name Type Description
username string Email address of the user, used as the login identifier.
fullName string Full name of the user.
role object Role assigned to the user.
skypeUsername string Skype username of the user.
timeZone string Timezone of the user, e.g. America/New_York.
locale string Locale of the user, e.g. en_US.
userAddress object Physical address of the user.
tags array Tags associated with the user.
details object Custom key-value details for the user.
invitationDisabled boolean If true, the user will not receive an invitation email.
View JSON Schema on GitHub

JSON Schema

opsgenie-createuserrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateUserRequest",
  "title": "CreateUserRequest",
  "type": "object",
  "required": [
    "username",
    "fullName",
    "role"
  ],
  "properties": {
    "username": {
      "type": "string",
      "format": "email",
      "description": "Email address of the user, used as the login identifier."
    },
    "fullName": {
      "type": "string",
      "description": "Full name of the user."
    },
    "role": {
      "type": "object",
      "description": "Role assigned to the user.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Role ID."
        },
        "name": {
          "type": "string",
          "enum": [
            "Owner",
            "Admin",
            "User",
            "Observer",
            "Stakeholder"
          ],
          "description": "Role name."
        }
      }
    },
    "skypeUsername": {
      "type": "string",
      "description": "Skype username of the user."
    },
    "timeZone": {
      "type": "string",
      "description": "Timezone of the user, e.g. America/New_York."
    },
    "locale": {
      "type": "string",
      "description": "Locale of the user, e.g. en_US."
    },
    "userAddress": {
      "type": "object",
      "description": "Physical address of the user.",
      "properties": {
        "country": {
          "type": "string",
          "description": "Country of the user."
        },
        "state": {
          "type": "string",
          "description": "State or province of the user."
        },
        "city": {
          "type": "string",
          "description": "City of the user."
        },
        "line": {
          "type": "string",
          "description": "Street address line."
        },
        "zipCode": {
          "type": "string",
          "description": "ZIP or postal code."
        }
      }
    },
    "tags": {
      "type": "array",
      "description": "Tags associated with the user.",
      "items": {
        "type": "string"
      }
    },
    "details": {
      "type": "object",
      "description": "Custom key-value details for the user.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "invitationDisabled": {
      "type": "boolean",
      "description": "If true, the user will not receive an invitation email."
    }
  }
}