Droplit.io Portal
API Reference

Users

Your application’s end-users

Introduction

The droplit.io Users API provides a way to register your application’s end-users. Your end-users can then make API calls directly to droplit.io.

The Users API does not provide user credential management and is not an identity provider. Currently, you the developer must deploy your own authentication server with the only requirement that it authenticate and register your end-users to the Users API. This usually requires integrating or developing an identity provider. Your server must register your end-users by providing the Users API with a key or token that uniquely identifies a user.

📘

Future server-less operation

In the future we will provide an option to use third party identity providers for server-less products.

User access

Users can currently have only All or Nothing access to environments. This means that if a user is granted access to an environment, that user can make requests directly to environment and child resource endpoints. This includes API access to:

  • Environments
  • Devices
  • Zones
  • Service Classes (Read Only)
  • Account

Calling the Users API from your Application

Your application can register a user, update user information, and access and create a userToken all from a single endpoint. This allows your sever application to not have knowledge of an existing user.

Registering a user

Your server registers a user by providing a unique ID (key or token) that identifies a user. This ID is usually provided by your identity provider once a user is sucessfully authenticated.

In the same request, you can specify:

  • account metadata
  • environment access
  • if a user token should be generated
  • user email address (for your identification only)

Logging in a user

A user is logged in when you generate a token.

For logging off a user, see Log a user out of the Droplit system.

Updating user information or user access

You can update user information and user access by providing a unique ID for a user that is already registered and do not specify to create a token.

Metadata

Users are capable of storing custom metadata within their records. Metadata is nonessential information, such as occupational details, that enhances the users' ability to be organized and processed.