Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.2.x (latest)
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Older Enterprise versions (2.1-2.5)
  • Older OSS versions (2.1-2.5)
  • Archive (pre-2.1)
    • Overview of Kong Gateway
      • Version Support Policy
      • Supported Installation Options
      • Supported Linux Distributions
    • Stability
    • Release Notes
      • Services
        • Overview
        • Configure Routes with Expressions
      • Upstreams
      • Plugins
      • Routing Traffic
      • Load Balancing
      • Health Checks and Circuit Breakers
      • Kong Performance Testing
    • Glossary
    • Get Kong
    • Services and Routes
    • Rate Limiting
    • Proxy Caching
    • Key Authentication
    • Load-Balancing
      • Overview
        • Overview
        • Deploy Kong Gateway in Hybrid mode
      • DB-less Deployment
      • Traditional
      • Overview
        • Helm
        • OpenShift with Helm
        • kubectl apply
        • Kubernetes Deployment Options
        • Using docker run
        • Build your own Docker images
        • Amazon Linux
        • Debian
        • Red Hat
        • Ubuntu
      • Running Kong as a non-root user
      • Securing the Admin API
      • Using systemd
      • Start Kong Gateway Securely
      • Programatically Creating Admins
      • Enabling RBAC
      • Overview
      • Download your License
      • Deploy Enterprise License
      • Using the License API
      • Monitor Licenses Usage
      • Default Ports
      • DNS Considerations
      • Network and Firewall
      • CP/DP Communication through a Forward Proxy
    • Kong Configuration File
    • Environment Variables
    • Serving a Website and APIs from Kong
      • Overview
      • Prometheus
      • StatsD
      • Datadog
      • Overview
      • Writing a Custom Trace Exporter
      • Tracing API Reference
    • Resource Sizing Guidelines
    • Security Update Process
    • Blue-Green Deployments
    • Canary Deployments
    • Clustering Reference
      • Log Reference
      • Dynamic log level updates
      • Customize Gateway Logs
      • Upgrade Kong Gateway 3.1.x
      • Migrate from OSS to Enterprise
    • Overview
      • Overview
      • Metrics
      • Analytics with InfluxDB
      • Analytics with Prometheus
      • Estimate Analytics Storage in PostgreSQL
      • Overview
      • Getting Started
      • Advanced Usage
        • Overview
        • Environment Variables
        • AWS Secrets Manager
        • Google Secrets Manager
        • Hashicorp Vault
        • Securing the Database with AWS Secrets Manager
      • Reference Format
      • Overview
      • Get Started with Dynamic Plugin Ordering
      • Overview
      • Enable the Dev Portal
      • Publish an OpenAPI Spec
      • Structure and File Types
      • Themes Files
      • Working with Templates
      • Using the Editor
        • Basic Auth
        • Key Auth
        • OIDC
        • Sessions
        • Adding Custom Registration Fields
        • Manage Developers
        • Developer Roles and Content Permissions
        • Authorization Provider Strategy
        • Enable Application Registration
        • Enable Key Authentication for Application Registration
          • External OAuth2 Support
          • Set up Okta and Kong for External Oauth
          • Set up Azure AD and Kong for External Authentication
        • Manage Applications
        • Theme Editing
        • Migrating Templates Between Workspaces
        • Markdown Rendering Module
        • Customizing Portal Emails
        • Adding and Using JavaScript Assets
        • Single Page App in Dev Portal
        • Alternate OpenAPI Renderer
      • SMTP
      • Workspaces
      • Helpers CLI
      • Portal API Documentation
    • Audit Logging
    • Keyring and Data Encryption
    • Workspaces
    • Consumer Groups
    • Event Hooks
    • FIPS 140-2
    • Overview
    • Enable Kong Manager
      • Services and Routes
      • Rate Limiting
      • Proxy Caching
      • Authentication with Consumers
      • Load Balancing
      • Overview
      • Create a Super Admin
      • Workspaces and Teams
      • Reset Passwords and RBAC Tokens
      • Basic Auth
        • Configure LDAP
        • LDAP Service Directory Mapping
        • Configure OIDC
        • OIDC Authenticated Group Mapping
      • Sessions
        • Overview
        • Enable RBAC
        • Add a Role and Permissions
        • Create a User
        • Create an Admin
    • Networking Configuration
    • Workspaces
    • Create Consumer Groups
    • Sending Email
    • Overview
    • File Structure
    • Implementing Custom Logic
    • Plugin Configuration
    • Accessing the Data Store
    • Storing Custom Entities
    • Caching Custom Entities
    • Extending the Admin API
    • Writing Tests
    • (un)Installing your Plugin
      • Overview
      • kong.client
      • kong.client.tls
      • kong.cluster
      • kong.ctx
      • kong.ip
      • kong.jwe
      • kong.log
      • kong.nginx
      • kong.node
      • kong.request
      • kong.response
      • kong.router
      • kong.service
      • kong.service.request
      • kong.service.response
      • kong.table
      • kong.tracing
      • kong.vault
      • kong.websocket.client
      • kong.websocket.upstream
      • Go
      • Javascript
      • Python
      • Running Plugins in Containers
      • External Plugin Performance
    • Overview
        • Overview
        • OpenID Connect with Curity
        • OpenID Connect with Azure AD
        • OpenID Connect with Google
        • OpenID Connect with Okta
        • OpenID Connect with Auth0
        • OpenID Connect with Cognito
      • Authentication Reference
      • Allow Multiple Authentication Plugins
    • Rate Limiting Plugin
      • Add a Body Value
    • GraphQL
      • gRPC Plugins
      • Configure a gRPC service
    • Overview
    • Information Routes
    • Health Routes
    • Tags
    • Debug Routes
    • Services
    • Routes
    • Consumers
    • Plugins
    • Certificates
    • CA Certificates
    • SNIs
    • Upstreams
    • Targets
    • Vaults
    • Keys
    • Licenses
    • Workspaces
    • RBAC
    • Admins
    • Developers
    • Consumer Groups
    • Event Hooks
    • Keyring and Data Encryption
    • Audit Logs
    • kong.conf
    • Injecting Nginx Directives
    • CLI
    • File Permissions Reference
    • Key Management
    • Performance Testing Framework
    • Router Expressions Language
    • FAQ

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Prerequisites
  • Default workspace
  • Navigating across workspaces in Kong Manager
  • Create a Workspace
  • Edit a workspace
  • Delete a workspace
    • Wipe workspace data
    • Delete a clean workspace
  • Workspace Access
