The Brellium API dashboard at platform.brellium.dev is where your team creates and manages API keys and webhooks for your organization. An administrator turns on access for each person in Brellium, from the User Directory page. This article covers what the administrator needs and the steps to grant access.
đ API documentation: To learn how to use the Brellium API (authentication, the sandbox, endpoints and examples), go to docs.brellium.dev.
What you need
To use the API dashboard, you need API platform access in your organization. An administrator turns it on for you, as shown below. If you don't have it, the dashboard shows "You don't have API platform access in this organization."
To grant API platform access to someone else, you need these permissions in your permission set:
Section | Permission | Why you need it |
User Directory | can view page | Opens the User Directory page, where you grant access. |
People | can view page | Required before you can turn on can invite users. |
People | can invite users | Shows the API platform access switch and lets you change it. |
Give an administrator the permissions
If the person who will grant access does not have the permissions above, add them to that person's permission set. You need access to the Permissions page to do this.
In the sidebar, open Control Center > Permissions.
Find the permission set the administrator uses, and click the edit button in the Actions column.
Under People, turn on can view page and can invite users.
Under User Directory, turn on can view page.
Click Save Permission Set.
The Update Permission Set window, with can invite users and User Directory > can view page highlighted.
Turn on API platform access for a person
In the sidebar, open Control Center > User Directory.
Find the person. You can search by name or email.
Click the person's row. The User Profile panel opens on the Attributes tab.
Turn on the API platform access switch.
The User Directory page lists everyone in your organization.
The API platform access switch is at the bottom of the Attributes tab.
A message confirms the change. The person can now sign in at platform.brellium.dev with their Brellium account.
To remove access, turn the switch off.
Good to know
You can turn on access for someone who has not signed in to Brellium yet. The panel shows "Pending: this user hasn't signed in yet." Access starts when they first sign in with that email address.
If your organization syncs users from an identity provider and access comes from that sync, the panel says so. Turning it off in Brellium does not last: the next sync turns it back on, so make the change in your identity provider.
If the panel says "Also granted by group âŚ", the person still has access after you turn the switch off. That group is managed outside this page.
Access is per organization. If a person belongs to more than one Brellium organization, grant access in each one where they need it.
If you don't see the switch, your permission set does not include People > can invite users. Ask an administrator to add it.
Next: use the API
After you have access, create an API key in the dashboard. Then follow the Brellium API documentation at docs.brellium.dev to make your first request.