Update Organization Role

PUThttps://api.confident-ai.com/v1/organization/roles/{roleId}

Updates a custom organization role's name, description, or policies. Global roles cannot be modified.

PUT/v1/organization/roles/{roleId}

curl -X PUT "https://api.confident-ai.com/v1/organization/roles/{roleId}" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Billing Manager",
  "description": "Can manage billing and view usage",
  "policyIds": [
    "policy-uuid-2"
  ]
}'

200

{
  "success": true,
  "data": {
    "role": {
      "id": "role-uuid-3",
      "name": "Billing Manager",
      "description": "Can manage billing and view usage",
      "organizationId": "ORGANIZATION-ID",
      "policies": [
        {
          "id": "policy-uuid-2",
          "name": "Manage billing"
        }
      ]
    }
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

roleIdstringRequired
The unique identifier of the role.

Request body

namestringRequired
Name of the role (must be unique within the organization and cannot be a system role name)
descriptionstring
Optional description of the role
policyIdslist of stringsRequired
The ids of the policies to attach to this role

Response

successboolean
Indicates if the request was successful
dataobject
Show 1 propertyHide 1 property
- roleobject
  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