{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clarivate/main/json-schema/clarivate-user-list-schema.json",
  "title": "UserList",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/clarivate-administration-user-data-api-openapi.yml#/components/schemas/UserList",
  "required": [
    "count",
    "data",
    "nrRecordsAll",
    "nrRecordsFound",
    "startRecord"
  ],
  "type": "object",
  "properties": {
    "startRecord": {
      "type": "integer",
      "description": "only for GET response"
    },
    "count": {
      "type": "integer",
      "description": "only for GET response"
    },
    "nrRecordsAll": {
      "type": "integer",
      "description": "only for GET response"
    },
    "nrRecordsFound": {
      "type": "integer",
      "description": "only for GET response"
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/User"
      }
    }
  },
  "$defs": {
    "User": {
      "type": "object",
      "properties": {
        "userName": {
          "type": "string",
          "maxLength": 255,
          "description": "It is required only for POST create user."
        },
        "firstName": {
          "type": "string",
          "maxLength": 255
        },
        "lastName": {
          "type": "string",
          "maxLength": 255
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "For internal users, a notification with password will be sent to the email."
        },
        "firstLogin": {
          "type": "boolean"
        },
        "preferredLanguage": {
          "type": "string"
        },
        "active": {
          "type": "boolean"
        },
        "acceptedTC": {
          "type": "boolean"
        },
        "userType": {
          "type": "string",
          "enum": [
            "INTERNAL",
            "EXTERNAL"
          ],
          "description": "INTERNAL users are the users which directly login in Converis. External users are the users that login through SSO, e.g. Shibboleth"
        },
        "lastLogin": {
          "type": "string",
          "description": "The date-time notation as defined by RFC 3339, section 5.6, e.g. \"2017-07-21T17:32:28\"",
          "format": "date-time"
        },
        "roles": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/UserRole"
          }
        }
      }
    },
    "UserRole": {
      "properties": {
        "roleName": {
          "type": "string",
          "description": "Converis user role - Please carefully check your Converis configuration. Do not provide names of the specific language. Special role names for admins can be used: Config Admin or Super Admin. For special roles no entryPointId is needed."
        },
        "entryPointId": {
          "type": "integer",
          "format": "int64",
          "description": "User entry point"
        },
        "entryPointDataUrl": {
          "type": "string",
          "description": "The entrypoint data url - only by GET Request"
        },
        "entryPointDefinitionUrl": {
          "type": "string",
          "description": "Entry point definition url - only by GET Request"
        }
      }
    }
  }
}