Skip to content

Add API Keys spec (create, list, revoke) - #1129

Open
cwperks wants to merge 1 commit into
opensearch-project:mainfrom
cwperks:api-keys
Open

Add API Keys spec (create, list, revoke)#1129
cwperks wants to merge 1 commit into
opensearch-project:mainfrom
cwperks:api-keys

Conversation

@cwperks

@cwperks cwperks commented May 22, 2026

Copy link
Copy Markdown
Member

Description

Adds OpenAPI specification for the API Keys feature in the OpenSearch Security plugin.

Related to opensearch-project/security#5443

Operations added:

  • security.create_api_key — POST /_plugins/_security/api/apitokens
  • security.get_api_keys — GET /_plugins/_security/api/apitokens
  • security.delete_api_key — DELETE /_plugins/_security/api/apitokens/{id}

Schemas added:

  • ApiKey, ApiKeyIndexPermission, ApiKeyCreateRequest, ApiKeyCreateResponse, ApiKeyListResponse, ApiKeyRevokeResponse

Test story: tests/plugins/security/api/apitokens.yaml

All operations are marked x-version-added: '3.7' and excluded from amazon-managed and amazon-serverless distributions.

Issues Resolved

Related to opensearch-project/security#4009

Check List

  • Spec lint passes
  • Spec merger succeeds
  • Test story included
  • Commits are signed per the DCO using --signoff

Signed-off-by: Craig Perkins <cwperx@amazon.com>
@Tokesh

Tokesh commented May 27, 2026

Copy link
Copy Markdown
Collaborator

Hi @cwperks ! Thanks for your contribution.
it seems like the CI is failing. Could you please take a look at the logs? Let me know if you need any help getting it green!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants