CreateUserBody

Fields

Field	Type	Required	Description and constraints
username	string	Yes	minimum length 3. maximum length 64. pattern ^[A-Za-z0-9][A-Za-z0-9._-]*$
displayName	string	Yes	minimum length 1. maximum length 128
email	string or null	No
mfaRequired	boolean or null	No	Require MFA for this administrator or security manager. New accounts default to false.
role	Role	Yes
organizationId	string (uuid) or null	No

Additional properties are rejected by this schema.

JSON schema

{
  "properties": {
    "username": {
      "type": "string",
      "maxLength": 64,
      "minLength": 3,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$",
      "title": "Username"
    },
    "displayName": {
      "type": "string",
      "maxLength": 128,
      "minLength": 1,
      "title": "Displayname"
    },
    "email": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 254
        },
        {
          "type": "null"
        }
      ],
      "title": "Email"
    },
    "mfaRequired": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Mfarequired",
      "description": "Require MFA for this administrator or security manager. New accounts default to false."
    },
    "role": {
      "$ref": "#/components/schemas/Role"
    },
    "organizationId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Organizationid"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "username",
    "displayName",
    "role"
  ],
  "title": "CreateUserBody"
}

Related models

• Role