Kong Gateway
3.1.x
  • Home
  • Kong Gateway
  • Kong Manager
  • Configure Workspaces in Kong Manager
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.

Prerequisites

  • Authentication and RBAC are enabled
  • You are logged into Kong Manager as a super admin or a user that has /admins and /rbac read and write access

Default workspace

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.

  1. 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:

     • Admins
     • Certificates
     • Consumers
     • Plugins
     • Portal
     • Routes
     • Services
     • SNIs
     • Upstreams
     • Vitals
    
  2. Click the Create New Workspace button. Upon creation, the application will navigate to the new Workspace’s dashboard.

Edit a workspace

  1. In the workspace you want to edit, navigate to the Dashboard page.

  2. Click the Settings button. This button takes you to the Edit Workspace page.

  3. Here, you can edit the workspace avatar and avatar background color.

  4. 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.

Kong Manager
Admin API
Portal CLI

Using Kong Manager, complete the following:

  1. Manually delete all files via Dev Portal > Editor. You cannot delete folders at this time, but deleting all files from a folder will remove the folder.
  2. Turn off the Dev Portal. Go to Dev Portal Settings > Advanced > Turn Off.
  3. Remove all roles from the workspace:
    1. Go to the Teams tab.
    2. Navigate to the Roles tab.
    3. Click View on the workspace you want to delete.
    4. Go to each role entry and click Edit.
    5. In the entry detail page, click Delete Role. A confirmation modal will appear. Click Delete Role again.
  1. Delete all Dev Portal files associated with the workspace:

     curl -i -X DELETE http://localhost:8001/{WORKSPACE_NAME}/files
    
  2. Turn off the Dev Portal for the workspace:

    curl -X PATCH http://localhost:8001/workspaces/{WORKSPACE_NAME}  \
     --data "config.portal=false"
    
  3. Delete each role from the workspace:

     curl -i -X DELETE http://localhost:8001/{WORKSPACE_NAME}/rbac/roles/{ROLE_NAME|ROLE_ID}
    
  1. Delete all Dev Portal files associated with the workspace:

     portal wipe WORKSPACE_NAME
    
  2. Turn off the Dev Portal for the workspace:

     portal disable WORKSPACE_NAME
    
  3. Delete each role from the workspace. You can’t complete this step using the Portal CLI, so switch to either the Kong Manager or Admin API tab and complete step 3.

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.

Kong Manager
Admin API
  1. In the workspace you want to delete, navigate to the Dashboard page.

  2. Click the Settings button to open the Edit Workspace page.

  3. Click Delete.

    The deletion will fail if you have any data in your workspace.

Send a DELETE request to the Kong Admin API:

curl -i -X DELETE http://localhost/workspaces/{WORKSPACE_NAME|WORKSPACE_ID}

The deletion will fail if you have any data in your workspace.

If it is successful, you should see the following response:

HTTP 204 No Content

Workspace Access

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:

  1. Open Kong Manager.
  2. Click the Admins link in the Security section.

If the sidebar is collapsed, hover over the security badge icon and click Admins.

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.

Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023