API Administrator rules

When the API Administrator feature is active on your workspace, you will see new admin rules options in the Settings.

If you want to use the API Administrator feature but it is not available on your workspace yet, please contact our support or an account manager.

Master Administration rule

This is the quorum of human administrators (it cannot include an API Administrator). It works the same way whether the API Administrator feature is active or not.

For more information, please look at the "Edit the admin rule" article.

API Admin rules

These rules are made to grant rights to API Administrators so they can execute specific tasks.

In order to add an API Administrator here, please follow these steps:

  1. Invite an API Administrator on your workspace.

  2. Register the API Administrator thanks to their keys.

Please follow the Register a new API User guide to complete these steps.

Once this is done, a human administrator can then edit an API Admin rule to add the API Administrator to it.

Create account with policy

The API Administrator will be able to create accounts that using a policy (a set of rules that is common to multiple accounts). They will be able to make two types of requests:

  • Create account with policy

  • Approve a request to create an account with policy

See the "Policies" section to understand how to create a policy.

See the "Create an account" API guide to understand how to create accounts with a policy via API.

When an API Admin rule is updated, the change must be validated by the Master Administration quorum.

Last updated