Reference

References for using Layer5 Cloud’s various features and components.

These pages state facts about Layer5 Cloud: which plan includes a capability, which role holds a permission, and how to call the REST API. Start with Concepts for how the pieces fit together.

PageUse it to
Default PermissionsFind out which default role holds a permission in the permission list.
KeysSee how a key reaches a user, which security keys the server enforces, and the key endpoints.
KeychainsSee who can change a keychain and the keychain endpoints.
SessionsCheck session lifetimes, cookies, and how to sign out a session.
TokensCreate, list, rotate, and revoke API tokens.
Cloud APIAuthenticate, set the organization, page through results, and handle errors.
Rate limitsCheck which API routes are rate limited, the limit for each route family, and how to handle HTTP 429.

Provider Admin holds every key. The table lists the default holders of the other roles, as of Layer5 Cloud v1.0.280. “Interface” means the control or tab is disabled or replaced by a permission error screen. “Server” means the Layer5 Cloud server refuses the request with HTTP 403.

KeyGovernsDefault holders besides Provider AdminEnforced by
View TokensThe Tokens tabUser, Team Admin, Workspace Admin, Organization AdminInterface
Create TokenCreating an API token, and approving a desktop app or CLI sign-inUser, Team Admin, Workspace Admin, Organization AdminInterface for the Tokens tab. Server for approving a desktop app or CLI sign-in, which requires Create Token in at least one organization you belong to. The selected organization, and the organization a custom domain belongs to, do not matter.
Download TokenDownloading a token fileUser, Team Admin, Workspace Admin, Organization AdminInterface; the server returns only your own tokens
Delete TokenRevoking a token, and the Logout control on the Sessions tabOrganization AdminInterface only; the server deletes only your own tokens
View SessionsThe Sessions tabUser, Team Admin, Workspace Admin, Organization AdminInterface
Logout from a SessionSeeded for ending a sessionUser, Team Admin, Workspace Admin, Organization AdminNot checked. The interface uses Delete Token for Logout.
View KeysSeeded for the Keys tabUser, Team Admin, Workspace Admin, Organization AdminNot checked. Every signed-in user sees the Keys tab.
Edit KeyCreating and changing a keyNoneInterface and server. The server also requires the Provider Admin role.
Delete KeyDeleting a keyNoneInterface and server. The server also requires the Provider Admin role.
View KeychainsThe Keychains tabUser, Team Admin, Workspace Admin, Organization AdminInterface
Create KeychainCreating a keychainNoneInterface and server. The server also requires the Provider Admin role.
Edit KeychainRenaming a keychain, adding or removing its keysNoneInterface and server. The server also requires the Provider Admin role.
Delete KeychainDeleting a keychainNoneInterface and server. The server also requires the Provider Admin role.
Assign Keychains to RolesAdding or removing a keychain on a roleNoneServer. The server also requires the Provider Admin role.

Roles that hold the keys come from the default keychains: View keys sit in User View, Delete Token in Security Management, Create Token and Download Token in Security Management and User Edit, and the key and keychain management keys, including Assign Keychains to Roles, in Provider Management. Where the server requires the Provider Admin role, it checks the role across the whole deployment, not the role held in one organization. See Default Permissions for the role matrix, and Keys, Keychains, Sessions, and Tokens for lifetimes, cookies, and endpoints.

ResourceWho sees itScope
KeysSystem-owned default keys, plus keys you createdDeployment-wide; not per organization
KeychainsSystem-owned default keychains, plus keychains you ownDeployment-wide; not per organization
API tokensYour own, never the token value in the listUser account
SessionsYour ownUser account

Default keys and keychains are owned by the system. Deleting a key or keychain is a soft delete, and a deleted key or keychain stops granting access immediately.

Your plan is one condition for using a capability. Your role and where your Layer5 Cloud deployment runs also decide what you can do. Those conditions follow the matrix and the limits table.

