admin.mdx

title	Administration
icon	users
iconType	light
description	Create and manage user accounts.

import { companyName, apiEndpoint } from '/snippets/whitelabel/config.mdx'; import { Throttling } from '/snippets/whitelabel/throttling.mdx'; import Authentication from '/snippets/whitelabel/authentication.mdx'; import Creation from '/snippets/administration/creation.mdx'; import Deactivation from '/snippets/administration/deactivation.mdx';

See also the API reference for more detail.

Usage

{companyName}'s administration service lets you support your whitelabel customers. The service has a RESTful interface that accepts GET, POST, PATCH, and DELETE requests at https://‍{apiEndpoint}/users.

New customers

You can provision a user by specifying their email address and, optionally, the API credits to preload their account with:

The user's secret API token will be returned, along with their normalized email address and any credits:

{
  "email": "user@example.com",
  "token": "a1-0dF6qKHYD7SNU5kAtjOmwHpH3iFgpylA",
  "credits": 1000
}

Here are the provisioning request keys and values:

Key	Required	Value
email	✅	The email address of the user to create an account for; the address is case insensitive and can be up to 255 characters, regardless of character encoding
credits		The number of API credits to preload the account with

Here are the response keys and values:

Key	Value
email	The email address of the new account as recorded by the API
token	The bearer token issued to the account for authentication
credits	The number of initial credits granted to the account

Customer deactivation

Disable an account with the associated email address:

The API will confirm that account no longer has credits:

{
  "email": "user@example.com",
  "credits": 0
}

This is the deprovisioning request key and value:

Key	Required	Value
email	✅	The (case-insensitive) email address of the user whose account to deactivate

These are the response keys and values:

Key	Value
email	The email address of the deactivated account
credits	The zeroed-out credits as confirmed by the API