/api/configs/role#

Roles config is used to configure user roles and permissions for access control.

Role#

Field

Type

Description

Default Values

name

String

Name of the role.

Required field

description

String

Quick explanation of the purpose of the role.

Required field

immutable

Boolean

If true, the role cannot be modified. This cannot be set for any role besides the admin role.

False

policies

List[Policy]

List of policies which define actions/apis the role can perform/reach.

[]

Policy#

A policy is dictionary that currently only supports the actions key. The corresponding value for the actions key is an array of actions.

Action#

An Action is defined as such:

Field

Description

Base

Currently only http is supported.

Path

API path defined in glob format

Method

Method of the action. (i.e. *, GET, POST, PUT, PATCH, DELETE, WEBSOCKET)