The matrix has one column for each of the four Layer5 plans: Free, Team Designer, Team Operator, and Enterprise. Each plan is offered with monthly and annual billing. The Free plan is the plan that Layer5 Cloud calls Personal in its plan records, so you see that name in subscription and entitlement data. Entitlements follow your organization’s plan. Current pricing and plan details are listed at layer5.io/pricing.

  • A check mark means the plan includes the capability.
  • A dash means the plan does not include it.
  • Each table covers one category of capability. The What it does column describes the capability in one sentence. An empty cell means the plan list records no description.

The matrix is taken from the Layer5 product feature list. It lists the capabilities that have a documentation page. A capability that does not appear here is not necessarily unavailable. Check the page that documents it.

This section covers the Layer5 Cloud categories. For design, deployment, collaboration, and performance capabilities, see Kanvas reference.

CapabilityWhat it doesFreeTeam DesignerTeam OperatorEnterprise
Built-in RolesPredefined user roles: Organization Admin, Team Admin, Workspace Admin✅✅✅✅
Identity through OAuthUse third-party identity providers, Google and GitHub, to manage the identities of your organization’s members.✅✅✅✅
TeamsEstablish new team for organizing groups of users and resource access. Single organization, multiple teams.-✅✅✅
Custom RolesAssign User Roles, Assign Keychains to Roles--✅✅
User-defined RolesCustomizable roles for specific permission assignments---✅
Cloud as an IDPOwn and control the user accounts of your enterprise members with Cloud your identity provider (IdP).---✅
OrganizationsParticipate as a member of multiple organizations each with their own accounting and billing structure. Multiple organizations, multiple teams.---✅
OrganizationsEstablish new organization for organizing teams, users, and resource access.---✅
Direct Add or Invite User to OrganizationDirectly create a new user account within an organization. Send a request for a user to join an organization.----
CapabilityWhat it doesFreeTeam DesignerTeam OperatorEnterprise
My WorkspaceMy Workspace is your always available, primary space for storing designs, views, and models that you own.✅✅✅✅
GitOps SnapshotsVisual insights in your pull requests in GitHub. Verify your workload designs and Kubernetes cluster configurations prior to accepting and merging pull requests.-✅-✅
Manage Workspace Team and Environment AccessAssign designs, views, users, and environments to shared workspaces.-✅✅✅
Shared WorkspacesShared Workspaces are collaborative spaces that you can use to store and collaborate on files within and between teams. Easily share files with customizable permissions (edit, comment, view). Create up to 10 shared workspaces per organization.-✅✅✅
GitOps IntegrationsInitiate deployment with creation of pull request, ArgoEvents, Flux sync, or webhook.---✅
CapabilityWhat it doesFreeTeam DesignerTeam OperatorEnterprise
Public Catalog: 400 Cloud Native PatternsA library of pre-built design patterns and operational templates for common deployment scenarios, simplifying the configuration process and ensuring best practices.✅✅✅✅
Organization Private CatalogPrivately publish and share reusable design patterns and operational templates within your organization.---✅
Share DesignShare design with anyone within your organization, and make your design easily accessible to all relevant team members.✅✅-✅
Clone DesignClone any published design to customise it according to your use cases✅✅-✅
Publish DesignPublish a design----
View DesignsView all public and published designs of other team members and private of signed-in user----
View FiltersView all public and published filters of other team members and private of signed-in user--✅✅
Approve Catalog RequestChange management for the curation of content published in the catalog.---✅
Single and multiple approvers----
Import FilterImport a publish WASM filter----
CapabilityWhat it doesFreeTeam DesignerTeam OperatorEnterprise
Event Audit TrailDetailed accounting of user activity. Historical record or each action taken.---✅
Customizable Permissions: Keys, Keychains and RolesHighly flexible permissioning. Organize keys into custom keychains and assign to existing or custom roles that you define.---✅
User Session and API Token OversightExpiring and non-expiring API tokens. Visibility into active and expired user sessions.---✅
CapabilityWhat it doesFreeTeam DesignerTeam OperatorEnterprise
Public Profiles for UsersSee public user profile details, public activities and public resources.---✅
Recognition Program BadgesBadges are visual indicators of achievements or milestones that users can earn in order to recognizing activity milestones, encouraging positive behavior, mark progress, and gamifying platform experience.---✅
Self-service User AccountsNew user sign-up verification. Self-service password recovery.---✅
CapabilityWhat it doesFreeTeam DesignerTeam OperatorEnterprise
Community SupportGet help with most of your questions and issues in our Community Forum.✅✅✅✅
Standard SupportSupport can help you troubleshoot issues you run into. Get support via email.-✅✅✅
Managed Service ProviderWhite Label: Customize the appearance and branding of your engineering platform powered by Cloud. Multi-tenancy: Hierarchical organizations, teams, users and customizable permissioning.---✅
Premium SupportWith Premium, get a 2-hour SLA and 24/7 web and phone support.---✅
Self-hosted DeploymentSelf-hosted Cloud for on-prem appliances or self-managed cloud tenants. Keep your designs internal to your workplace. Get remote support when you need it.---✅
CapabilityWhat it doesFreeTeam DesignerTeam OperatorEnterprise
Academy Theoretical LearningA comprehensive learning management system for creators and instructors on how to build, manage, and extend educational content like learning paths, challenges, and certifications.---✅
Academy Practical LearningAn inclusive, collaborative, hands-on learning environment for students.---✅

