List Organization Roles

GEThttps://api.confident-ai.com/v1/organization/roles

Lists the roles available to your organization. This includes both global, system-defined roles (where organizationId is null) and custom roles defined by your organization.

GET/v1/organization/roles

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

200

{
  "success": true,
  "data": {
    "roles": [
      {
        "id": "role-uuid-1",
        "name": "Admin",
        "description": "Full administrative access",
        "organizationId": null,
        "policies": [
          {
            "id": "policy-uuid-1",
            "name": "Manage projects"
          }
        ]
      },
      {
        "id": "role-uuid-3",
        "name": "Billing Manager",
        "description": "Can manage billing only",
        "organizationId": "ORGANIZATION-ID",
        "policies": [
          {
            "id": "policy-uuid-2",
            "name": "Manage billing"
          }
        ]
      }
    ]
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Response

successboolean
Indicates if the request was successful
dataobject
Show 1 propertyHide 1 property
- roleslist of objects
  List of roles available to the organization, 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
  - organizationIdstring
    The owning organization id, or null for global, system-defined roles that are available to every organization.
  - policieslist of objects
    The policies attached to this role
    Show 2 propertiesHide 2 properties
    idstring
    Unique identifier
    namestring
    Name

Built byConfident AI