Backstage

English | 한국어 | 中文版 | Français

What is Backstage?

Backstage is an open source framework for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly without compromising autonomy.

Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end.

Out of the box, Backstage includes:

• Backstage Software Catalog for managing all your software such as microservices, libraries, data pipelines, websites, and ML models
• Backstage Software Templates for quickly spinning up new projects and standardizing your tooling with your organization’s best practices
• Backstage TechDocs for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach
• Plus, a growing ecosystem of open source plugins that further expand Backstage’s customizability and functionality

Backstage was created by Spotify but is now hosted by the Cloud Native Computing Foundation (CNCF) as an Incubation level project. For more information, see the announcement.

Project roadmap

For information about the detailed project roadmap including delivered milestones, see the Roadmap.

Getting Started

To start using Backstage, see the Getting Started documentation.

Documentation

The documentation of Backstage includes:

• Main documentation
• Software Catalog
• Architecture (Decisions)
• Designing for Backstage
• Storybook - UI components

Community

To engage with our community, you can use the following resources:

• Discord chatroom - Get support or discuss the project
• Contributing to Backstage - Start here if you want to contribute
• RFCs - Help shape the technical direction
• FAQ - Frequently Asked Questions
• Code of Conduct - This is how we roll
• Adopters - Companies already using Backstage
• Blog - Announcements and updates
• Newsletter - Subscribe to our email newsletter
• Backstage Community Sessions - Join monthly meetups and explore Backstage community
• Give us a star ⭐️ - If you are using Backstage or think it is an interesting project, we would love a star ❤️

Governance

See the GOVERNANCE.md document in the backstage/community repository.

License

Copyright 2020-2025 © The Backstage Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page: https://www.linuxfoundation.org/trademark-usage

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Security

Please report sensitive security issues using Spotify's bug-bounty program rather than GitHub.

For further details, see our complete security release process.

@backstage/plugin-permission-common

0.9.0

Minor Changes

• 4da2965: Fixed an issue causing the PermissionClient to exhaust the request body size limit too quickly when making many requests.

Patch Changes

• 37328b1: Fixed an issue causing PermissionClient to throw an error when authorizing basic permissions with the permission.EXPERIMENTAL_enableBatchedRequests config enabled.
• 72d019d: Removed various typos
• Updated dependencies
  • @backstage/config@1.3.2
  • @backstage/errors@1.2.7
  • @backstage/types@1.2.1

0.9.0-next.0

Minor Changes

• 4da2965: Fixed an issue causing the PermissionClient to exhaust the request body size limit too quickly when making many requests.

Patch Changes

• 72d019d: Removed various typos
• Updated dependencies
  • @backstage/config@1.3.2
  • @backstage/errors@1.2.7
  • @backstage/types@1.2.1

0.8.4

Patch Changes

• Updated dependencies
  • @backstage/types@1.2.1
  • @backstage/config@1.3.2
  • @backstage/errors@1.2.7

0.8.4-next.0

Patch Changes

• Updated dependencies
  • @backstage/types@1.2.1-next.0
  • @backstage/config@1.3.2-next.0
  • @backstage/errors@1.2.7-next.0

0.8.3

Patch Changes

• Updated dependencies
  • @backstage/errors@1.2.6
  • @backstage/config@1.3.1
  • @backstage/types@1.2.0

0.8.3-next.0

Patch Changes

• Updated dependencies
  • @backstage/errors@1.2.6-next.0
  • @backstage/config@1.3.1-next.0
  • @backstage/types@1.2.0

0.8.2

Patch Changes

• 4e58bc7: Upgrade to uuid v11 internally
• Updated dependencies
  • @backstage/config@1.3.0
  • @backstage/types@1.2.0
  • @backstage/errors@1.2.5

0.8.1

Patch Changes

• df784fe: Add the MetadataResponse type from @backstage/plugin-permission-node, since this type might be used in frontend code.
• 137fa34: Add the MetadataResponseSerializedRule type from @backstage/plugin-permission-node, since this type might be used in frontend code.
• Updated dependencies
  • @backstage/config@1.2.0
  • @backstage/errors@1.2.4
  • @backstage/types@1.1.1

0.8.1-next.1

Patch Changes

• df784fe: Add the MetadataResponse type from @backstage/plugin-permission-node, since this type might be used in frontend code.
• Updated dependencies
  • @backstage/config@1.2.0
  • @backstage/errors@1.2.4
  • @backstage/types@1.1.1

0.8.1-next.0

Patch Changes

• 137fa34: Add the MetadataResponseSerializedRule type from @backstage/plugin-permission-node, since this type might be used in frontend code.
• Updated dependencies
  • @backstage/config@1.2.0
  • @backstage/errors@1.2.4
  • @backstage/types@1.1.1

0.8.0

Minor Changes

• f4085b8: BREAKING: Removed the deprecated and unused token option from EvaluatorRequestOptions. The PermissionsClient now has its own PermissionClientRequestOptions type that declares the token option instead.

Patch Changes

• Updated dependencies
  • @backstage/config@1.2.0
  • @backstage/errors@1.2.4
  • @backstage/types@1.1.1

0.7.14

Patch Changes

• d44a20a: Added additional plugin metadata to package.json.
• Updated dependencies
  • @backstage/config@1.2.0
  • @backstage/errors@1.2.4
  • @backstage/types@1.1.1

0.7.14-next.0

Patch Changes

• d44a20a: Added additional plugin metadata to package.json.
• Updated dependencies
  • @backstage/config@1.2.0
  • @backstage/errors@1.2.4
  • @backstage/types@1.1.1

0.7.13

Patch Changes

• 0502d82: The token option of the PermissionEvaluator methods is now deprecated. The options that only apply to backend implementations have been moved to PermissionsService from @backstage/backend-plugin-api instead.
• 0fb419b: Updated dependency uuid to ^9.0.0. Updated dependency @types/uuid to ^9.0.0.
• Updated dependencies
  • @backstage/config@1.2.0
  • @backstage/errors@1.2.4
  • @backstage/types@1.1.1

0.7.13-next.1

Patch Changes

• Updated dependencies
  • @backstage/config@1.2.0-next.1
  • @backstage/errors@1.2.4-next.0
  • @backstage/types@1.1.1

0.7.13-next.0

Patch Changes

• 0502d82: The token option of the PermissionEvaluator methods is now deprecated. The options that only apply to backend implementations have been moved to PermissionsService from @backstage/backend-plugin-api instead.
• 0fb419b: Updated dependency uuid to ^9.0.0. Updated dependency @types/uuid to ^9.0.0.
• Updated dependencies
  • @backstage/errors@1.2.4-next.0
  • @backstage/config@1.1.2-next.0
  • @backstage/types@1.1.1

0.7.12

Patch Changes

• b1acd9b: Updated README
• Updated dependencies
  • @backstage/config@1.1.1
  • @backstage/errors@1.2.3
  • @backstage/types@1.1.1

0.7.11

Patch Changes

• 0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617
• Updated dependencies
  • @backstage/config@1.1.1
  • @backstage/errors@1.2.3
  • @backstage/types@1.1.1

0.7.10

Patch Changes

• 4aa43f62aa: Updated dependency cross-fetch to ^4.0.0.
• Updated dependencies
  • @backstage/config@1.1.1
  • @backstage/errors@1.2.3
  • @backstage/types@1.1.1

0.7.9

Patch Changes

• Updated dependencies
  • @backstage/errors@1.2.3
  • @backstage/config@1.1.1
  • @backstage/types@1.1.1

0.7.9-next.0

Patch Changes

• Updated dependencies
  • @backstage/errors@1.2.3-next.0
  • @backstage/config@1.1.1-next.0
  • @backstage/types@1.1.1

0.7.8

Patch Changes

• 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
• Updated dependencies
  • @backstage/config@1.1.0
  • @backstage/errors@1.2.2
  • @backstage/types@1.1.1

0.7.8-next.2

Patch Changes

• 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
• Updated dependencies
  • @backstage/config@1.1.0-next.2
  • @backstage/errors@1.2.2-next.0
  • @backstage/types@1.1.1-next.0

0.7.8-next.1

Patch Changes

• Updated dependencies
  • @backstage/config@1.1.0-next.1
  • @backstage/errors@1.2.1
  • @backstage/types@1.1.0

0.7.8-next.0

Patch Changes

• Updated dependencies
  • @backstage/config@1.1.0-next.0
  • @backstage/errors@1.2.1
  • @backstage/types@1.1.0

0.7.7

Patch Changes

• Updated dependencies
  • @backstage/errors@1.2.1
  • @backstage/config@1.0.8
  • @backstage/types@1.1.0

0.7.7-next.0

Patch Changes

• Updated dependencies
  • @backstage/errors@1.2.1-next.0
  • @backstage/config@1.0.8
  • @backstage/types@1.1.0

0.7.6

Patch Changes

• Updated dependencies
  • @backstage/types@1.1.0
  • @backstage/errors@1.2.0
  • @backstage/config@1.0.8

