Home
Content Management API
Main resources
Upload-related
Site Search
Environments
UI
Workflows
Async jobs
Roles & permissions
Webhooks
Hosting & CI integrations
Subscription
Enterprise
    Choose your language:
    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
    name  string

    The name of the role

    canEditSite  boolean

    Can change project name and 2FA settings

    canEditFavicon  boolean

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

    canEditSchema  boolean

    Can create/edit models and plugins

    canManageMenu  boolean

    Can customize content navigation bar

    canManageUsers  boolean

    Can create/edit roles and invite/remove collaborators

    canManageEnvironments  boolean

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

    canManageWebhooks  boolean

    Can create/edit webhooks

    environmentsAccess  enum

    Specifies the environments the user can access

    canManageSso  boolean

    Can manage Single Sign-On settings

    canAccessAuditLog  boolean

    Can access Audit Log

    canManageWorkflows  boolean

    Can create/edit workflows

    canEditEnvironment  boolean

    Can change locales, timezone and UI theme

    canPromoteEnvironments  boolean

    Can promote environments to primary and manage maintenance mode

    canManageBuildTriggers  boolean

    Can create/edit Build triggers

    canManageAccessTokens  boolean

    Can manage API tokens

    canPerformSiteSearch  boolean

    Can perform Site Search API calls

    canAccessBuildEventsLog  boolean

    Can access the build events log

    positiveItemTypePermissions  Array<object>

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

    negativeItemTypePermissions  Array<object>

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

    positiveUploadPermissions  Array<object>

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

    negativeUploadPermissions  Array<object>

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

    positiveBuildTriggerPermissions  Array<object>

    Allowed build triggers for a role

    negativeBuildTriggerPermissions  Array<object>

    Prohibited build triggers for a role

    canManageSharedFilters  boolean

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

    meta.finalPermissions  object

    The final set of permissions considering also inherited roles

    inheritsPermissionsFrom  Array<role.id>

    The roles from which this role inherits permissions

    Available endpoints

    Questions?
    We're always happy to help with code or other questions you might have. Search our documentation, forum, contact support, or connect with our sales team. You can chat live with other developers in our Slack channel.