Each plan records a quantity for the following entitlements.

EntitlementFreeTeam DesignerTeam OperatorEnterprise
Components per design100200100300
Relationships per design100200100300
Image size in a design250 KB1 MiB1 MiB10 MiB
Designs per workspaceUnlimitedUnlimitedUnlimitedUnlimited
Workspaces per organizationSee note1010Unlimited

For workspaces per organization on the Free plan, the plan records disagree: the monthly billing record sets 1 and the annual billing record sets 10.

Layer5 Cloud enforces one limit today: components per design. When you save or import a design, Layer5 Cloud compares its component count with the limit of your organization’s active plan. A design that exceeds the limit is refused with the error Design exeeds maximum limit of N components supported by your current plan, where N is the limit. To proceed, reduce the number of components in the design or upgrade the plan. When an organization holds more than one active subscription, the highest component limit among them applies. An organization with no active subscription cannot save or import a design. The request fails with HTTP 500 and the error Org is not entitled to adding components to a design.

Layer5 Cloud records every other quantity in the table and lists it through the entitlements API (GET /api/entitlement/features), but it does not refuse an action because of any of them. For the API’s base URL and authentication, see the Cloud API.

Authorization in Layer5 Cloud is by permission key. Each role you hold grants a set of keys, and your effective permissions are the union of the keys from every role you hold in the organization you are working in. An action your role does not grant is refused with HTTP 403, even when your plan includes the capability. See Default Permissions for which role holds which permission.

Layer5 Cloud runs either as the hosted service that Layer5 operates or as a self-hosted deployment that you operate. Self-hosted Deployment is listed under the Enterprise plan in the Support and Deployment table. The difference that matters most for availability is provider administration. The Provider Admin role administers the deployment and passes every permission check. On a self-hosted deployment, your operators assign it.

Only Provider Admins create custom roles. Layer5 Cloud refuses a role creation request from anyone else with HTTP 403. On hosted Layer5 Cloud, an organization cannot create a custom role itself. On a self-hosted deployment, the operator’s Provider Admins can. Roles are defined for the whole deployment, not per organization, so a role change applies in every organization where the role is held.

The Custom Roles and User-defined Roles rows in the Identity and Access Management table describe how those capabilities are packaged into plans. Layer5 Cloud does not check your plan when a custom role is created.

The component limit is the only entitlement Layer5 Cloud enforces by plan. The capability rows in the matrix describe how Layer5 packages its plans. When an action is unavailable and the plan is not the component limit, check your role and your deployment first.

The support channels and response commitments each plan includes are listed in Support.


Releases

Release version of Layer5 Cloud.

Cloud API

REST APIs for integrating with and extending Layer5 Cloud.

Default Permissions

List of default permissions granted to the Organizations, Teams and Users roles.

Related Reading