Organization
Access groups
Access groups put dashboard users into named groups that scope which products each user sees in the dashboard. Access groups are an enterprise feature that your Apiable plan must allow.
Access groups put your dashboard users into named groups. When the feature is enabled on your plan, a group scopes which products its members see in the dashboard. You manage them on the Groups page, under the Organization group in settings.
What is an access group?
An access group is a named set of dashboard users. When enterprise groups are enabled on your plan, each group scopes the products its members see, so a user in a group sees only the products tied to that group instead of every product in the organization.
A group has a name and a list of users. Products are tagged with the groups they belong to, and the dashboard matches a user's active group against those tags.
How do access groups differ from approval groups?
Access groups scope which products a dashboard user sees. Approval groups decide who reviews and approves consumer requests. They are separate pages under the Organization group and do different jobs.
| Access groups | Approval groups | |
|---|---|---|
| Page | Groups | Approval Groups |
| What it controls | Which products a dashboard user sees. | Who reviews and approves consumer requests. |
| Who it applies to | Your dashboard users. | Your dashboard users, as reviewers. |
| Gating | Enterprise feature on your plan. | Available when your plan allows approval groups. |
Approval groups are covered in Approval groups.
How do you create an access group?
Open Groups under the Organization settings group, select Add Group, give the group a name, add the dashboard users who belong to it, and save. You need permission to administer groups.
- In settings, open the Organization group and select Groups.
- Select + Add Group.
- Enter a Group Name.
- Add the dashboard users who belong to the group from the users table. You are added by default as the group's creator.
- Save the group. It appears in the Groups list, where you can search, edit, or delete it later.
Do access groups control what your API consumers see?
No. Access groups scope products for your dashboard users, not for the developers who sign in to your API Portal. What a consumer can see and call is governed by their subscriptions, the plans they are on, and scopes.
For consumer-facing access, see Access control, which covers scopes and how they govern what consumers can call. For who the consumers are, see Consumers.
Troubleshooting
| What you see | What to do |
|---|---|
| The Add Group and Edit buttons are disabled, with a banner about your role | You need permission to administer groups. Ask an Organisation Admin or the Organisation Owner to grant it or to make the change. |
| Groups exist, but dashboard users still see every product | The enterprise groups feature is not enabled on your plan, so product scoping is inactive. Talk to Apiable to enable it. |
| A user sees no products after you add them to a group | Make sure the products that user needs are tied to that group. A group only shows the products tagged to it. |