Full Directory of Arthur Permissions

This directory lists the full set of permissions available in the Arthur platform for use with Custom RBAC. These permissions are used in the built-in roles. You can also use these permissions in your own custom roles to provide granular access control to resources in Arthur.

What is a permission in Arthur?

A permission in Arthur is a combination of a resource and an associated action that can be taken on that resource. Each permission corresponds to a set of API endpoints that a user gains access to when their role includes that permission. These permissions are also used by the UI to provide access to different features in the UI as denoted by the “Needed in UI?” column.

Click the sample API endpoint links in the following tables to see more details about the underlying functionality and data included with each permission.

Organization Management Permissions

Resource	Action	Description	Sample API Endpoints	Needed in UI?
organization_global	read	See all organizations that exist across your Arthur installation	Get all organizations	◻️
organization_global	write	Create a new organization or edit an existing organization	Create a new organization, Edit an organiation	◻️
organization	read	See details of a specific organization	Get an organization	◻️
organization	delete	Delete a specific organization	Delete an organization	◻️
organization_metrics	read	See the usage metrics for a specific organization	Get organization usage	☑️
organization_usage	read	See the usage limits associated with a specific organization	Get organization limits	☑️
custom_roles	read	See existing custom roles for an organization	Get custom roles	◻️
custom_roles	write	Create custom roles for an organization	Create new custom roles	◻️
custom_roles	delete	Delete custom roles for an organization	Delete custom roles	◻️

Model Metadata & Schema Related Permissions

Resource	Action	Description	Sample API Endpoints	Needed in UI?
model	read	See all models in an organization. A model object includes the model metadata and attribute schema but not the underlying model data.	Get all models	☑️
model	write	Create and edit a model	Create a model, Edit a model	☑️
model	delete	Archive models	Archive a model	☑️
tag	read	See all tags across all models	Get tags	☑️
tag	write	Edit existing tags	Edit tag	◻️
tag	delete	Delete a tag	Delete tag	◻️
enrichment_config	read	See enrichment configs. An enrichment config describes which enrichments are enabled or disabled for a model and the necessary user inputs for that enrichment	Get all enrichment configs for a model	☑️
enrichment_config	write	Edit enrichment config. This allows you to enable or disable an enrichment for a model	Update enrichment configs for a model	◻️

What is a model in Arthur?

What is an enrichment?

What is a tag?

Model Data Related Permissions

Resource	Action	Description	Sample API Endpoints	Needed in UI?
raw_data	write	Send raw inferences for a model	Send inferences	◻️
raw_data	read	See raw inferences for a model and calculated enrichment values	Get single inference, Get explanation for inference	☑️
reference_data	write	Send reference data for a model	Upload a parquet file with reference data	◻️
reference_data	read	See reference data for a model	Get reference data	☑️
query	execute	Execute a query against the raw data of a model. NOTE: additional raw_data and reference_data permissions may also be needed depending on what data the query is trying to extract.	Execute a raw query	☑️
metric_query	read	See stored metric queries as well as the metric result value when that query is run against the raw model data	Get metrics, Get metric result	☑️
metric_query	write	Create a new metric query or edit an existing metric query	Create metric query	☑️
metric_query	delete	Delete a stored metric query	Delete metric query	☑️

What is an inference?

What is reference data?

What is a query?

What is a meric?

Alert & Insight Permissions

Resource	Action	Description	Sample API Endpoints	Needed in UI?
alert	read	See a triggered alert. An alert includes information about the configured alert rule and the triggered metric value	Get alerts	☑️
alert	resolve	Resolve a triggered alert	Update Alert Status	☑️
alert	notify	Sends an email notification for the given alert to the configured users and integrations	Send alert notification	☑️
insight	read	See generated insights. An insight includes information about a subset of inferences	Get insights	☑️
insight	resolve	Resolve a generated insight	Update insight status	☑️

What is an alert ?

What is an insight ?

Alert Configuration Related Permissions

Resource	Action	Description	Sample API Endpoints	Needed in UI?
alert_rule	read	See existing alert rules	Get alert rules	☑️
alert_rule	write	Create a new alert rule or edit an existing alert rule	Create an alert rule	☑️
alert_rule	delete	Delete an alert rule	Delete an alert rule	☑️
alert_notification_config	read	See existing alert notification configurations. An alert notification configuration determines the email destination that should be notified when an alert is triggered for a specific model.	Get alert notification configurations	☑️
alert_notification_config	write	Create a new alert notification configuration or edit an existing alert notification configuration	Create alert notification configuration	☑️
alert_notification_config	delete	Delete an alert notification configuration	Delete alert notification configuration	☑️
alert_summary_config	read	See existing alert summary configurations. Each alert summary configuration sets up a recurring alert summary report for a set of models	Get alert summary configurations	☑️
alert_summary_config	write	Create a new alert summary configuration or edit an existing alert sumamry configuration	Create alert sumamry configuration	☑️
alert_summary_config	delete	Delete an existing alert summary configuration	Delete alert summary configuration	☑️
alert_summary_subscriber	read	See existing alert summary subscribers. An alert sumamry subscriber is a user that will receive emails for a recurring alert summary report	Get alert summary subscribers	☑️
alert_summary_subscriber	write	Create a new alert summary subscriber or edit an existing alert summary subscriber	Create alert summary subscriber	☑️
alert_summary_subscriber	delete	Delete an existing alert summary subscriber	Delete alert summary subscriber	☑️

What is an alert rule?

What is alert notification?

What is an alert summary ?

What is an alert summary subscriber ?