A Role represents a specific set of actions an editor (or an API token) can perform on your administrative area.
Object payload
type string
Must be exactly "role"
name string Example: "Editor"
can_edit_site boolean Example: true
Can change project global properties
can_edit_favicon boolean Example: true
Can edit favicon, global SEO settings and no-index policy
can_edit_schema boolean Example: true
Can create/edit models and plugins
can_manage_menu boolean Example: true
Can customize content navigation bar
can_manage_users boolean Example: true
Can create/edit roles and invite/remove collaborators
can_manage_environments boolean Example: true
Can create/delete sandbox environments and promote them to primary environment
can_manage_webhooks boolean Example: true
environments_access enum Example: "primary_only"
Specifies the environments the user can access
can_manage_sso boolean Example: true
Can manage Single Sign-On settings
can_access_audit_log boolean Example: true
can_manage_workflows boolean Example: true
Can create/edit workflows
can_edit_environment boolean Example: true
Can change locales, timezone and UI theme
can_promote_environments boolean Example: true
Can promote environments to primary and manage maintenance mode
can_manage_build_triggers boolean Example: true
Can create/edit Build triggers
can_manage_access_tokens boolean Example: true
can_perform_site_search boolean Example: true
Can perform Site Search API calls
can_access_build_events_log boolean Example: true
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 Example: true
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_fromArray of { type: "role", id: role.id } The roles from which this role inherits permissions
Available endpoints