For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Trust CenterStatusSupportGet a demoPlatform
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
    • Data Models
    • API Conventions
  • Data Models
      • GETRetrieve Organization
      • PUTUpdate Organization
        • GETList Organization Roles
        • POSTCreate Organization Role
        • PUTUpdate Organization Role
        • DELDelete Organization Role
  • Evals
  • Legacy
LogoLogo
Trust CenterStatusSupportGet a demoPlatform
Data ModelsOrganizationRoles

Update Organization Role

PUT
https://api.confident-ai.com/v1/organization/roles/:roleId
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",
>  "policyIds": [
>    "policy-uuid-2"
>  ],
>  "description": "Can manage billing and view usage"
>}'
200Updated
1{
2  "success": true,
3  "data": {
4    "role": {
5      "id": "role-uuid-3",
6      "name": "Billing Manager",
7      "description": "Can manage billing and view usage",
8      "organizationId": "ORGANIZATION-ID",
9      "policies": [
10        {
11          "id": "policy-uuid-2",
12          "name": "Manage billing"
13        }
14      ]
15    }
16  }
17}
Updates a custom organization role's name, description, or policies. Global roles cannot be modified.
Was this page helpful?
Previous

Delete Organization Role

Next
Built with

Path parameters

roleIdstringRequired
The unique identifier of the role.

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Request

This endpoint expects an object.
namestringRequired

Name of the role (must be unique within the organization and cannot be a system role name)

policyIdslist of stringsRequired
The ids of the policies to attach to this role
descriptionstring or nullOptional
Optional description of the role

Response

successboolean
Indicates if the request was successful
dataobject