Skip to main content
POST
Enable Driver as a User

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

customerId
string
required
driverId
string
required

Body

application/json

Represents a user in the system with their profile information and access settings

id
string

Unique identifier for the user

customerId
string

Identifier of the customer the user belongs to

userName
string

Username for authentication

externalIdentifier
string

External identifier for SSO integration

fullName
string

Full display name of the user

emailAddress
string

Email address of the user

language
object

Preferred language locale

timezone
string

User's preferred timezone

roleId
string

Identifier of the user's role

roleName
string

Display name of the user's role

groupId
string

Identifier of the user's primary group

groupName
string

Display name of the user's primary group

unitPreferences
object

User's unit preference settings

sendWelcomeEmail
boolean

Flag indicating whether to send a welcome email

secondaryGroups
object[]

List of secondary groups the user belongs to

Response

Driver successfully enabled as a user

Response DTO returned after creating a new user, containing user details and password reset token

token
string

Password reset token for setting the new user's password

expiryTime
string<date-time>

Expiration time for the password reset token

user
object

Represents a user in the system with their profile information and access settings