Sovrain
  1. Documentation
  2. Your organization

How-to guide

Review API access

See every script and tool that admins have allowed to use the Admin API, check what each one called, and revoke access.

This guide checks which scripts and tools can change your organization through the Admin API, and stops the ones that should not. Each entry is a grant: an admin approved a request from a tool, with a set of scopes, and the tool acts as that admin.

Only admins can approve API access, and a tool can never do more than the admin who approved it; see Roles.

List the grants

  1. On your home page, under Administration, select Open admin, then select API access in the admin menu.

Each row shows:

ColumnShows
OwnerThe admin who approved the grant; the tool acts as this person
ClientThe tool, for example Command-line access
ScopesWhat the tool may do, for example users:read or apps:write
ApprovedWhen the admin approved it
Last usedWhen the tool last called the API, or never
EndsWhen the grant runs out unless the tool renews it first
Requested fromThe IP address and program that asked for it

Ended grants show Expired or Revoked and stay listed for 7 days.

See what a tool did

  1. Select Last 24 h on the row.
  2. Read the calls: Time, Call, Scope, Status and From.

Scopes the tool used are highlighted among the granted ones. A tool that holds scopes it never uses, for example apps:write or users:delete, is a good candidate for a new grant with fewer scopes.

Revoke a grant

Warning: Revoke acts at once, without asking you to confirm.

Select Revoke on the row. The tool is stopped at its next call. To use the API again, someone has to approve a new request.

When grants end on their own

A grant also ends without anyone revoking it: when the tool stops renewing it, at its hard limit, and when its admin is suspended, loses admin rights, changes password or has two-step sign-in reset. The full list is in Admin API.