Skip to main content

UserModel

User info.

Breaking Changes​

No breaking changes.

Examples​

Fill this template out with real values.

{
"dispatcher_id": "Integer",
"id": "String",
"roles": "array[role]",
"third_party_hauler_id": "String",
"uid": "String",
"username": "String"
}

Fields​

dispatcher_id Integer, Required

Resource identifier.

id String, Required

User identifier.

roles Array[role], Required

role String

User role.

  • Valid role (one of Public, ClientCustomer, CrmUser, Admin, ThirdPartyDispatcher, Driver, ThirdPartyDriver, Dispatcher).

third_party_hauler_id String, Required

Third party hauler identifier.

  • Valid UUID.

uid String, Required

Identity UUID.

  • Valid UUID.

username String, Required

Username.

  • No longer than 64 characters.
  • At least 1 characters long.