Api Keys

List API keys for the tenant

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/apiKeys

Returns all API key definitions stored in security.yml. Key hashes are never included in responses.

Authorization

Requires tenant.apiKey:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

API keys returned.

text/plainapplication/jsontext/json

API key definition returned by list and get endpoints. The key hash is never exposed.

or

get/api/{tenantId}/admin/apiKeys

HTTPcURLJavaScriptPython

GET /api/{tenantId}/admin/apiKeys HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

API keys returned.

[
  {
    "name": "text",
    "enabled": true,
    "permissions": [
      "text"
    ]
  }
]

Create a new API key

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/apiKeys

Generates a cryptographically secure token, stores its SHA-256 hash in security.yml, and returns the plaintext token in the response. The token is only returned once — copy it immediately.

Authorization

Requires tenant.apiKey:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Request body to create an API key.

namestring · min: 1Required

Key name. Only alphanumeric characters, hyphens, underscores and dots are allowed.

enabledbooleanOptional

Whether this key is active. Defaults to true.

permissionsstring[]Optional

List of permission scopes granted to this key. Use ["*"] for full access.

Responses

201

API key created. Response includes the one-time plaintext token.

text/plainapplication/jsontext/json

Returned once after a successful key creation. The Token field contains the plaintext API key and will never be retrievable again.

namestringRequired

Key name identifier.

enabledbooleanRequired

Whether this key is currently active.

permissionsstring[]Required

List of permission scopes granted to this key. Use ["*"] for full tenant-admin access.

tokenstringRequired

Plaintext API key. Copy and store it immediately — it will not be shown again.

400

Name is invalid or permissions are missing.

text/plainapplication/jsontext/json

409

A key with this name already exists.

text/plainapplication/jsontext/json

post/api/{tenantId}/admin/apiKeys

HTTPcURLJavaScriptPython

POST /api/{tenantId}/admin/apiKeys HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "text",
  "enabled": true,
  "permissions": [
    "text"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "token": "text",
  "name": "text",
  "enabled": true,
  "permissions": [
    "text"
  ]
}

Get a specific API key

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/apiKeys/{keyName}

Returns the API key definition identified by keyName. The key hash is never returned.

Authorization

Requires tenant.apiKey:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

keyNamestringRequired

tenantIdstringRequired

Responses

200

API key returned.

text/plainapplication/jsontext/json

API key definition returned by list and get endpoints. The key hash is never exposed.

or

404

API key not found.

text/plainapplication/jsontext/json

get/api/{tenantId}/admin/apiKeys/{keyName}

HTTPcURLJavaScriptPython

GET /api/{tenantId}/admin/apiKeys/{keyName} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "name": "text",
  "enabled": true,
  "permissions": [
    "text"
  ]
}

Update an API key

put

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/apiKeys/{keyName}

Replaces the enabled and permissions fields of the key. The key name and the stored hash are not changed.

Authorization

Requires tenant.apiKey:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

keyNamestringRequired

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Request body to update an API key.

enabledbooleanRequired

Whether this key is active.

permissionsstring[]Optional

New list of permission scopes. Use ["*"] for full access.

Responses

200

API key updated.

text/plainapplication/jsontext/json

API key definition returned by list and get endpoints. The key hash is never exposed.

or

400

Permissions are missing.

text/plainapplication/jsontext/json

404

API key not found.

text/plainapplication/jsontext/json

put/api/{tenantId}/admin/apiKeys/{keyName}

HTTPcURLJavaScriptPython

PUT /api/{tenantId}/admin/apiKeys/{keyName} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "enabled": true,
  "permissions": [
    "text"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "enabled": true,
  "permissions": [
    "text"
  ]
}

Delete an API key

delete

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/apiKeys/{keyName}

Removes the API key entry from security.yml. The key immediately stops working.

Authorization

Requires tenant.apiKey:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

keyNamestringRequired

tenantIdstringRequired

Responses

204

API key deleted.

No content

404

API key not found.

text/plainapplication/jsontext/json

delete/api/{tenantId}/admin/apiKeys/{keyName}

HTTPcURLJavaScriptPython

DELETE /api/{tenantId}/admin/apiKeys/{keyName} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content