0.7.6-next.0

Patch Changes

• Updated dependencies
  • @backstage/errors@1.2.0-next.0
  • @backstage/config@1.0.7
  • @backstage/types@1.0.2

0.7.5

Patch Changes

• 1e4f5e91b8e: Bump zod and zod-to-json-schema dependencies.
• Updated dependencies
  • @backstage/config@1.0.7
  • @backstage/errors@1.1.5
  • @backstage/types@1.0.2

0.7.5-next.0

Patch Changes

• 1e4f5e91b8e: Bump zod and zod-to-json-schema dependencies.
• Updated dependencies
  • @backstage/config@1.0.7
  • @backstage/errors@1.1.5
  • @backstage/types@1.0.2

0.7.4

Patch Changes

• 52b0022dab7: Updated dependency msw to ^1.0.0.
• Updated dependencies
  • @backstage/errors@1.1.5
  • @backstage/config@1.0.7
  • @backstage/types@1.0.2

0.7.4-next.0

Patch Changes

• 52b0022dab7: Updated dependency msw to ^1.0.0.
• Updated dependencies
  • @backstage/errors@1.1.5-next.0
  • @backstage/config@1.0.7-next.0
  • @backstage/types@1.0.2

0.7.3

Patch Changes

• Updated dependencies
  • @backstage/config@1.0.6
  • @backstage/errors@1.1.4
  • @backstage/types@1.0.2

0.7.3-next.0

Patch Changes

• Updated dependencies
  • @backstage/config@1.0.6-next.0
  • @backstage/errors@1.1.4
  • @backstage/types@1.0.2

0.7.2

Patch Changes

• b05dcd5530: Move the zod dependency to a version that does not collide with other libraries
• 3280711113: Updated dependency msw to ^0.49.0.
• Updated dependencies
  • @backstage/errors@1.1.4
  • @backstage/types@1.0.2
  • @backstage/config@1.0.5

0.7.2-next.2

Patch Changes

• b05dcd5530: Move the zod dependency to a version that does not collide with other libraries
• Updated dependencies
  • @backstage/config@1.0.5-next.1
  • @backstage/errors@1.1.4-next.1
  • @backstage/types@1.0.2-next.1

0.7.2-next.1

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.2-next.1
  • @backstage/config@1.0.5-next.1
  • @backstage/errors@1.1.4-next.1

0.7.2-next.0

Patch Changes

• 3280711113: Updated dependency msw to ^0.49.0.
• Updated dependencies
  • @backstage/types@1.0.2-next.0
  • @backstage/config@1.0.5-next.0
  • @backstage/errors@1.1.4-next.0

0.7.1

Patch Changes

• 7573b65232: Internal refactor of imports to avoid circular dependencies
• 64848c963c: Properly handle rules that have no parameters in PermissionClient
• Updated dependencies
  • @backstage/types@1.0.1
  • @backstage/config@1.0.4
  • @backstage/errors@1.1.3

0.7.1-next.0

Patch Changes

• 7573b65232: Internal refactor of imports to avoid circular dependencies
• 64848c963c: Properly handle rules that have no parameters in PermissionClient
• Updated dependencies
  • @backstage/types@1.0.1-next.0
  • @backstage/config@1.0.4-next.0
  • @backstage/errors@1.1.3-next.0

0.7.0

Minor Changes

• 46b4a72cee: BREAKING: When defining permission rules, it's now necessary to provide a ZodSchema that specifies the parameters the rule expects. This has been added to help better describe the parameters in the response of the metadata endpoint and to validate the parameters before a rule is executed.

  To help with this, we have also made a change to the API of permission rules. Before, the permission rules toQuery and apply signature expected parameters to be separate arguments, like so...

  createPermissionRule({
    apply: (resource, foo, bar) => true,
    toQuery: (foo, bar) => {},
  });
  

  The API has now changed to expect the parameters as a single object

  createPermissionRule({
    paramSchema: z.object({
      foo: z.string().describe('Foo value to match'),
      bar: z.string().describe('Bar value to match'),
    }),
    apply: (resource, { foo, bar }) => true,
    toQuery: ({ foo, bar }) => {},
  });
  

  One final change made is to limit the possible values for a parameter to primitives and arrays of primitives.

Patch Changes

• Updated dependencies
  • @backstage/config@1.0.3
  • @backstage/errors@1.1.2
  • @backstage/types@1.0.0

0.7.0-next.2

Minor Changes

