Type Alias: ApiKeyScopeInfo
Properties
| Property | Type | Required | Description |
|---|---|---|---|
scope | unknown | Yes | The scope string stored on the key |
product | "cortex" | "fleet" | Yes | The 4Players product the scope belongs to |
family | string | Yes | Stable identifier of the resource family, for grouping (example: "sanctions") |
familyLabel | string | Yes | Display name of the family (example: "Sanctions") |
label | string | Yes | Display name of the scope within its family (example: "Read only") |
description | string | Yes | What the scope grants, including the events it receives on the SSE streams |
access | "full" | "read" | "capability" | Yes | full = read and write of the family; read = its read routes only; capability = one narrow capability the family scope does not include. A family with full and read offers a single None / Read / Read & write choice. |
sensitive | boolean | Yes | The scope acts on players or on how the project authenticates. Presets never include it; UIs should ask for it explicitly and warn. |
One scope with the metadata a UI needs to render it (family, label, access kind, sensitivity).
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/api-keys.ts:18