Arthur Permissions by Endpoint

For more details on the expected schema for each endpoint, see Authorization API Documentation. If an endpoint is not listed here, there is no authorization restriction on that endpoint, and all authenticated users should be able to access it.

For more details on the expected schema for each endpoint, see authorization. If an endpoint is not listed here, there is no authorization restriction on it, and all authenticated users should be able to access it.

Org, User, and Authorization Related Permissions

PermissionEndpointRESTResource in SystemAction
Get all organizations/organizationsGETorganization_globalread
Create an organization/organizationsPOSTorganization_globalwrite
Get an organization/organizations/{organization_id}GETorganizationread
Delete an organization/organizations/{organization_id}DELETEorganizationdelete
Add users to an organization/organizations/{organization_id}/usersPATCHuserwrite
Create user/usersPOSTuserwrite
Get all users/usersGETuserread
Get current user/users/meGETN/AN/A
Update current user/users/mePATCHN/AN/A
Get user/users/{user_id}GETuserread
Update user/users/{user_id}PATCHuserwrite
Delete user/users/{user_id}DELETEuserdelete
Invite a new user/users/invite_usersPOSTinvite_userwrite
Get Current Authentication Info/users/me/auth_infoGETN/AN/A
Get Permssions for a role/authorization/permissionsGETN/AN/A
Check Authorization for a permission and role/authorization/authorizePOSTN/AN/A
Create Custom roles for RBAC/authorization/custom_rolesPOSTcustom_roleswrite
Delete Custom Roles for RBAC/authorization/custom_rolesDELETEcustom_rolesdelete
Get configured custom roles for RBAC/authorization/custom_rolesGETcustom_rolesread
Get current organization of session/organizations/currentGETN/AN/A
Set current organization of session/organizations/currentPUTN/AN/A
Get usage/usage/{rollup}GETorganization_metricsread

Model and Data Related Permissions

PermissionEndpointRESTResource in SystemAction
Get models/modelsGETmodelread
Create a model/modelsPOSTmodelwrite
Get a model's health score (most recent)/models/healthGETmodelread
Get model/models/{model_id}GETmodelread
Update model/models/{model_id}PUTmodelwrite
Delete model/models/{model_id}DELETEmodeldelete
Get model bias groups/models/{model_id}/bias_groupsGETmodelread
Get attributes/models/{model_id}/attributesGETmodelread
Update attributes/models/{model_id}/attributesPUTmodelwrite
Edit model attributes/models/{model_id}/attributesPATCHmodelwrite
Delete model attributes/models/{model_id}/attributesDELETEmodeldelete
Get an attribute/models/{model_id}/attributes/{attribute_id}GETmodelread
Update an attribute/models/{model_id}/attributes/{attribute_id}PUTmodelwrite
Delete an attribute/models/{model_id}/attributes/{attribute_id}DELETEmodeldelete
Get tags/tagsGETtagread
Update a tag/tags/{tag_name}PUTtagwrite
Delete a tag/tags/{tag_name}DELETEtagdelete
Get model groups/model_groupsGETmodelread
Get a model group/model_groups/{model_group_id}GETmodelread
Update a model group/model_groups/{model_group_id}PATCHmodelwrite
Delete a model group/model_groups/{model_group_id}DELETEmodeldelete
Get a model group's versions/model_groups/{model_group_id}/versionsGETmodelread
Get latest version for a model group/model_groups/{model_group_id}/versions/latestGETmodelread
Retrieve the prediction and explanation for an inference/models/{model_id}/what_ifPOSTraw_dataread
Generate on-demand explanation for an inference/models/{model_id}/inferences/{partner_inference_id}/explanationGETraw_dataread
Save inferences/models/{model_id}/inferencesPOSTraw_datawrite
Save inferences from file/models/{model_id}/inferences/filePOSTraw_datawrite
Update inferences/models/{model_id}/inferencesPATCHraw_datawrite
Get image inference/models/{model_id}/inferences/images/{image_id}GETraw_dataread
Get batch information for batch of a model/models/{model_id}/batches/{batch_id}GETraw_dataread
Closes a batch/models/{model_id}/batches/{batch_id}PATCHraw_datawrite
Get inference/models/{model_id}/inferences/query/{partner_inference_id}GETraw_dataread
Get all datasets for a model/models/{model_id}/datasetsGETraw_dataread
Get reference data information for model/models/{model_id}/reference_dataGETreference_dataread
Closes a reference dataset/models/{model_id}/reference_dataPATCHreference_datawrite
Uploads a parquet file containing reference set data/models/{model_id}/reference_dataPOSTreference_datawrite
Execute query/models/{model_id}/inferences/queryPOSTquery (✱ see footnote)execute
Execute query and retrun data drift values/models/{model_id}/inferences/query/data_driftPOSTqueryexecute
Execute query and return psi buckets/models/{model_id}/inferences/query/data_drift_psi_bucket_calculation_tablePOSTqueryexecute
Execute query and return scatterplot distributions/models/{model_id}/inferences/query/distributionPOSTqueryexecute
Get bias mitigation curves/models/{model_id}/bias_mitigation_curves/attributes/{attribute_id}GETraw_dataread
Get bias mitigation curves/models/{model_id}/enrichments/bias_mitigation/curvesGETraw_dataread
Find Hotspots/models/{model_id}/enrichments/hotspots/findGETraw_dataread
Get metric queries/models/{model_id}/metricsGETmetric_queryread
Create a metric query/models/{model_id}/metricsPOSTmetric_querywrite
Get a metric query/models/{model_id}/metrics/{metric_id}GETmetric_queryread
Update a metric query/models/{model_id}/metrics/{metric_id}PUTmetric_querywrite
Delete a metric query/models/{model_id}/metrics/{metric_id}DELETEmetric_querydelete
Get all enrichment configs/models/{model_id}/enrichmentsGETenrichment_configread
Update an enrichment config/models/{model_id}/enrichmentsPATCHenrichment_configwrite
Get explainability config/models/{model_id}/enrichments/explainabilityGETenrichment_configread
Update explainability config/models/{model_id}/enrichments/explainabilityPATCHenrichment_configwrite
Get anomaly detection config/models/{model_id}/enrichments/anomaly_detectionGETenrichment_configread
Update anomaly detection config/models/{model_id}/enrichments/anomaly_detectionPATCHenrichment_configwrite
Get bias mitigation config/models/{model_id}/enrichments/bias_mitigationGETenrichment_configread
Update bias mitigation config/models/{model_id}/enrichments/bias_mitigationPATCHenrichment_configwrite
Get hotspots config/models/{model_id}/enrichments/hotspotsGETenrichment_configread
Update hotspots config/models/{model_id}/enrichments/hotspotsPATCHenrichment_configwrite