• 46b4a72cee: BREAKING: When defining permission rules, it's now necessary to provide a ZodSchema that specifies the parameters the rule expects. This has been added to help better describe the parameters in the response of the metadata endpoint and to validate the parameters before a rule is executed.

  To help with this, we have also made a change to the API of permission rules. Before, the permission rules toQuery and apply signature expected parameters to be separate arguments, like so...

  createPermissionRule({
    apply: (resource, foo, bar) => true,
    toQuery: (foo, bar) => {},
  });
  

  The API has now changed to expect the parameters as a single object

  createPermissionRule({
    paramSchema: z.object({
      foo: z.string().describe('Foo value to match'),
      bar: z.string().describe('Bar value to match'),
    }),
    apply: (resource, { foo, bar }) => true,
    toQuery: ({ foo, bar }) => {},
  });
  

  One final change made is to limit the possible values for a parameter to primitives and arrays of primitives.

Patch Changes

• Updated dependencies
  • @backstage/config@1.0.3-next.2
  • @backstage/errors@1.1.2-next.2
  • @backstage/types@1.0.0

0.6.5-next.1

Patch Changes

• Updated dependencies
  • @backstage/config@1.0.3-next.1
  • @backstage/errors@1.1.2-next.1

0.6.5-next.0

Patch Changes

• Updated dependencies
  • @backstage/config@1.0.3-next.0
  • @backstage/errors@1.1.2-next.0

0.6.4

Patch Changes

• 7d47def9c4: Removed dependency on @types/jest.
• 667d917488: Updated dependency msw to ^0.47.0.
• 87ec2ba4d6: Updated dependency msw to ^0.46.0.
• bf5e9030eb: Updated dependency msw to ^0.45.0.
• Updated dependencies
  • @backstage/config@1.0.2
  • @backstage/errors@1.1.1

0.6.4-next.2

Patch Changes

• 7d47def9c4: Removed dependency on @types/jest.
• Updated dependencies
  • @backstage/config@1.0.2-next.0
  • @backstage/errors@1.1.1-next.0

0.6.4-next.1

Patch Changes

• 667d917488: Updated dependency msw to ^0.47.0.
• 87ec2ba4d6: Updated dependency msw to ^0.46.0.

0.6.4-next.0

Patch Changes

• bf5e9030eb: Updated dependency msw to ^0.45.0.

0.6.3

Patch Changes

• a70869e775: Updated dependency msw to ^0.43.0.
• 8006d0f9bf: Updated dependency msw to ^0.44.0.
• Updated dependencies
  • @backstage/errors@1.1.0

0.6.3-next.1

Patch Changes

• a70869e775: Updated dependency msw to ^0.43.0.

0.6.3-next.0

Patch Changes

• Updated dependencies
  • @backstage/errors@1.1.0-next.0

0.6.2

Patch Changes

• 8f7b1835df: Updated dependency msw to ^0.41.0.

0.6.2-next.0

Patch Changes

• 8f7b1835df: Updated dependency msw to ^0.41.0.

0.6.1

Patch Changes

• Updated dependencies
  • @backstage/config@1.0.1

0.6.1-next.0

Patch Changes

• Updated dependencies
  • @backstage/config@1.0.1-next.0

0.6.0

Minor Changes

• 8012ac46a0: Add resourceType property to PermissionCondition type to allow matching them with ResourcePermission instances.

• c98d271466: Refactor api types into more specific, decoupled names.

  • BREAKING:
    • Renamed AuthorizeDecision to EvaluatePermissionResponse
    • Renamed AuthorizeQuery to EvaluatePermissionRequest
    • Renamed AuthorizeRequest to EvaluatePermissionRequestBatch
    • Renamed AuthorizeResponse to EvaluatePermissionResponseBatch
    • Renamed Identified to IdentifiedPermissionMessage
  • Add PermissionMessageBatch helper type
  • Add ConditionalPolicyDecision, DefinitivePolicyDecision, and PolicyDecision types from @backstage/plugin-permission-node

Patch Changes

• 90754d4fa9: Removed strict validation from PermissionCriteria schemas to support backward-compatible changes.

• 2b07063d77: Added PermissionEvaluator, which will replace the existing PermissionAuthorizer interface. This new interface provides stronger type safety and validation by splitting PermissionAuthorizer.authorize() into two methods:

  • authorize(): Used when the caller requires a definitive decision.
  • authorizeConditional(): Used when the caller can optimize the evaluation of any conditional decisions. For example, a plugin backend may want to use conditions in a database query instead of evaluating each resource in memory.

• 8012ac46a0: Add isPermission helper method.

