Home
Content Management API⁡𝅶‍‍𝅺⁡‍𝅴⁡𝅴𝅹‍‍⁢𝅵‍‍⁣⁣‌⁡⁣𝅺⁣⁢⁣𝅸⁠⁢‍‍‍𝅷‍‍𝅳⁡‍⁠‍‍⁢𝅵‍‍𝅳⁡⁣⁡⁣⁡​⁡⁢⁢𝅵‍𝅺‍𝅺⁢𝅸⁡⁢‍𝅹⁣‌⁡⁣𝅺⁢𝅸⁡⁢‍𝅹⁢𝅺𝅸‍𝅺⁠⁣𝅴⁡⁣𝅺⁡‍‍𝅺𝅴⁡⁣⁠𝅸⁠𝅺⁡⁣⁡𝅴⁡​⁠⁡⁢‍𝅺⁢𝅳⁢‌⁢​⁢𝅴⁢‍⁢⁠‍𝅺𝅴⁡⁣⁠𝅸⁡⁢‍𝅺⁢⁢⁢𝅴⁢𝅳⁢⁢⁢‌⁢⁡⁢𝅳⁢‌‍‍⁡𝅸
Main resources
Upload-related
Site Search
Environments
UI
Workflows
Async jobs
Roles & permissions
Webhooks
Hosting & CI integrations
Subscription
Enterprise
    Show examples in:
    Role

    A Role represents a specific set of actions an editor (or an API token) can perform on your administrative area.

    Object payload

    id  string
    ID of role
    type  string
    Must be exactly "role"
    name  string

    The name of the role

    can_edit_site  boolean

    Can change project name and 2FA settings

    can_edit_favicon  boolean

    Can edit favicon, global SEO settings and no-index policy

    can_edit_schema  boolean

    Can create/edit models and plugins

    can_manage_menu  boolean

    Can customize content navigation bar

    can_manage_users  boolean

    Can create/edit roles and invite/remove collaborators

    can_manage_environments  boolean

    Can create/delete sandbox environments and promote them to primary environment

    can_manage_webhooks  boolean

    Can create/edit webhooks

    environments_access  enum

    Specifies the environments the user can access

    can_manage_sso  boolean

    Can manage Single Sign-On settings

    can_access_audit_log  boolean

    Can access Audit Log

    can_manage_workflows  boolean

    Can create/edit workflows

    can_edit_environment  boolean

    Can change locales, timezone and UI theme

    can_promote_environments  boolean

    Can promote environments to primary and manage maintenance mode

    can_manage_build_triggers  boolean

    Can create/edit Build triggers

    can_manage_access_tokens  boolean

    Can manage API tokens

    can_perform_site_search  boolean

    Can perform Site Search API calls

    can_access_build_events_log  boolean

    Can access the build events log

    positive_item_type_permissions  Array<object>

    Allowed actions on a model (or all) for a role

    negative_item_type_permissions  Array<object>

    Prohibited actions on a model (or all) for a role

    positive_upload_permissions  Array<object>

    Allowed actions on a model (or all) for a role

    negative_upload_permissions  Array<object>

    Prohibited actions on a model (or all) for a role

    positive_build_trigger_permissions  Array<object>

    Allowed build triggers for a role

    negative_build_trigger_permissions  Array<object>

    Prohibited build triggers for a role

    can_manage_shared_filters  boolean

    Can create/edit shared filters (both for models and the media area)

    meta.final_permissions  object

    The final set of permissions considering also inherited roles

    inherits_permissions_from  Array of { type: "role", id: role.id }

    The roles from which this role inherits permissions

    Available endpoints