query requires both query|execute permissions as well as EITHER raw_data|read OR reference_data|read permissions depending on what the posted query is.

Alert Related Permissions

PermissionEndpointRESTResource in SystemAction
Create an alert rule/models/{model_id}/alert_rulesPOSTalert_rulewrite
Get alert rules/models/{model_id}/alert_rulesGETalert_ruleread
Delete an alert rule/models/{model_id}/alert_rules/{alert_rule_id}DELETEalert_ruledelete
Edit an alert rule/models/{model_id}/alert_rules/{alert_rule_id}PATCHalert_rulewrite
Bulk resolve alert for an alert rule/models/{model_id}/alert_rules/{alert_rule_id}/bulk_alertsPATCHalertresolve
Get alerts/alertsGETalertread
Get alert counts by model/alerts/model_countsGETalertread
Update alert status/alerts/{alert_id}PATCHalertresolve
Send manual alert notification/alerts/{alert_id}/notificationsPOSTalertnotify
Get alert notification configurations/alert_notification_configurationsGETalert_notification_configread
Create an alert notification configuration/alert_notification_configurationsPOSTalert_notification_configwrite
Get an alert notification configuration/alert_notification_configurations/{configuration_id}GETalert_notification_configread
Edit an alert notification configuration/alert_notification_configurations/{configuration_id}PATCHalert_notification_configwrite
Delete an alert notification configuration/alert_notification_configurations/{configuration_id}DELETEalert_notification_configdelete
Get insights/models/{model_id}/insightsGETinsightread
Update the status of insights/models/{model_id}/insightsPATCHinsightresolve
Get an insight/models/{model_id}/insights/{insight_id}GETinsightwrite
Update the status of an insight/models/{model_id}/insights/{insight_id}PATCHinsightresolve
Get all alert summary configurations/alert_summary_configurationsGETalert_summary_configread
Create an alert summary configuration/alert_summary_configurationsPOSTalert_summary_configwrite
Get an alert summary configuration/alert_summary_configurations/{configuration_id}GETalert_summary_configread
Delete an alert summary configuration/alert_summary_configurations/{configuration_id}DELETEalert_summary_configdelete
Update an alert summary configuration/alert_summary_configurations/{configuration_id}PATCHalert_summary_configwrite
Get all alert summary subscribers/alert_summary_configurations/{configuration_id}/subscribersGETalert_summary_subscriberread
Create an alert summary subscriber/alert_summary_configurations/{configuration_id}/subscribersPOSTalert_summary_subscriberwrite
Get an alert summary subscriber/alert_summary_configurations/{configuration_id}/subscribers/{subscriber_id}GETalert_summary_subscriberread
Update an alert summary subscriber/alert_summary_configurations/{configuration_id}/subscribers/{subscriber_id}PATCHalert_summary_subscriberwrite
Delete an alert summary subscriber/alert_summary_configurations/{configuration_id}/subscribers/{subscriber_id}DELETEalert_summary_subscriberdelete
Send manual alert summary notifications to subscribers/alert_summary_configurations/{configuration_id}/notificationsPOSTalert_summarynotify