Skip to main content

Managing users

The Users API lets you manage users and control their access to assets, applications, and reports within a Stonal organization. It is aimed at developers who need to provision users programmatically — creating accounts, assigning permissions, and keeping user records in sync with an external directory.

How access works​

Access is governed by two complementary mechanisms: user groups, which bundle a set of permissions and can be assigned to many users at once, and permissions, which attach profiles, application scopes, and asset rights directly to individual users. Both are described in detail on the Understanding access page.

The typical journey​

  1. Authenticating users — obtain and manage access tokens for API calls on behalf of a user.
  2. Understanding access — learn how groups, profiles, application groups, and asset permissions interact.
  3. Look up groups & permissions — query the available groups and permission values in your organization.
  4. Create or update a user — provision a new user or update an existing one.
  5. Disable or delete a user — temporarily suspend a user's access (reversible) or permanently remove them.
  6. Resynchronize users — keep user records in sync after bulk changes.

Prerequisites​

info

Before using the Users API you need:

  • A valid set of API credentials (client ID and client secret).
  • A valid access token — see Get a token.
  • Your organization code.