nocobase/packages/plugins/@nocobase/plugin-api-keys/docs/en-US/index.md

# API keys

## Introduction

This plugin allows you to create and manage API keys. The generated API key can be used to access all `NocoBase` APIs.

## Access Control

When creating an API key, you can bind it to a role, and the role's permissions will be the same as the Key's permissions.
feat(plugin-api-keys): support fetch api via api-keys (#2136) * feat(plugin-api-keys): support fetch api via api-keys * feat: full support * fix: missing parseToken in auth * feat: add created at column * feat: configure snippet * fix: remove unused code * fix: revert * chore: update deps * feat: improve role * fix: avoid create api key without not exist role * feat: improve select roles * refactor: when no X-Role is found, roles should not be randomly assigned * feat: improve code * feat: improve current role * fix: revert * fix: revert apilicent * fix: revert auth * feat: improve currentRole logic * feat: use resourcer.use instead it * refactor: remove api-keys-auth * fix: type * refactor: move jwt to authManager * refactor: remove unused code * refactor: remove protected * Revert "refactor: remove unused code" This reverts commit 8f81535ab7e9c412bdc4d4bc05abad64ff60ba3f. * feat: remove unused code * feat: improve code * fix: test error * test: update test * test: add test cases * docs: update * chore: update X-Role * fix: token's roleName not work * docs: update usage * fix: i18n Add APi key * docs: update capital * docs: update * feat: clean * Update package.json * Update roles.ts * fix: api key --------- Co-authored-by: chenos <chenlinxh@gmail.com> 2023-06-30 03:20:35 +00:00			`# API keys`

			`## Introduction`

docs: update api-keys related documentation (#2162) * docs: typo * docs: update 2023-07-01 04:21:33 +00:00			This plugin allows you to create and manage API keys. The generated API key can be used to access all `NocoBase` APIs.
feat(plugin-api-keys): support fetch api via api-keys (#2136) * feat(plugin-api-keys): support fetch api via api-keys * feat: full support * fix: missing parseToken in auth * feat: add created at column * feat: configure snippet * fix: remove unused code * fix: revert * chore: update deps * feat: improve role * fix: avoid create api key without not exist role * feat: improve select roles * refactor: when no X-Role is found, roles should not be randomly assigned * feat: improve code * feat: improve current role * fix: revert * fix: revert apilicent * fix: revert auth * feat: improve currentRole logic * feat: use resourcer.use instead it * refactor: remove api-keys-auth * fix: type * refactor: move jwt to authManager * refactor: remove unused code * refactor: remove protected * Revert "refactor: remove unused code" This reverts commit 8f81535ab7e9c412bdc4d4bc05abad64ff60ba3f. * feat: remove unused code * feat: improve code * fix: test error * test: update test * test: add test cases * docs: update * chore: update X-Role * fix: token's roleName not work * docs: update usage * fix: i18n Add APi key * docs: update capital * docs: update * feat: clean * Update package.json * Update roles.ts * fix: api key --------- Co-authored-by: chenos <chenlinxh@gmail.com> 2023-06-30 03:20:35 +00:00
			`## Access Control`

			`When creating an API key, you can bind it to a role, and the role's permissions will be the same as the Key's permissions.`