List Project Roles

GEThttps://api.confident-ai.com/v1/projects/{projectId}/roles

Lists the roles available to a project. This includes both global, system-defined roles (where projectId is null) and custom roles defined for the project.

GET/v1/projects/{projectId}/roles

curl -X GET "https://api.confident-ai.com/v1/projects/{projectId}/roles" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"

200

{
  "success": true,
  "data": {
    "roles": [
      {
        "id": "project-role-uuid-1",
        "name": "Owner",
        "description": "Owner of the project with full access to all resources.",
        "projectId": null,
        "policies": []
      },
      {
        "id": "project-role-uuid-3",
        "name": "Analyst",
        "description": "Read-only project access",
        "projectId": "PROJECT-ID",
        "policies": [
          {
            "id": "policy-uuid-1",
            "name": "View traces"
          }
        ]
      }
    ]
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

projectIdstringRequired
The unique identifier of the project.

Response

successboolean
Indicates if the request was successful
dataobject
Show 1 propertyHide 1 property
- roleslist of objects
  List of roles available to the project, including global system roles
  Show 5 propertiesHide 5 properties
  - idstring
    Unique identifier for the role
  - namestring
    Name of the role
  - descriptionstring
    Optional description of the role
  - projectIdstring
    The owning project id, or null for global, system-defined roles that are available to every project.
  - policieslist of objects
    The policies attached to this role
    Show 2 propertiesHide 2 properties
    idstring
    Unique identifier
    namestring
    Name

Built byConfident AI