create a user - RoscoLive API v1.0

Create a new user for a company. After user is created, an email will be sent to the user's inbox they will then use to verify their email address. Once verified, they will be taken to RoscoLive to create a password for their account to complete the new account setup.

After a new user role is created, they must first verify their account through the email before they can log into RoscoLive. If they do not, an error will appear when attempting to login.

User Roles	Description
Partner	An account with access to the Partner Portal used to manage companies, devices, and users within the Partner Company.
Custom Partner	A role with the same access scope as the Partner role, except the permissions can be customized to allow more flexibility.
Fleet Manager	The highest user role within a company, can add users, manage all devices within company, create/manage groups, and view all events.
Group Manager	A role that manages 1 or more company groups that they are assigned to. Can create new users, can access/manage devices and users within their assigned groups.
User	The lowest role with access in a company. Needs to be assigned access to devices/groups before allowed to take actions.
Custom User	A role with the same access scope as the Fleet Manager role, except permissions can be customized to allow more flexibility.
Notification Recipient	A special type of role with no access to RoscoLive, but can be subscribed to notifications so they may receive them in their email.

Request

Path Params

new_user_email

string

required

Cookie Params

Set-Cookie

array[string]

optional

Session cookies returned from login response. Include in cookies for all API calls within user session.

Example:

["AWSALB=","AWSALBCORS="]

Body Params multipart/form-data

company_name

string

required

Name of company in RoscoLive to create new user in

password

string

required

New password for the user. Note that the user will make their own password after verification, so this password is only needed to satisfy the API requirement.

last_name

string

required

Last name of user

first_name

string

required

First or preferred name of the user

roles

enum<string>

required

The role type to assign to this new user.

Allowed values:

fleet_managergroup_managerend_usercustom_usernotification_recipient

phone_number

string

required

Work phone number for user

>= 10 characters<= 10 characters

Example:

5558675309

Match pattern:

/d{10}

partner_name

string

required

Partner company name

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201valid create a user

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

response

object

required

Contains response data

user

object (User schema)

required

result

enum<string>

required

"OK" if request successful, otherwise "Failed"

Allowed values:

OKFailed

Example

{
  "meta": {
    "code": 201
  },
  "response": {
    "user": {
      "active": true,
      "aggr_notific_interval": null,
      "alert_camera_errors": null,
      "alert_camera_failure": false,
      "alert_critical_gsensor": false,
      "alert_dv_camera_failure": false,
      "alert_high_temperature": true,
      "alert_idling": null,
      "alert_inactive_vehicles": false,
      "alert_inactive_vehicles_time": null,
      "alert_no_sd_card": false,
      "alert_sd_error": false,
      "alert_sensor": false,
      "alert_speed": false,
      "audit_notification": null,
      "company_audit_log": null,
      "company_data": {
        "data_limit": 3,
        "live_active": true,
        "storage_active": true,
        "trace_active": true
      },
      "company_driver_recognition": "cardreader",
      "company_id": 2,
      "company_name": "Rosco Vision",
      "company_reformat_reminder": 5,
      "company_token": "12345678",
      "company_type": "CUSTOMER",
      "confirmed_at": false,
      "created_timestamp": "Fri, 22 Nov 2024 14:54:44 GMT",
      "daily_new_cameras_notifs": null,
      "daily_recording_status_notifs": true,
      "data_overage_notification": null,
      "data_overage_notification_vehicle_limit": "10",
      "data_pool_usage": false,
      "data_pool_usage_frequency": "weekly",
      "data_pool_warning": false,
      "data_pool_warning_threshold": "75",
      "data_usage_notification": true,
      "data_usage_notification_vehicle_limit": "100",
      "device_high_data_usage": false,
      "device_high_data_usage_threshold_data_pool": 30,
      "email": "bihowi7774@kimasoft.com",
      "eula_was_viewed": false,
      "event_breakdown": null,
      "first_name": "Lacuna",
      "flood_notification": null,
      "groups": [],
      "harshaccel": false,
      "harshbraking": false,
      "has_registered_sms": null,
      "high_speeding": false,
      "id": 6873,
      "installer_company_name": null,
      "is_fake": false,
      "last_login": null,
      "last_name": "Coil",
      "low_speeding": false,
      "mecp_cert": false,
      "moderate_speeding": false,
      "partner_company_id": 3,
      "partner_company_name": "Rosco Vision Partner",
      "phone_number": "5558675309",
      "recent_activity": null,
      "recording_status_notifs": null,
      "reformat_last_notifs": "Fri, 22 Nov 2024 14:54:45 GMT",
      "reformat_reminder": null,
      "release_viewed": null,
      "roles": [
        "fleet_manager"
      ],
      "rosco_product_owned": null,
      "settings": {
        "inputsensor1_active": false,
        "inputsensor1_description": null,
        "inputsensor1_name": null,
        "inputsensor2_active": false,
        "inputsensor2_description": null,
        "inputsensor2_name": null,
        "inputsensor3_active": false,
        "inputsensor3_description": null,
        "inputsensor3_name": null,
        "inputsensor4_active": false,
        "inputsensor4_description": null,
        "inputsensor4_name": null,
        "latitude": null,
        "longitude": null,
        "time_zone": null,
        "zoom_level": 5
      },
      "severe_speeding": false,
      "speed_unit": "mph",
      "status": "used",
      "unidentified_drivers": null,
      "work_submission_report": null
    }
  },
  "result": "OK"
}

🟠404create an existing user

🟠404create a user with none existing company param

🟠401Login Required