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
Permission | Endpoint | REST | Resource in System | Action |
---|---|---|---|---|
Get all organizations | /organizations | GET | organization_global | read |
Create an organization | /organizations | POST | organization_global | write |
Get an organization | /organizations/{organization_id} | GET | organization | read |
Delete an organization | /organizations/{organization_id} | DELETE | organization | delete |
Add users to an organization | /organizations/{organization_id}/users | PATCH | user | write |
Create user | /users | POST | user | write |
Get all users | /users | GET | user | read |
Get current user | /users/me | GET | N/A | N/A |
Update current user | /users/me | PATCH | N/A | N/A |
Get user | /users/{user_id} | GET | user | read |
Update user | /users/{user_id} | PATCH | user | write |
Delete user | /users/{user_id} | DELETE | user | delete |
Invite a new user | /users/invite_users | POST | invite_user | write |
Get Current Authentication Info | /users/me/auth_info | GET | N/A | N/A |
Get Permssions for a role | /authorization/permissions | GET | N/A | N/A |
Check Authorization for a permission and role | /authorization/authorize | POST | N/A | N/A |
Create Custom roles for RBAC | /authorization/custom_roles | POST | custom_roles | write |
Delete Custom Roles for RBAC | /authorization/custom_roles | DELETE | custom_roles | delete |
Get configured custom roles for RBAC | /authorization/custom_roles | GET | custom_roles | read |
Get current organization of session | /organizations/current | GET | N/A | N/A |
Set current organization of session | /organizations/current | PUT | N/A | N/A |
Get usage | /usage/{rollup} | GET | organization_metrics | read |
Model and Data Related Permissions
Permission | Endpoint | REST | Resource in System | Action |
---|---|---|---|---|
Get models | /models | GET | model | read |
Create a model | /models | POST | model | write |
Get a model's health score (most recent) | /models/health | GET | model | read |
Get model | /models/{model_id} | GET | model | read |
Update model | /models/{model_id} | PUT | model | write |
Delete model | /models/{model_id} | DELETE | model | delete |
Get model bias groups | /models/{model_id}/bias_groups | GET | model | read |
Get attributes | /models/{model_id}/attributes | GET | model | read |
Update attributes | /models/{model_id}/attributes | PUT | model | write |
Edit model attributes | /models/{model_id}/attributes | PATCH | model | write |
Delete model attributes | /models/{model_id}/attributes | DELETE | model | delete |
Get an attribute | /models/{model_id}/attributes/{attribute_id} | GET | model | read |
Update an attribute | /models/{model_id}/attributes/{attribute_id} | PUT | model | write |
Delete an attribute | /models/{model_id}/attributes/{attribute_id} | DELETE | model | delete |
Get tags | /tags | GET | tag | read |
Update a tag | /tags/{tag_name} | PUT | tag | write |
Delete a tag | /tags/{tag_name} | DELETE | tag | delete |
Get model groups | /model_groups | GET | model | read |
Get a model group | /model_groups/{model_group_id} | GET | model | read |
Update a model group | /model_groups/{model_group_id} | PATCH | model | write |
Delete a model group | /model_groups/{model_group_id} | DELETE | model | delete |
Get a model group's versions | /model_groups/{model_group_id}/versions | GET | model | read |
Get latest version for a model group | /model_groups/{model_group_id}/versions/latest | GET | model | read |
Retrieve the prediction and explanation for an inference | /models/{model_id}/what_if | POST | raw_data | read |
Generate on-demand explanation for an inference | /models/{model_id}/inferences/{partner_inference_id}/explanation | GET | raw_data | read |
Save inferences | /models/{model_id}/inferences | POST | raw_data | write |
Save inferences from file | /models/{model_id}/inferences/file | POST | raw_data | write |
Update inferences | /models/{model_id}/inferences | PATCH | raw_data | write |
Update ground truth | /models/{model_id}/ground_truth | PATCH | ground_truth | write |
Get image inference | /models/{model_id}/inferences/images/{image_id} | GET | raw_data | read |
Get batch information for batch of a model | /models/{model_id}/batches/{batch_id} | GET | raw_data | read |
Closes a batch | /models/{model_id}/batches/{batch_id} | PATCH | raw_data | write |
Get inference | /models/{model_id}/inferences/query/{partner_inference_id} | GET | raw_data | read |
Get all datasets for a model | /models/{model_id}/datasets | GET | raw_data | read |
Get reference data information for model | /models/{model_id}/reference_data | GET | reference_data | read |
Closes a reference dataset | /models/{model_id}/reference_data | PATCH | reference_data | write |
Uploads a parquet or json file containing reference set data | /models/{model_id}/reference_data | POST | reference_data | write |
Execute query | /models/{model_id}/inferences/query | POST | query (✱ see footnote) | execute |
Execute query and retrun data drift values | /models/{model_id}/inferences/query/data_drift | POST | query | execute |
Execute query and return psi buckets | /models/{model_id}/inferences/query/data_drift_psi_bucket_calculation_table | POST | query | execute |
Execute query and return scatterplot distributions | /models/{model_id}/inferences/query/distribution | POST | query | execute |
Get bias mitigation curves | /models/{model_id}/bias_mitigation_curves/attributes/{attribute_id} | GET | raw_data | read |
Get bias mitigation curves | /models/{model_id}/enrichments/bias_mitigation/curves | GET | raw_data | read |
Find Hotspots | /models/{model_id}/enrichments/hotspots/find | GET | raw_data | read |
Get metric queries | /models/{model_id}/metrics | GET | metric_query | read |
Create a metric query | /models/{model_id}/metrics | POST | metric_query | write |
Get a metric query | /models/{model_id}/metrics/{metric_id} | GET | metric_query | read |
Update a metric query | /models/{model_id}/metrics/{metric_id} | PUT | metric_query | write |
Delete a metric query | /models/{model_id}/metrics/{metric_id} | DELETE | metric_query | delete |
Get all enrichment configs | /models/{model_id}/enrichments | GET | enrichment_config | read |
Update an enrichment config | /models/{model_id}/enrichments | PATCH | enrichment_config | write |
Get explainability config | /models/{model_id}/enrichments/explainability | GET | enrichment_config | read |
Update explainability config | /models/{model_id}/enrichments/explainability | PATCH | enrichment_config | write |
Get anomaly detection config | /models/{model_id}/enrichments/anomaly_detection | GET | enrichment_config | read |
Update anomaly detection config | /models/{model_id}/enrichments/anomaly_detection | PATCH | enrichment_config | write |
Get bias mitigation config | /models/{model_id}/enrichments/bias_mitigation | GET | enrichment_config | read |
Update bias mitigation config | /models/{model_id}/enrichments/bias_mitigation | PATCH | enrichment_config | write |
Get hotspots config | /models/{model_id}/enrichments/hotspots | GET | enrichment_config | read |
Update hotspots config | /models/{model_id}/enrichments/hotspots | PATCH | enrichment_config | write |
Get Pinned Columns | /models/{model_id}/pinned_columns | GET | pinned_columns | read |
Set Pinned Columns | /models/{model_id}/pinned_columns | PUT | pinned_columns | write |
Add/Remove Pinned Columns | /models/{model_id}/pinned_columns | PATCH | pinned_columns | write |
Delete Pinned Columns | /models/{model_id}/pinned_columns | DELETE | pinned_columns | delete |
✱ 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
Permission | Endpoint | REST | Resource in System | Action |
---|---|---|---|---|
Create an alert rule | /models/{model_id}/alert_rules | POST | alert_rule | write |
Get alert rules | /models/{model_id}/alert_rules | GET | alert_rule | read |
Delete an alert rule | /models/{model_id}/alert_rules/{alert_rule_id} | DELETE | alert_rule | delete |
Edit an alert rule | /models/{model_id}/alert_rules/{alert_rule_id} | PATCH | alert_rule | write |
Bulk resolve alert for an alert rule | /models/{model_id}/alert_rules/{alert_rule_id}/bulk_alerts | PATCH | alert | resolve |
Get alerts | /alerts | GET | alert | read |
Get alert counts by model | /alerts/model_counts | GET | alert | read |
Update alert status | /alerts/{alert_id} | PATCH | alert | resolve |
Send manual alert notification | /alerts/{alert_id}/notifications | POST | alert | notify |
Get alert notification configurations | /alert_notification_configurations | GET | alert_notification_config | read |
Create an alert notification configuration | /alert_notification_configurations | POST | alert_notification_config | write |
Get an alert notification configuration | /alert_notification_configurations/{configuration_id} | GET | alert_notification_config | read |
Edit an alert notification configuration | /alert_notification_configurations/{configuration_id} | PATCH | alert_notification_config | write |
Delete an alert notification configuration | /alert_notification_configurations/{configuration_id} | DELETE | alert_notification_config | delete |
Get insights | /models/{model_id}/insights | GET | insight | read |
Update the status of insights | /models/{model_id}/insights | PATCH | insight | resolve |
Get an insight | /models/{model_id}/insights/{insight_id} | GET | insight | write |
Update the status of an insight | /models/{model_id}/insights/{insight_id} | PATCH | insight | resolve |
Get all alert summary configurations | /alert_summary_configurations | GET | alert_summary_config | read |
Create an alert summary configuration | /alert_summary_configurations | POST | alert_summary_config | write |
Get an alert summary configuration | /alert_summary_configurations/{configuration_id} | GET | alert_summary_config | read |
Delete an alert summary configuration | /alert_summary_configurations/{configuration_id} | DELETE | alert_summary_config | delete |
Update an alert summary configuration | /alert_summary_configurations/{configuration_id} | PATCH | alert_summary_config | write |
Get all alert summary subscribers | /alert_summary_configurations/{configuration_id}/subscribers | GET | alert_summary_subscriber | read |
Create an alert summary subscriber | /alert_summary_configurations/{configuration_id}/subscribers | POST | alert_summary_subscriber | write |
Get an alert summary subscriber | /alert_summary_configurations/{configuration_id}/subscribers/{subscriber_id} | GET | alert_summary_subscriber | read |
Update an alert summary subscriber | /alert_summary_configurations/{configuration_id}/subscribers/{subscriber_id} | PATCH | alert_summary_subscriber | write |
Delete an alert summary subscriber | /alert_summary_configurations/{configuration_id}/subscribers/{subscriber_id} | DELETE | alert_summary_subscriber | delete |
Send manual alert summary notifications to subscribers | /alert_summary_configurations/{configuration_id}/notifications | POST | alert_summary | notify |
Updated 11 months ago