iSpring Learn · Schema

NewUser

eLearningLMSLearning Management SystemTrainingCoursesEnrollmentsUsersGroupsReportingWebhooksSCORMCorporate Training

Properties

Name Type Description
departmentId string
fields object
password string
role string
roleId string
manageableDepartmentIds object
groupIds object
roles array
sendLoginEmail boolean
invitationMessage string
sendLoginSMS boolean
invitationSMSMessage string
View JSON Schema on GitHub

JSON Schema

NewUser.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NewUser",
  "required": [
    "departmentId",
    "fields"
  ],
  "properties": {
    "departmentId": {
      "type": "string"
    },
    "fields": {
      "$ref": "#/components/schemas/UserProfileFields"
    },
    "password": {
      "type": "string"
    },
    "role": {
      "type": "string"
    },
    "roleId": {
      "type": "string",
      "format": "uuid"
    },
    "manageableDepartmentIds": {
      "$ref": "#/components/schemas/ArrayOfIds"
    },
    "groupIds": {
      "$ref": "#/components/schemas/ArrayOfIds"
    },
    "roles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserRole"
      }
    },
    "sendLoginEmail": {
      "type": "boolean"
    },
    "invitationMessage": {
      "type": "string"
    },
    "sendLoginSMS": {
      "type": "boolean"
    },
    "invitationSMSMessage": {
      "type": "string"
    }
  },
  "type": "object",
  "xml": {
    "name": "response"
  }
}