Interface: ManagementApiOptions
@roomful/relay / ManagementApiOptions
Interface: ManagementApiOptions
Section titled “Interface: ManagementApiOptions”Defined in: packages/relay/src/management/api.ts:552
Options for the management API request handler.
Properties
Section titled “Properties”authorize()?
Section titled “authorize()?”
optionalauthorize: (request,ownerId,action,projectId?) =>boolean|Promise<boolean>
Defined in: packages/relay/src/management/api.ts:576
Custom authorization callback. Called for every management API request.
Return false or throw to reject with 403.
Parameters
Section titled “Parameters”request
Section titled “request”IncomingMessage
The incoming HTTP request.
ownerId
Section titled “ownerId”string
The resolved owner from auth headers.
action
Section titled “action”string
The handler name (e.g. “createProject”).
projectId?
Section titled “projectId?”string
The project id from the URL when applicable.
Returns
Section titled “Returns”boolean | Promise<boolean>
defaults
Section titled “defaults”defaults:
RelayDefaults
Defined in: packages/relay/src/management/api.ts:560
Relay-wide defaults for quota resolution.
prefix?
Section titled “prefix?”
optionalprefix:string
Defined in: packages/relay/src/management/api.ts:565
Override the default API prefix. Defaults to /api/v1.
store:
ManagementStore
Defined in: packages/relay/src/management/api.ts:554
The management data store.
usageEventStore?
Section titled “usageEventStore?”
optionalusageEventStore:UsageEventStore
Defined in: packages/relay/src/management/api.ts:557
Optional usage event store for recording/querying usage events.