/bff/api-key/scope/set

Replaces all scopes assigned to an API key. Pass an empty array to remove all scope restrictions (key gets full access). Only valid scope codes from /scope/list are accepted.

API KeypostBffApi-keyScopeSet

Parameters

JSON body

Request body

application/json

idstringRequired

External identifier (UUID) of the API key.

Example550e8400-e29b-41d4-a716-446655440000

scopesstring[]Required

Array of scope codes to assign. Empty array removes all restrictions (full access).

Response schema

1 status code documented

200SuccessScopes updated successfully.

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

POST /bff/api-key/scope/set

post

curl -X POST "https://api.bizkithub.com/bff/api-key/scope/set" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "scopes": [
    "string"
  ]
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key