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 Email from '/snippets/administration/email.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, and PATCH requests at https://‍{apiEndpoint}/users.

New customers

You can provision a user by specifying their email address and the API services to assign them access permission:

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

{
  "email": "user@example.com",
  "token": "a1-0dF6qKHYD7SNU5kAtjOmwHpH3iFgpylA",
  "services": ["search", "browser"]
}

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
services	✅	An array of at least one of the API services to grant the account access to; the possible service values are search and browser

Here are the response keys and values:

Key	Value
email	The email address of the new user account as recorded by the API
token	The bearer token issued by the API for authentication
services	An array of the API services that the account has been granted access to, search and browser being the possible values