You are browsing documentation for an outdated version.
See the latest documentation here.
Configure Workspaces in Kong Manager
Workspaces enable an organization to segment traffic so that
teams of admins sharing the same Kong cluster are only able to
interact with entities from their groups. Within a workspace,
it is possible to invite admins to a particular team and to
enforce RBAC with roles and permissions that further
delimit the types of actions and entities available to an admin.
- Authentication and RBAC are enabled
- You are logged into Kong Manager as a super admin
or a user that has
/rbac read and write access
When the first Super Admin logs in, they begin in the workspace
named default. From here, they may invite admins to manage the default or
any other workspaces.
Navigating across workspaces in Kong Manager
To navigate between workspaces from the Overview page, click on any
workspace displayed beneath the Vitals chart.
The list of workspaces may be rendered as cards or a table,
depending on preference.
Create a Workspace
This guide describes how to create workspaces in Kong
Manager. You can also use the Admin API
/workspaces/ route to create a workspace.
Log in as the Super Admin. On the Workspaces page, click the New Workspace
button to see the Create Workspace form. Name and choose a
color / icon for the new Workspace.
Each workspace name should be unique,
regardless of letter case. For example, naming one
workspace “Payments” and another one “payments” will
create two different workspaces that appear identical.
Do not name workspaces the same as these major API names (paths)
in Admin API:
Click the Create New Workspace button. Upon creation, the application will
navigate to the new Workspace’s dashboard.
Edit a workspace
In the workspace you want to edit, navigate to the Dashboard page.
Click the Settings button. This button takes you to the Edit Workspace page.
Here, you can edit the workspace avatar and avatar background color.
Click Update Workspace to save.
Delete a workspace
Wipe workspace data
To delete a workspace, all data must first be deleted from the workspace.
Choose one of the following methods.
Delete a clean workspace
If your workspace is clean, you can delete it using the Kong Manager GUI or the
Kong Admin API. If not, see the previous section to wipe workspace data.
If a role does not have permission to access entire endpoints within
a workspace, the admin assigned to that role will not be
able to see the related navigation links.
To set up access:
- Open Kong Manager.
- Click the Admins link in the
If the sidebar is collapsed, hover over
the security badge icon and click
The Admins page displays a list of current admins and
roles. Four default roles specific to the new
workspace are already visible, and new roles specific
to the workspace can be assigned from this page.
For more information about admins and roles, see
RBAC in Kong Manager.