Overview

Permissions API

Manage who can access your universes: grant an access level to users of your organization, revoke it, and find the identifiers of these users.

A universe is visible to its owner, and to the whole organization when it is shared. The Permissions API lets you go further: give a specific user of your organization access to a universe, choose what they can do with it, and revoke that access.

New to the API? Read the API Overview and Authentication first.

What you can do

SectionWhat it covers
AccessList the access grants of your universes, grant an access to a user or to your whole organization, and revoke it. See Share a universe.
UsersGet your own identifiers and list the members of your organization, to find the user you want to give access to.

Universes are the only resource you can manage access to for now: resource_type is always universe.

The Users routes are experimental and may change.

Where to start

  1. Find the identifier of the user with List Users.
  2. Give them access to a universe with Grant Access.
  3. Check who has access to the universe with List Resource Access Grants, and remove an access with Revoke Access.

Read Share a universe to understand the access levels and who can grant them.