The User API provides an implementation of the business processes necessary to onboard and manage Users in a logistics network. You can use the User APIs to create Apps and software integrations that provide the ability to add and manage Users.

These topics provide an overview of the User API and cover some of the core endpoints of the API. For more information about the complete set of endpoints, see the 

User Management Service API reference documentation

To use the User API, you must have access to an active Tenant. For more information, see 

The following topics provide additional information on using the User API:

Learn how to effectively manage users in a logistics network with the powerful User API. Create apps and software integrations that effortlessly add and handle users, provided you have access to an active Tenant. Find comprehensive instructions and useful

Introduction to Users

Creating Users

Retrieve Users

User API

How To: Create a User

How to: Change State of a User

How to: Retrieve State of a User

How to: Retrieve a Designation

How to: Find the User ID of a User

How to: Update a User

User Management Service

clientID

Platform

What is OS1?

Who can benefit from OS1?

Why use OS1?

OS1 Architecture

OS1 Overview

Create an Account

Make your First API Call

Obtain your Credentials

Quick Start

Working with Callbacks

Asynchronous APIs

Custom Code

Working with GraphQL

Custom Attributes Ownership

Attribute-Based Access Control (ABAC)

Concepts

Authentication And Authorization

How to use Entities?

Entity

Integrate with Participants

Participant

Integrate with Containers

Container

Teams Management Service

Integrate with Platform Order Management

Platform Order Attributes and Lifecycle

Work Order Attributes and Lifecycle

Order Validation and Enrichment Plugins

Order Service

Jobs and Objectives

Integrate with Dispatch

Dispatch Service

Integrate with Orchestrator

Job Manager Plugin

Container Manager Plugin

Work Order Manager Plugin

Workflow Manager Plugin

Cancellation Manager Plugin

Orchestrator Service

Execution Task and Macro Payloads

Workflow Service

Getting Started

MTS API Migration Guide

MTS Geofences

MTS Tiles

MTS ETA

Speed Profiling

MTS Nearby Search

Motion Tracking System

Location Tracking

Country Data

Location Service

Use Cases and Features

Messaging

Mobile Push Notifications

Messaging and Mobile Push Notifications

Secure Data Storage

File Management Service

Scheduler Service

Search Query Format

Data Listing and Query (DLQS) Search

Publishing Webhook Events

Subscribing to Webhook Events

Egress Events for Publishers

Webhooks

State Machine

OS1 Services

Get Started with Apps and Solutions

OS1 App Developer’s Guide

Registering Your App

Update App Attributes

Add Solutions Compatibility

Submit for Review

App Version Management

Get App Details

Retrieving Production Credentials

Untitled

OS1 Solution Developer Guide

Register Your Solution

Update Solution

Submit Solution for Review

Solution Version Management

Get Solution Details

Solns

Console Banner

Common APIs Overview

Onboarding Apps and Solutions

Managing App and Solution Artifacts

Troubleshooting

Common

SDK Overview

MTS SDK

Dispatch SDK

AAA SDK

Workflow Designer SDK

Console SDK

Platform SDKs

Vehicle Management App

Container App

Sample Apps

SDKs & Sample Apps

Glossary

FAQs

Reason Codes

Error Codes

Data Types Used in OS1

App Development Guidelines

Soln Development Guidlines

Development Guidelines

Console UI Overview

Additional Resources

DispatchOne Overview

Integrate with Logistics Order

Predefined Logistics Order API Attributes

LogisticsOrder API Functionalities

LogisticsOrder API

Integrate with Facilities

Property and Facility Attributes

Creating Property and Facility

Property and Facility Lifecycle

Facility API

Integrate with Vehicles

Vehicle Attributes

Vehicle Lifecycle

Vehicle API

Logistics Framework API Dev guides

User API

Prerequisites