• 95284162d6: - Add more specific Permission types.
  • Add createPermission helper to infer the appropriate type for some permission input.
  • Add isResourcePermission helper to refine Permissions to ResourcePermissions.

0.6.0-next.1

Patch Changes

• 2b07063d77: Added PermissionEvaluator, which will replace the existing PermissionAuthorizer interface. This new interface provides stronger type safety and validation by splitting PermissionAuthorizer.authorize() into two methods:

  • authorize(): Used when the caller requires a definitive decision.
  • authorizeConditional(): Used when the caller can optimize the evaluation of any conditional decisions. For example, a plugin backend may want to use conditions in a database query instead of evaluating each resource in memory.

0.6.0-next.0

Minor Changes

• 8012ac46a0: Add resourceType property to PermissionCondition type to allow matching them with ResourcePermission instances.

• c98d271466: Refactor api types into more specific, decoupled names.

  • BREAKING:
    • Renamed AuthorizeDecision to EvaluatePermissionResponse
    • Renamed AuthorizeQuery to EvaluatePermissionRequest
    • Renamed AuthorizeRequest to EvaluatePermissionRequestBatch
    • Renamed AuthorizeResponse to EvaluatePermissionResponseBatch
    • Renamed Identified to IdentifiedPermissionMessage
  • Add PermissionMessageBatch helper type
  • Add ConditionalPolicyDecision, DefinitivePolicyDecision, and PolicyDecision types from @backstage/plugin-permission-node

Patch Changes

• 8012ac46a0: Add isPermission helper method.
• 95284162d6: - Add more specific Permission types.
  • Add createPermission helper to infer the appropriate type for some permission input.
  • Add isResourcePermission helper to refine Permissions to ResourcePermissions.

0.5.3

Patch Changes

• f24ef7864e: Minor typo fixes
• Updated dependencies
  • @backstage/config@1.0.0
  • @backstage/errors@1.0.0

0.5.2

Patch Changes

• 79b9d8a861: Add api doc comments to Permission type properties.

0.5.1

Patch Changes

• Fix for the previous release with missing type declarations.
• Updated dependencies
  • @backstage/config@0.1.15
  • @backstage/errors@0.2.2

0.5.0

Minor Changes

• 8c646beb24: BREAKING PermissionCriteria now requires at least one condition in anyOf and allOf arrays. This addresses some ambiguous behavior outlined in #9280.

Patch Changes

• 1ed305728b: Bump node-fetch to version 2.6.7 and cross-fetch to version 3.1.5
• c77c5c7eb6: Added backstage.role to package.json
• Updated dependencies
  • @backstage/errors@0.2.1
  • @backstage/config@0.1.14

0.4.0

Minor Changes

• b768259244: BREAKING: Authorize API request and response types have been updated. The existing AuthorizeRequest and AuthorizeResponse types now match the entire request and response objects for the /authorize endpoint, and new types AuthorizeQuery and AuthorizeDecision have been introduced for individual items in the request and response batches respectively.

  BREAKING: PermissionClient has been updated to use the new request and response format in the latest version of @backstage/plugin-permission-backend.

Patch Changes

• Updated dependencies
  • @backstage/config@0.1.13

0.4.0-next.0

Minor Changes

• b768259244: BREAKING: Authorize API request and response types have been updated. The existing AuthorizeRequest and AuthorizeResponse types now match the entire request and response objects for the /authorize endpoint, and new types AuthorizeQuery and AuthorizeDecision have been introduced for individual items in the request and response batches respectively.

  BREAKING: PermissionClient has been updated to use the new request and response format in the latest version of @backstage/plugin-permission-backend.

Patch Changes

• Updated dependencies
  • @backstage/config@0.1.13-next.0

0.3.1

Patch Changes

• Updated dependencies
  • @backstage/config@0.1.12
  • @backstage/errors@0.2.0

0.3.0

Minor Changes

• 0e8ec6d974: - Add PermissionAuthorizer interface matching PermissionClient to allow alternative implementations like the ServerPermissionClient in @backstage/plugin-permission-node.

  Breaking Changes:

  • Remove "api" suffixes from constructor parameters in PermissionClient

    const { config, discovery } = options;
  -  const permissionClient = new PermissionClient({ discoveryApi: discovery, configApi: config });
  +  const permissionClient = new PermissionClient({ discovery, config });
  

0.2.0

Minor Changes

• 92439056fb: Accept configApi rather than enabled flag in PermissionClient constructor.

Patch Changes

• Updated dependencies
  • @backstage/errors@0.1.5