Skip to main content

ApiKeyScope

from lium.sdk import ApiKeyScope

Defined in lium.sdk.models.

One row of GET /keys/scopes: what a scope lets a key do, in the server's words.

description is the one sentence next to the picker's checkbox, can the "what this key can do" lines, route_families the routes it opens, default whether a key made without naming scopes gets it.

ApiKeyScope(
scope: str,
description: str,
title: str = '',
can: List[str] = <factory>,
route_families: List[str] = <factory>,
default: bool = False
)

Fields​

NameTypeDefault
scopestr
descriptionstr
titlestr''
canList[str]
route_familiesList[str]
defaultboolFalse