Module settings_api 

Enums

BackendVersionError

struct for typed errors of method backend_version

GetBrandNameError

struct for typed errors of method get_brand_name

GetEntitlementsError

struct for typed errors of method get_entitlements

GetLicenseIdError

struct for typed errors of method get_license_id

GetOpenApiYamlError

struct for typed errors of method get_open_api_yaml

GetWorkspaceEntitlementsError

struct for typed errors of method get_workspace_entitlements

ListFeaturesError

struct for typed errors of method list_features

ListWorkspaceFeaturesError

struct for typed errors of method list_workspace_features

Functions

backend_version

get_brand_name

The operator-set whitelabel name for pre-login pages. Unauthenticated; exposes only the sanitized (max 40 chars) whitelabel_name instance setting, never licence data.

get_entitlements

get_license_id

get_open_api_yaml

get_workspace_entitlements

Read-only (#1753). Managed licence mode: the workspace’s own licence (Trial and state: missing when none is held). Instance mode: the instance licence, shared by every workspace. Members of the workspace only; a non-member is refused exactly as for a workspace that does not exist. Seat allowances/usage and the ladder dates (seats, seats_used, first_failure_at, grace_deadline, missing_since) are returned to workspace admins only and are null for other members (#1953).

list_features

list_workspace_features

Same shape as /features, answered by the licence of this workspace (#1753): its own for a workspace-scoped capability in managed licence mode (Trial when none is held), the host’s for an instance-scoped one, and the instance licence for everything in instance mode. Members of the workspace only.