Creating and managing custom scopes

bhavik.patel@oneadvanced.com Updated by bhavik.patel@oneadvanced.com

Customer Admins can now create custom scopes and assign them to API clients. Scopes help define what level of access an application (API client) has when requesting tokens. By using custom scopes, you can tailor access to match your organisation’s needs.

What is a Scope?

A scope is a permission or access boundary that defines what an API client can do. For example, one scope might allow reading data, while another allows writing data.

Custom scopes let you create your own keys, specific to your organisation’s requirements.

Creating a custom scope

  1. Log in as a Customer Admin.
  2. Go to the Apps > Integration > API Client
  3. On API Client screen, you may find a tab called 'Scope'

To Create a new scope, click on 'Add Scope' button

  1. Name: A unique identifier for the scope (e.g. reporting.read or users.manage).
  2. Description: A short explanation of what this scope allows (e.g., Grants read-only access to reports).
  3. Click Add.

Your scope is now created and available for assignment

Assigning a custom scope to an API client

  1. Navigate to the API Clients section.
  2. Select the API client you want to configure
  3. Under Actions columns, select 'Assign scope'
  1. Select scope to assign to API client and click Save
You can assign a maximum of 10 scopes to each API clientRemoving an Assigned Scope

Removing an assigned scope

If you need to remove a scope already assigned to an API client:

  1. Navigate to the Assign Scope screen for that client.
  2. Click the cross (✖) icon provided beside the scope.
  3. Click on save.

The scope will be unassigned and no longer available to that API client.

Coming Soon

The Edit and Delete options for scopes are currently visible in the UI but not yet functional.

Clicking them will not make any changes. Full support for editing and deleting scopes will be released in an upcoming update.

How did we do?

Adding custom content to welcome emails

Add Login URLs to your Organisation

Contact