Skip to main content

ListOfUsers

elements object[]required
  • Array [
    • idUserId (string)

    ID of the user

    Possible values: Value must match regular expression ^((UR)|(URH))_[0-9a-zA-Z]{11,15}$

    divisionIdDivisionId (string)nullable

    ID of the division

    Possible values: Value must match regular expression ^DV_[0-9a-zA-Z]{11,15}$

    usernameUserString (string)

    Possible values: <= 65536 characters

    firstNameUserString (string)

    Possible values: <= 65536 characters

    lastNameUserString (string)

    Possible values: <= 65536 characters

    userTypeUserType (string)

    User type of the new user

    Possible values: Value must match regular expression ^UT_[0-9a-zA-Z]{5,15}$

    emailstring<email>

    Email for the new user - must be a valid email (Can be the same as the username.)

    accountStatus object
    oneOf
    UserAccountStatusEnum (string)

    Possible values: [active, disabled, notVerified]

  • ]
    • nextPagestringnullablerequired
    ListOfUsers
    {
      "elements": [
        {
          "id": "string",
          "divisionId": "string",
          "username": "string",
          "firstName": "string",
          "lastName": "string",
          "userType": "string",
          "email": "user@example.com",
          "accountStatus": "active"
        }
      ],
      "nextPage": "string"
    }