Rbac

Update role

Partial update. Omitted fields preserve the current value. Notable: omitting dac preserves the current scope (does not default to all-data).

PUT
/api/roles/{id}
AuthorizationBearer <token>

Bearer token authentication. Use your MPilot virtual-key JWT or admin JWT. Virtual keys (prefixed with sk-bf-) can also be passed here.

In: header

Path Parameters

idinteger
name?string

If supplied (and different from current), must match the role-name regex.

Lengthlength <= 255
description?string
dac?string

Data access scope. Determines which rows members of the role can see.

  • own-data - Only rows the member personally owns.
  • team-data - Own rows plus rows owned by any team they belong to.
  • all-data - No row filtering.
Value in"own-data" | "team-data" | "all-data"

Response Body

curl -X PUT "https://loading/{AI_GATEWAY_URL}/api/roles/0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "role": {
    "id": 0,
    "name": "string",
    "description": "string",
    "is_system_role": true,
    "dac": "own-data",
    "created_by_user_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}
Empty
{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}
On this page

On this page

No Headings