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 Getting Started.

The User API requires that specific objects are available before you can use some of the API endpoints. Specifically, the UMS API defines endpoints that take the following objects in the request bodies:

  • Permissions
  • Resources
  • Roles

The default Native Apps define the preceding required objects for you.

If you are creating a new user in a new Organization, you will need to perform the following tasks:

  • Create the Organization
  • Create designations within the Organization
  • Create the User and assign them to the Organization

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

Did this page help you?