Skip to content

AdminRole

A role: a named set of permissions. A higher position outranks a lower one; a user may grant, revoke, create, change, and delete only the roles at or below their highest one, and give or take only the permissions they hold.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
key
required

The name of the role, such as admin or moderator.

string
>= 1 characters <= 64 characters
position
required

The rank of the role, from 0 to 999, and 1000 for admin.

integer
<= 1000
permissions
required

The permissions that the role grants, in the order of Permission.

Array<string>
Allowed values: manage_reports manage_accounts manage_domains manage_rules manage_settings manage_roles manage_invites view_audit manage_jobs manage_login_recovery manage_custom_emojis manage_webhooks manage_announcements manage_finance view_finance manage_supporters create_custom_emojis manage_oauth_apps manage_service_closure start_voice_rooms manage_errors manage_login_providers create_invites keep_posts_longer create_articles create_events
badge

The badge of the role, which its holders may show on their profile; omitted when it has none.

Schema: RoleBadge

object
supporter_plan

The supporter plan that grants the role, which only its subscriptions grant and revoke; omitted for a role that no plan grants. A role is the role of one plan at most.

Schema: AdminRoleSupporterPlan

object

Example generated

{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"key": "example",
"position": 1,
"permissions": [
"manage_reports"
],
"badge": {},
"supporter_plan": {}
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site