🐰 New: Triage — a self-updating cross-repository queue that prioritizes pull requests by value and risk, so you always know what to review next. Explore Triage →
{
"error": {
"code": "LEGACY_API_KEY",
"message": "You are using a legacy API key. We are deprecating use of legacy keys. Regenerate a new API key and retry the request."
}
}
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Max 10 requests per 60 seconds"
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error while listing users"
}
}
Roles
Bulk change roles for users in the organization. Supports up to 500 users per request. Cannot modify billing admin roles. Rate limited to 10 requests per 60 seconds with max 3 concurrent requests per organization. Requires user_management:write and an Enterprise plan.
{
"error": {
"code": "LEGACY_API_KEY",
"message": "You are using a legacy API key. We are deprecating use of legacy keys. Regenerate a new API key and retry the request."
}
}
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Max 10 requests per 60 seconds"
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error while listing users"
}
}
Required for workspace-scoped API keys: the provider organization ID within the workspace. For self-hosted instance keys, use a provider organization ID or ALL (case-insensitive) to apply the role change across active organizations on that instance. Omit it to preserve single-organization behavior for self-hosted keys. Organization keys remain bound to their own organization; ALL is valid only for self-hosted instance keys.
Minimum string length: 1
Response
Operation completed (check status field for partial failures)
Response for bulk operations with partial success model
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CodeRabbit","description":"Guides for Agentic Change Management: review, prioritize, understand, and secure changes across pull requests, your IDE, CLI, and team chat.","colors":{"primary":"#FF570A","light":"#FF570A","dark":"#FF570A"},"logo":{"light":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=d2bf9e91be0e760ec9cb468676fa6ab6","dark":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-dark.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=feeb1667ed4a2768a15b271f130395c0","href":"/"},"favicon":{"light":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/favicon-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=c0b0fbea23b48949cc631606f2a30022","dark":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/favicon-dark.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=4db7fc04860b6907c7f236f05b37f5c6"},"api":{"openapi":"openapi.json","playground":{"display":"simple"}},"navbar":{"primary":{"type":"button","label":"Sign up","href":"https://app.coderabbit.ai/login?free-trial="}},"footer":{"socials":{"x":"https://x.com/coderabbitai","linkedin":"https://www.linkedin.com/company/coderabbitai","github":"https://github.com/coderabbitai","discord":"https://discord.gg/GsXnASn26c"},"links":[{"header":"Resources","items":[{"label":"Blog","href":"https://coderabbit.ai/blog"},{"label":"Pricing","href":"https://www.coderabbit.ai/pricing"},{"label":"Changelog","href":"https://docs.coderabbit.ai/changelog"},{"label":"Support knowledge base","href":"https://kb.coderabbit.ai"}]},{"header":"Quick links","items":[{"label":"Schedule a demo","href":"https://www.coderabbit.ai/contact-us/sales"},{"label":"Get support","href":"https://docs.coderabbit.ai/support"},{"label":"Status page","href":"https://status.coderabbit.ai"},{"label":"Terms of service","href":"https://www.coderabbit.ai/terms-of-service"},{"label":"Privacy Policy","href":"https://coderabbit.ai/privacy-policy"}]}]},"seo":{"metatags":{"description":"Guides for Agentic Change Management: review, prioritize, understand, and secure changes across pull requests, your IDE, CLI, and team chat.","og:type":"website","og:site_name":"CodeRabbit Documentation","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@coderabbitai","canonical":"https://docs.coderabbit.ai"}},"fonts":{"heading":{"family":"Geist"},"body":{"family":"Geist"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"gtm":{"tagId":"GTM-5BWLXJRC"},"posthog":{"apiKey":"phc_6fDZRN9hYzB83I7Fk2GNHYqas4WMIdGBQ58aZ6EOZR0"}},"banner":{"content":"🐰 New: **Triage** — a self-updating cross-repository queue that prioritizes pull requests by value and risk, so you always know what to review next. [Explore Triage →](/triage)","dismissible":true,"type":"info","color":{"light":"#171717","dark":"#171717"}},"errors":{"404":{"redirect":false,"title":"Page Not Found. Sorry!","description":"Try **Search** or **Ask AI** to find what you're looking for.\nPress \u003ckbd>⌘K\u003c/kbd> (Mac) or \u003ckbd>Ctrl+K\u003c/kbd> (Windows/Linux) to open the search.\n\n\nNeed help? [Get support](/support)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Quickstart","icon":"rocket","hidden":false,"href":"/getting-started/quickstart"},{"anchor":"Blog","icon":"pen-line","hidden":true,"href":"https://coderabbit.ai/blog"},{"anchor":"Changelog","icon":"history","href":"/changelog"},{"anchor":"Support","icon":"life-buoy","href":"/support"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/coderabbit"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"coderabbit","hasAudioNarration":false,"actualSubdomain":"coderabbit","customDomains":["docs.coderabbit.ai"],"gitSource":{"type":"github","owner":"coderabbitai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af307b8e49ad3dd9a8e80c1","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Management","count":241},{"language":"default","tag":"CodeRabbit API","count":188},{"language":"default","tag":"Platform API","count":170},{"language":"default","tag":"Platform API reference","count":165},{"language":"default","tag":"CodeRabbit Platform","count":158},{"language":"default","tag":"Tools","count":62},{"language":"default","tag":"Per-tool guides","count":59},{"language":"default","tag":"Languages","count":39},{"language":"default","tag":"CLI and IDE tools","count":33},{"language":"default","tag":"Security","count":26}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/platform/roles","slug":"/api-reference/platform/roles","pageMetadata":{"title":"Roles","description":"Bulk change roles for users in the organization. Supports up to 500 users per request. Cannot modify billing admin roles. Rate limited to 10 requests per 60 seconds with max 3 concurrent requests per organization. Requires user_management:write and an Enterprise plan.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/users/roles","href":"/api-reference/platform/roles","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Bulk change roles for users in the organization. Supports up to 500 users per request. Cannot modify billing admin roles. Rate limited to 10 requests per 60 seconds with max 3 concurrent requests per organization. Requires user_management:write and an Enterprise plan.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Roles","description":"Bulk change roles for users in the organization. Supports up to 500 users per request. Cannot modify billing admin roles. Rate limited to 10 requests per 60 seconds with max 3 concurrent requests per organization. Requires user_management:write and an Enterprise plan.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/users/roles","href":"/api-reference/platform/roles","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/coderabbit/c83587702ff75216/inkeep.js","/_mintlify/custom/coderabbit/b7ecafa4358af1c7/yaml-editor.js","/_mintlify/custom/coderabbit/44fd990531d7b83e/acquisition.js"],"openApiReferenceData":{"operation":{"operationId":"change-roles","summary":"Roles","description":"Bulk change roles for users in the organization. Supports up to 500 users per request. Cannot modify billing admin roles. Rate limited to 10 requests per 60 seconds with max 3 concurrent requests per organization. Requires user_management:write and an Enterprise plan.","parameters":["b8de93fe-85ee-4c36-90fd-9f5ecf678e53"],"requestBody":"665d093a-0368-43b9-b323-ea1342dc0abf","responses":{"200":"44da015b-acc5-4bb5-8b8e-0f671412dd60","400":"5c438ca0-7405-4da7-b4f0-b3fadf2057ba","401":"4bafdb4a-b428-4cb4-b557-22968ab3856b","403":"c6de83b5-66e5-4be8-92ab-9492725c9ce4","410":"d176640a-af50-4b55-b01e-c73a3a08fe63","429":"6734f98e-8fc0-480c-82f7-aad302806dce","500":"89836efd-7466-4552-bf88-c42adcb68d25"},"security":["f99af91f-f0d6-49b2-ac33-c15f8ab44188"],"method":"post","type":"path","servers":["94307302-b1ff-453f-b134-032a703d9dae"],"path":"/v1/users/roles","baseUrlOptions":["https://api.coderabbit.ai"],"title":"Roles","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b8de93fe-85ee-4c36-90fd-9f5ecf678e53":{"name":"x-coderabbitai-api-key","description":"Your CodeRabbit API key","required":true,"example":"cr-xxxxxxxxxx","schema":{"type":"string","isRequired":true,"description":"Your CodeRabbit API key","uniqueKey":"","typeLabel":"string"},"in":"header"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request to change user roles","properties":{"role":{"type":"string","description":"Role ID to assign. Use cr_admin, cr_member, or a custom role UUID. cr_billing_admin cannot be assigned through this endpoint.","minLength":1,"isRequired":true,"uniqueKey":"role","typeLabel":"string"},"user_ids":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"user_ids.items.[INDEX]","typeLabel":"string"},"description":"Array of provider user IDs","minItems":1,"maxItems":500,"isRequired":true,"uniqueKey":"user_ids","typeLabel":"string[]"},"org_id":{"type":"string","description":"Required for workspace-scoped API keys: the provider organization ID within the workspace. For self-hosted instance keys, use a provider organization ID or ALL (case-insensitive) to apply the role change across active organizations on that instance. Omit it to preserve single-organization behavior for self-hosted keys. Organization keys remain bound to their own organization; ALL is valid only for self-hosted instance keys.","minLength":1,"uniqueKey":"org_id","typeLabel":"string"}},"required":["role","user_ids"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"promote":{"title":"promote","value":{"role":"cr_admin","user_ids":["121358802","22605247"]}},"demote":{"title":"demote","value":{"role":"cr_member","user_ids":["121358802","22605247"]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"44da015b-acc5-4bb5-8b8e-0f671412dd60":{"description":"Operation completed (check status field for partial failures)","content":{"application/json":{"schema":{"type":"object","description":"Response for bulk operations with partial success model","properties":{"status":{"type":"string","enum":["success","partial_success","failure"],"description":"Operation status: 'success' if all succeeded, 'partial_success' if some succeeded, 'failure' if all failed","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"succeeded":{"type":"array","items":{"type":"string","uniqueKey":"succeeded.items.[INDEX]","typeLabel":"string"},"description":"Array of user IDs that were successfully processed","isRequired":true,"uniqueKey":"succeeded","typeLabel":"string[]"},"failed":{"type":"array","items":{"type":"object","description":"Failed operation details","properties":{"user_id":{"type":"string","description":"Identifier that failed: a provider user ID, or the supplied `cr_user_id`/`email` when the request used a workspace API key","isRequired":true,"uniqueKey":"failed.items.[INDEX].user_id","typeLabel":"string"},"code":{"type":"string","description":"Error code","isRequired":true,"uniqueKey":"failed.items.[INDEX].code","typeLabel":"string"}},"required":["user_id","code"],"additionalProperties":false,"uniqueKey":"failed.items.[INDEX]","typeLabel":"object"},"description":"Array of failures with error details","isRequired":true,"uniqueKey":"failed","typeLabel":"object[]"}},"required":["status","succeeded","failed"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"status":"success","succeeded":["121358802","22605247"],"failed":[]},"examples":{"Example":{"title":"Example","value":{"status":"success","succeeded":["121358802","22605247"],"failed":[]}}},"exampleType":"examples"}},"headers":{"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"Maximum requests allowed per time window (10)"},"X-RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Requests remaining in current window"},"X-RateLimit-Reset":{"description":"Unix timestamp when the rate limit resets","schema":{"type":"integer"}}},"exampleType":"examples"},"5c438ca0-7405-4da7-b4f0-b3fadf2057ba":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"BATCH_SIZE_EXCEEDED","message":"Maximum 500 users per request"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"BATCH_SIZE_EXCEEDED","message":"Maximum 500 users per request"}}}},"exampleType":"examples"}},"exampleType":"examples"},"4bafdb4a-b428-4cb4-b557-22968ab3856b":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHORIZED","message":"Invalid or inactive API key"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"Invalid or inactive API key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c6de83b5-66e5-4be8-92ab-9492725c9ce4":{"description":"Forbidden - Not an admin or missing Enterprise plan","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"NOT_ADMIN","message":"Only administrators can perform seat management operations"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_ADMIN","message":"Only administrators can perform seat management operations"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d176640a-af50-4b55-b01e-c73a3a08fe63":{"description":"Legacy API key - deprecated and no longer supported for user management","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"LEGACY_API_KEY","message":"You are using a legacy API key. We are deprecating use of legacy keys. Regenerate a new API key and retry the request."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"LEGACY_API_KEY","message":"You are using a legacy API key. We are deprecating use of legacy keys. Regenerate a new API key and retry the request."}}}},"exampleType":"examples"}},"exampleType":"examples"},"6734f98e-8fc0-480c-82f7-aad302806dce":{"description":"Rate limit exceeded (10 requests per 60 seconds per organization)","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Rate limit exceeded. Max 10 requests per 60 seconds"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Rate limit exceeded. Max 10 requests per 60 seconds"}}}},"exampleType":"examples"}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed per time window","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Always 0 when rate limited","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp when the rate limit resets","schema":{"type":"integer"}}},"exampleType":"examples"},"89836efd-7466-4552-bf88-c42adcb68d25":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INTERNAL_ERROR","message":"Internal server error while listing users"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_ERROR","message":"Internal server error while listing users"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"f99af91f-f0d6-49b2-ac33-c15f8ab44188":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-coderabbitai-api-key","description":"API key for authentication. You can create an API key from the CodeRabbit dashboard.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"94307302-b1ff-453f-b134-032a703d9dae":{"url":"https://api.coderabbit.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-coderabbitai-api-key","description":"API key for authentication. You can create an API key from the CodeRabbit dashboard.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-coderabbitai-api-key","type":"string","description":"API key for authentication. You can create an API key from the CodeRabbit dashboard.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-coderabbitai-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"coderabbit","siteName":"CodeRabbit","title":"Roles - CodeRabbit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T06:30:07.789Z","originalFileLocation":"api-reference/platform/roles.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Bulk change roles for users in the organization. Supports up to 500 users per request. Cannot modify billing admin roles. Rate limited to 10 requests per 60 seconds with max 3 concurrent requests per organization. Requires user_management:write and an Enterprise plan.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CodeRabbit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Roles - CodeRabbit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Bulk change roles for users in the organization. Supports up to 500 users per request. Cannot modify billing admin roles. Rate limited to 10 requests per 60 seconds with max 3 concurrent requests per organization. Requires user_management:write and an Enterprise plan.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CodeRabbit Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.coderabbit.ai/api-reference/platform/roles\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://coderabbit.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Roles\u0026amp;description=Bulk+change+roles+for+users+in+the+organization.+Supports+up+to+500+users+per+request.+Cannot+modify+billing+admin+roles.+Rate+limited+to+10+requests+per+60+sec\u0026amp;theme=e25dc9e67170d7dae31e0b2f\u0026amp;signature=a350533cfe991e5a8a96d368ed3a88fcdcc46ce0f106af0a069cf71e85d4efd8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Roles - CodeRabbit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Bulk change roles for users in the organization. Supports up to 500 users per request. Cannot modify billing admin roles. Rate limited to 10 requests per 60 seconds with max 3 concurrent requests per organization. Requires user_management:write and an Enterprise plan.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://coderabbit.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Roles\u0026amp;description=Bulk+change+roles+for+users+in+the+organization.+Supports+up+to+500+users+per+request.+Cannot+modify+billing+admin+roles.+Rate+limited+to+10+requests+per+60+sec\u0026amp;theme=e25dc9e67170d7dae31e0b2f\u0026amp;signature=a350533cfe991e5a8a96d368ed3a88fcdcc46ce0f106af0a069cf71e85d4efd8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CodeRabbit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF570A\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.coderabbit.ai/api-reference/platform/roles\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/platform/roles.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.coderabbit.ai/#organization\",\"name\":\"CodeRabbit\",\"url\":\"https://docs.coderabbit.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=d2bf9e91be0e760ec9cb468676fa6ab6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.coderabbit.ai#website\",\"name\":\"CodeRabbit\",\"url\":\"https://docs.coderabbit.ai\",\"publisher\":{\"@id\":\"https://docs.coderabbit.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.coderabbit.ai/api-reference/platform/roles#webpage\",\"url\":\"https://docs.coderabbit.ai/api-reference/platform/roles\",\"name\":\"Roles\",\"description\":\"Bulk change roles for users in the organization. Supports up to 500 users per request. Cannot modify billing admin roles. Rate limited to 10 requests per 60 seconds with max 3 concurrent requests per organization. Requires user_management:write and an Enterprise plan.\",\"dateModified\":\"2026-11-10T06:30:07.789Z\",\"isPartOf\":{\"@id\":\"https://docs.coderabbit.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.coderabbit.ai/api-reference/platform/roles#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.coderabbit.ai/api-reference/platform/roles#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CodeRabbit API\",\"item\":\"https://docs.coderabbit.ai/api/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Platform API\",\"item\":\"https://docs.coderabbit.ai/api/platform-api\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Platform API reference\",\"item\":\"https://docs.coderabbit.ai/api-reference/platform/post-apiv1reportgenerate\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"API Reference\",\"item\":\"https://docs.coderabbit.ai/api-reference/platform/post-apiv1reportgenerate\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Roles\",\"item\":\"https://docs.coderabbit.ai/api-reference/platform/roles\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.coderabbit.ai/api-reference/platform/roles#apireference\",\"headline\":\"Roles\",\"name\":\"Roles\",\"description\":\"Bulk change roles for users in the organization. Supports up to 500 users per request. Cannot modify billing admin roles. Rate limited to 10 requests per 60 seconds with max 3 concurrent requests per organization. Requires user_management:write and an Enterprise plan.\",\"url\":\"https://docs.coderabbit.ai/api-reference/platform/roles\",\"mainEntityOfPage\":{\"@id\":\"https://docs.coderabbit.ai/api-reference/platform/roles#webpage\"},\"dateModified\":\"2026-11-10T06:30:07.789Z\",\"publisher\":{\"@id\":\"https://docs.coderabbit.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.coderabbit.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CodeRabbit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"CodeRabbit","nav":{"global":{"anchors":[{"anchor":"Quickstart","icon":"rocket","hidden":false,"href":"/getting-started/quickstart"},{"anchor":"Blog","icon":"pen-line","hidden":true,"href":"https://coderabbit.ai/blog"},{"anchor":"Changelog","icon":"history","href":"/changelog"},{"anchor":"Support","icon":"life-buoy","href":"/support"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/coderabbit"}]},"tabs":[{"tab":"CodeRabbit Platform","icon":"layers","pages":[{"title":"CodeRabbit Platform","href":""}]},{"tab":"CLI and IDE tools","icon":"square-terminal","pages":[{"title":"CLI and IDE tools","href":"/cli"}]},{"tab":"Coding Agent","icon":"square-code","pages":[{"title":"Coding Agent","href":"/code"}]},{"tab":"Agent for Slack and Discord","icon":"bot","pages":[{"title":"Agent for Slack and Discord","href":"/agent"}]},{"tab":"Management","icon":"wrench","pages":[{"title":"Management overview","sidebarTitle":"Overview","mode":"wide","href":"/management"},{"group":"Repository Configuration","icon":"folder-git-2","pages":[{"title":"Overview","href":"/platforms/overview"},{"group":"Supported Git platforms","expanded":false,"pages":[{"title":"GitHub","icon":"github","href":"/platforms/github-com"},{"title":"GitHub Enterprise Server","icon":"github","href":"/platforms/github-enterprise-server"},{"title":"GitLab","icon":"gitlab","href":"/platforms/gitlab-com"},{"title":"Self-managed GitLab","sidebarTitle":"GitLab self-managed","icon":"gitlab","href":"/platforms/self-hosted-gitlab"},{"title":"Azure DevOps","icon":"microsoft","href":"/platforms/azure-devops"},{"title":"Bitbucket Cloud","icon":"bitbucket","href":"/platforms/bitbucket-cloud"},{"title":"Bitbucket Data Center","icon":"bitbucket","href":"/platforms/bitbucket-data-center"}]}]},{"group":"Subscription \u0026 billing","icon":"credit-card","pages":[{"title":"Plans and pricing","sidebarTitle":"Plans and pricing","href":"/management/plans"},{"title":"Review rate limits","sidebarTitle":"Rate limits","href":"/management/rate-limits"},{"title":"Billing and changing plans","sidebarTitle":"Billing and changing plans","href":"/management/billing"},{"title":"Enterprise seat true-up","sidebarTitle":"Enterprise seat true-up","href":"/management/enterprise-seat-true-up"},{"title":"Usage-based reviews","sidebarTitle":"Usage-based reviews","href":"/management/usage-based-addon"},{"title":"Subscription management","sidebarTitle":"Subscription management","href":"/management/subscription-management"}]},{"group":"Connections","icon":"plug","pages":[{"title":"Connections","sidebarTitle":"Connections","href":"/connections/index"},{"title":"Scopes overview","sidebarTitle":"Scopes","href":"/connections/scopes"},{"title":"Review scopes","sidebarTitle":"Review scopes","href":"/connections/scopes-review"},{"title":"Connect MCP servers","sidebarTitle":"MCP servers","href":"/connections/mcp-servers"},{"group":"Issue trackers","root":{"title":"Issue trackers","href":"/connections/issue-trackers"},"pages":[{"title":"Jira Integration","icon":"jira","href":"/connections/jira"},{"title":"Linear Integration","icon":"linear","href":"/connections/linear"}]},{"group":"CI/CD tools","pages":[{"title":"CircleCI integration","sidebarTitle":"CircleCI","href":"/connections/circleci"},{"title":"Jenkins integration","sidebarTitle":"Jenkins","href":"/connections/jenkins"}]}]},{"group":"Dashboard","icon":"layout-dashboard","pages":[{"title":"Overview","href":"/guides/dashboard"},{"title":"Git platform review metrics","href":"/guides/dashboard-metrics"},{"title":"IDE/CLI review metrics","href":"/guides/ide-cli-dashboard-metrics"},{"title":"Review Usage dashboard","sidebarTitle":"Review Usage","href":"/management/review-usage-dashboard"},{"title":"Data Export","href":"/guides/data-export"}]},{"group":"Reports","icon":"text-search","pages":[{"title":"Reports Overview","sidebarTitle":"Overview","href":"/management/reports/index"},{"title":"Schedule reports","href":"/guides/scheduled-reports"},{"title":"Legacy Report Testing","href":"/guides/ondemand-reports"},{"title":"Customize CodeRabbit pull request reports with prompts","sidebarTitle":"Custom reports","href":"/guides/custom-reports"}]},{"group":"Organization administration","icon":"user-cog","pages":[{"title":"Seat assignment","href":"/management/seat-assignment"},{"title":"Role-based access","href":"/management/roles"},{"title":"Custom roles and permissions","href":"/management/custom-roles"},{"title":"Set up Multi-Org","sidebarTitle":"Multiple organizations","href":"/management/multi-org"},{"title":"Add organizations","href":"/management/adding-organizations"},{"title":"Set permissions","href":"/management/upgrading-permissions"},{"title":"Audit Logs","href":"/management/audit-logs"}]},{"group":"Enterprise SSO","icon":"key","pages":[{"title":"Enterprise SSO","sidebarTitle":"Overview","href":"/management/sso/index"},{"title":"Okta SAML SSO setup","sidebarTitle":"Okta SAML","href":"/management/sso/okta-saml"},{"title":"Google Workspace self-serve SSO setup","sidebarTitle":"Google Workspace","href":"/management/sso/google-workspace-saml"},{"title":"Microsoft Entra ID SSO setup","sidebarTitle":"Microsoft Entra ID","href":"/management/sso/microsoft-entra-saml"},{"title":"SAML 2.0 provider SSO setup","sidebarTitle":"Other SAML 2.0 providers","href":"/management/sso/custom-saml"},{"title":"Prepare self-hosted Git providers for SSO","sidebarTitle":"Self-hosted Git providers","href":"/management/sso/self-hosted-git-providers"},{"title":"Azure DevOps Server setup","sidebarTitle":"Azure DevOps Server","href":"/management/sso/azure-devops-server"},{"title":"SCIM directory sync","sidebarTitle":"SCIM directory sync","href":"/management/sso/scim"},{"title":"SSO user management API","sidebarTitle":"User management API","href":"/management/sso/user-management-api"}]},{"group":"Self-hosted CodeRabbit","icon":"server","pages":[{"title":"Self-hosted CodeRabbit","sidebarTitle":"Overview","href":"/self-hosted/overview"},{"group":"Reverse Tunnel","pages":[{"title":"CodeRabbit Reverse Tunnel","sidebarTitle":"Reverse Tunnel overview","href":"/self-hosted/coderabbit-reverse-tunnel"},{"title":"Reverse Tunnel connector configuration","sidebarTitle":"Connector configuration","href":"/self-hosted/reverse-tunnel-connector-configuration"}]}]},{"group":"CodeRabbit API","icon":"braces","pages":[{"title":"CodeRabbit API","sidebarTitle":"Overview","href":"/api/index"},{"title":"Workspace API tokens","href":"/api/workspace-api-tokens"},{"group":"Platform API","pages":[{"title":"Platform API","href":"/api/platform-api"},{"title":"Authenticate to the Platform API","href":"/api/platform-authentication"},{"title":"Platform API workflows","href":"/api/platform-workflows"},{"title":"Read repositories","href":"/api/platform-repositories"},{"title":"Read pull requests","href":"/api/platform-pull-requests"},{"group":"Platform API reference","pages":[{"group":"API Reference","pages":[{"title":"","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/report.generate","href":"/api-reference/platform/post-apiv1reportgenerate"},{"title":"Metrics Data","description":"Returns finalized pull request metrics with CodeRabbit review comments. Merged PRs use merge time and closed-unmerged PRs use close time for the requested range and cursor. Supports cursor-based pagination, paged in write order rather than by merge/close time, so a row written after your cursor already passed its merge or close date (a backfill, or a reopen/reclose) still appears on a later page instead of being silently skipped. Each page request consumes one token when admitted by the request rate limiter. Reviews, review comments, and MCP share the Metrics quota for the configured quota owner. With verified owner scope, coordinate calls across API keys for the same organization, workspace, or Git-provider instance; changing an organization selector does not add quota.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/metrics/reviews","href":"/api-reference/platform/metrics-data"},{"title":"Roles","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/users/roles","href":"/api-reference/platform/roles"}]},{"group":"User Management","pages":[{"title":"List all users in the organization","description":"Retrieve all users in the organization with their seat assignment status and role information. Rate limited to 10 requests per 60 seconds per organization.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/users","href":"/api-reference/platform/user-management/list-all-users-in-the-organization"},{"title":"Add users and assign seats for a self-hosted organization","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/users","href":"/api-reference/platform/user-management/add-users-and-assign-seats-for-a-self-hosted-organization"},{"title":"Assign or unassign seats for multiple users","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/users/seats","href":"/api-reference/platform/user-management/assign-or-unassign-seats-for-multiple-users"},{"title":"Update the seat assignment mode","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/users/seats/assignment","href":"/api-reference/platform/user-management/update-the-seat-assignment-mode"}]},{"group":"Audit Logs","pages":[{"title":"List audit log entries","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/audit-logs","href":"/api-reference/platform/audit-logs/list-audit-log-entries"}]},{"group":"Learnings","pages":[{"title":"List learnings for an organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/learnings","href":"/api-reference/platform/learnings/list-learnings-for-an-organization"},{"title":"Delete a learning","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/learnings/{learning_id}","href":"/api-reference/platform/learnings/delete-a-learning"},{"title":"Update a learning","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/learnings/{learning_id}","href":"/api-reference/platform/learnings/update-a-learning"},{"title":"List saved Learnings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/learnings","href":"/api-reference/platform/learnings/list-saved-learnings"},{"title":"Save Learnings","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge/learnings","href":"/api-reference/platform/learnings/save-learnings"},{"title":"Read a saved Learning","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/learnings/{learning_id}","href":"/api-reference/platform/learnings/read-a-saved-learning"},{"title":"Delete a Learning","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/knowledge/learnings/{learning_id}","href":"/api-reference/platform/learnings/delete-a-learning-1"},{"title":"Update a Learning","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/knowledge/learnings/{learning_id}","href":"/api-reference/platform/learnings/update-a-learning-1"},{"title":"Read recorded Learning usage statistics","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/learnings/statistics","href":"/api-reference/platform/learnings/read-recorded-learning-usage-statistics"},{"title":"Read available Learning filters","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/learnings/filters","href":"/api-reference/platform/learnings/read-available-learning-filters"},{"title":"Export saved Learnings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/learnings/export","href":"/api-reference/platform/learnings/export-saved-learnings"}]},{"group":"Organizations","pages":[{"title":"List onboarded organizations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations","href":"/api-reference/platform/organizations/list-onboarded-organizations"},{"title":"List onboarded repositories for an organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/repositories","href":"/api-reference/platform/organizations/list-onboarded-repositories-for-an-organization"}]},{"group":"Metrics","pages":[{"title":"Get MCP server usage by pull request","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/metrics/mcp","href":"/api-reference/platform/metrics/get-mcp-server-usage-by-pull-request"},{"title":"Get review comment metrics for merged pull requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/metrics/review-comments","href":"/api-reference/platform/metrics/get-review-comment-metrics-for-merged-pull-requests"}]},{"group":"Security","pages":[{"title":"List or export AI Deep Scan code findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/scans/code","href":"/api-reference/platform/security/list-or-export-ai-deep-scan-code-findings"},{"title":"Export a software bill of materials","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/sbom/export","href":"/api-reference/platform/security/export-a-software-bill-of-materials"},{"title":"List code and secret findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/findings","href":"/api-reference/platform/security/list-code-and-secret-findings"},{"title":"List vulnerable dependencies","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/dependencies","href":"/api-reference/platform/security/list-vulnerable-dependencies"},{"title":"List software bill of materials components","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/sbom","href":"/api-reference/platform/security/list-software-bill-of-materials-components"},{"title":"List security scan activity","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/scans","href":"/api-reference/platform/security/list-security-scan-activity"},{"title":"Request security scans for installed repositories","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/security/scans","href":"/api-reference/platform/security/request-security-scans-for-installed-repositories"},{"title":"Read an existing security scan","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/scans/{scan_id}","href":"/api-reference/platform/security/read-an-existing-security-scan"},{"title":"Estimate an AI Deep Scan","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/scans/quote","href":"/api-reference/platform/security/estimate-an-ai-deep-scan"},{"title":"Request an AI fix for a security finding","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/security/repositories/{repository_id}/findings/{finding_id}/fix","href":"/api-reference/platform/security/request-an-ai-fix-for-a-security-finding"},{"title":"Dismiss a security finding","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/security/repositories/{repository_id}/findings/{finding_id}/dismiss","href":"/api-reference/platform/security/dismiss-a-security-finding"},{"title":"Reopen a code security finding","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/security/repositories/{repository_id}/findings/{finding_id}/reopen","href":"/api-reference/platform/security/reopen-a-code-security-finding"},{"title":"Read a code security finding","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/findings/{finding_id}","href":"/api-reference/platform/security/read-a-code-security-finding"},{"title":"Read a secret finding","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/secrets/{finding_id}","href":"/api-reference/platform/security/read-a-secret-finding"},{"title":"Read a dependency and its advisories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/dependencies/{dependency_id}","href":"/api-reference/platform/security/read-a-dependency-and-its-advisories"},{"title":"List secret scanner findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/secrets","href":"/api-reference/platform/security/list-secret-scanner-findings"},{"title":"Read a runtime validation result","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/validations/{validation_id}","href":"/api-reference/platform/security/read-a-runtime-validation-result"},{"title":"List runtime validation attempts for a finding","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/validations","href":"/api-reference/platform/security/list-runtime-validation-attempts-for-a-finding"},{"title":"Read runtime validation availability for a finding","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/findings/{finding_id}/validation-capability","href":"/api-reference/platform/security/read-runtime-validation-availability-for-a-finding"}]},{"group":"Bug Scan","pages":[{"title":"List or export Bug Scan findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/bug-scan/findings","href":"/api-reference/platform/bug-scan/list-or-export-bug-scan-findings"}]},{"group":"Repositories","pages":[{"title":"List linked repositories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/linked-repositories","href":"/api-reference/platform/repositories/list-linked-repositories"},{"title":"List accessible installed repositories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories","href":"/api-reference/platform/repositories/list-accessible-installed-repositories"},{"title":"Get an accessible installed repository","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}","href":"/api-reference/platform/repositories/get-an-accessible-installed-repository"}]},{"group":"Reviews","pages":[{"title":"Read the existing CodeRabbit review status for a pull request","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review","href":"/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request"},{"title":"Request a review of the current pull-request head","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review","href":"/api-reference/platform/reviews/request-a-review-of-the-current-pull-request-head"}]},{"group":"Pull requests","pages":[{"title":"List an accessible repository's pull requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/pull-requests","href":"/api-reference/platform/pull-requests/list-an-accessible-repositorys-pull-requests"},{"title":"Read an accessible pull request and its current checks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/pull-requests/{pull_request_number}","href":"/api-reference/platform/pull-requests/read-an-accessible-pull-request-and-its-current-checks"}]},{"group":"Identity","pages":[{"title":"Get the authenticated principal and selected organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/me","href":"/api-reference/platform/identity/get-the-authenticated-principal-and-selected-organization"}]},{"group":"Usage","pages":[{"title":"Read permitted credit balances","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/credits","href":"/api-reference/platform/usage/read-permitted-credit-balances"},{"title":"Read current usage and permitted credit balances","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage","href":"/api-reference/platform/usage/read-current-usage-and-permitted-credit-balances"},{"title":"Read current usage budget policy and consumption","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/budget","href":"/api-reference/platform/usage/read-current-usage-budget-policy-and-consumption"},{"title":"Read paginated member usage budgets","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/budget/members","href":"/api-reference/platform/usage/read-paginated-member-usage-budgets"}]},{"group":"Architecture knowledge","pages":[{"title":"Read available architecture knowledge scopes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/architecture/capabilities","href":"/api-reference/platform/architecture-knowledge/read-available-architecture-knowledge-scopes"},{"title":"List repositories with architecture knowledge","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/architecture/repositories","href":"/api-reference/platform/architecture-knowledge/list-repositories-with-architecture-knowledge"},{"title":"List the current architecture knowledge document tree","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/architecture/tree","href":"/api-reference/platform/architecture-knowledge/list-the-current-architecture-knowledge-document-tree"},{"title":"Read an architecture knowledge document at an observed revision","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/architecture/document","href":"/api-reference/platform/architecture-knowledge/read-an-architecture-knowledge-document-at-an-observed-revision"}]},{"group":"Triage","pages":[{"title":"List the caller's accessible Triage changes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/changes","href":"/api-reference/platform/triage/list-the-callers-accessible-triage-changes"},{"title":"Read an accessible Triage change","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/changes/{id}","href":"/api-reference/platform/triage/read-an-accessible-triage-change"},{"title":"Read the recorded priority and close-candidacy history","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/changes/{id}/history","href":"/api-reference/platform/triage/read-the-recorded-priority-and-close-candidacy-history"},{"title":"List accessible Triage teams","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/teams","href":"/api-reference/platform/triage/list-accessible-triage-teams"}]},{"group":"Triage rules","pages":[{"title":"List Triage rules","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/rules","href":"/api-reference/platform/triage-rules/list-triage-rules"},{"title":"Create a Triage rule","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/triage/rules","href":"/api-reference/platform/triage-rules/create-a-triage-rule"},{"title":"Read a Triage rule and its definition","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/rules/{ruleId}","href":"/api-reference/platform/triage-rules/read-a-triage-rule-and-its-definition"},{"title":"Replace a Triage rule definition","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/triage/rules/{ruleId}","href":"/api-reference/platform/triage-rules/replace-a-triage-rule-definition"},{"title":"Delete a Triage rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/triage/rules/{ruleId}","href":"/api-reference/platform/triage-rules/delete-a-triage-rule"},{"title":"Preview existing changes matching a rule definition","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/triage/rules/preview","href":"/api-reference/platform/triage-rules/preview-existing-changes-matching-a-rule-definition"},{"title":"Activate, pause, or resume a Triage rule","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/triage/rules/{ruleId}/transition","href":"/api-reference/platform/triage-rules/activate-pause-or-resume-a-triage-rule"},{"title":"Read executions for a rule revision","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/rules/{ruleId}/executions","href":"/api-reference/platform/triage-rules/read-executions-for-a-rule-revision"}]},{"group":"Knowledge","pages":[{"title":"List connected knowledge repositories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/connected-repositories","href":"/api-reference/platform/knowledge/list-connected-knowledge-repositories"},{"title":"Connect an installed repository as a knowledge source","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge/connected-repositories","href":"/api-reference/platform/knowledge/connect-an-installed-repository-as-a-knowledge-source"},{"title":"Request a connected repository index refresh","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge/connected-repositories/{repository_id}/reindex","href":"/api-reference/platform/knowledge/request-a-connected-repository-index-refresh"},{"title":"Disconnect a knowledge repository","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/knowledge/connected-repositories/{repository_id}","href":"/api-reference/platform/knowledge/disconnect-a-knowledge-repository"}]},{"group":"Automations","pages":[{"title":"List accessible automations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/automations","href":"/api-reference/platform/automations/list-accessible-automations"},{"title":"Create an ordinary Automation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/automations","href":"/api-reference/platform/automations/create-an-ordinary-automation"},{"title":"Read an ordinary Automation and its editable definition","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/automations/{automation_id}","href":"/api-reference/platform/automations/read-an-ordinary-automation-and-its-editable-definition"},{"title":"Replace an ordinary Automation definition at its observed revision","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/automations/{automation_id}","href":"/api-reference/platform/automations/replace-an-ordinary-automation-definition-at-its-observed-revision"},{"title":"List recorded ordinary Automation runs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/automations/{automation_id}/runs","href":"/api-reference/platform/automations/list-recorded-ordinary-automation-runs"},{"title":"Run, pause, resume, or delete an ordinary Automation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/automations/{automation_id}/commands","href":"/api-reference/platform/automations/run-pause-resume-or-delete-an-ordinary-automation"}]},{"group":"Configuration","pages":[{"title":"Read organization review configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/organization","href":"/api-reference/platform/configuration/read-organization-review-configuration"},{"title":"Replace organization review configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/configuration/organization","href":"/api-reference/platform/configuration/replace-organization-review-configuration"},{"title":"Read workspace review configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/workspace","href":"/api-reference/platform/configuration/read-workspace-review-configuration"},{"title":"Read the effective review configuration and its layers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/configuration/effective","href":"/api-reference/platform/configuration/read-the-effective-review-configuration-and-its-layers"},{"title":"Read repository review configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/configuration","href":"/api-reference/platform/configuration/read-repository-review-configuration"},{"title":"Replace repository review configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/repositories/{repository_id}/configuration","href":"/api-reference/platform/configuration/replace-repository-review-configuration"},{"title":"Preview effective repository configuration without saving","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/repositories/{repository_id}/configuration/preview","href":"/api-reference/platform/configuration/preview-effective-repository-configuration-without-saving"},{"title":"Read a repository's configuration source","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/configuration/source","href":"/api-reference/platform/configuration/read-a-repositorys-configuration-source"},{"title":"Set a repository's configuration source","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/repositories/{repository_id}/configuration/source","href":"/api-reference/platform/configuration/set-a-repositorys-configuration-source"},{"title":"Read the workspace configuration-default policy","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/workspace-defaults","href":"/api-reference/platform/configuration/read-the-workspace-configuration-default-policy"},{"title":"Set the workspace configuration-default policy","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/configuration/workspace-defaults","href":"/api-reference/platform/configuration/set-the-workspace-configuration-default-policy"}]},{"group":"Connections","pages":[{"title":"List accessible workspace connections","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/connections","href":"/api-reference/platform/connections/list-accessible-workspace-connections"},{"title":"Create a workspace connection","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections","href":"/api-reference/platform/connections/create-a-workspace-connection"},{"title":"List pending workspace connection requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/connections/requests","href":"/api-reference/platform/connections/list-pending-workspace-connection-requests"},{"title":"Read an existing connection-request intent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/connections/requests/{intent}","href":"/api-reference/platform/connections/read-an-existing-connection-request-intent"},{"title":"Submit an existing connection-request intent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections/requests/{intent}","href":"/api-reference/platform/connections/submit-an-existing-connection-request-intent"},{"title":"Verify a saved connection and complete matching requests","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections/{connectionId}/complete-requests","href":"/api-reference/platform/connections/verify-a-saved-connection-and-complete-matching-requests"},{"title":"Read masked saved-connection configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/connections/{connectionId}","href":"/api-reference/platform/connections/read-masked-saved-connection-configuration"},{"title":"Update a workspace connection","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/connections/{connectionId}","href":"/api-reference/platform/connections/update-a-workspace-connection"},{"title":"Delete a workspace connection","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/connections/{connectionId}","href":"/api-reference/platform/connections/delete-a-workspace-connection"},{"title":"Update a connection's name or description","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/connections/{connectionId}","href":"/api-reference/platform/connections/update-a-connections-name-or-description"},{"title":"Test a connection with existing credential and provider checks","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections/test","href":"/api-reference/platform/connections/test-a-connection-with-existing-credential-and-provider-checks"},{"title":"Discover tools from a configured MCP connection","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections/mcp/tools","href":"/api-reference/platform/connections/discover-tools-from-a-configured-mcp-connection"}]},{"group":"Coding","pages":[{"title":"List accessible coding tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks","href":"/api-reference/platform/coding/list-accessible-coding-tasks"},{"title":"Create a coding task","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks","href":"/api-reference/platform/coding/create-a-coding-task"},{"title":"Read an accessible coding task","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}","href":"/api-reference/platform/coding/read-an-accessible-coding-task"},{"title":"Read a stored coding plan version","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/plan","href":"/api-reference/platform/coding/read-a-stored-coding-plan-version"},{"title":"Approve or withdraw approval of a coding plan","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/code/tasks/{task_id}/plan/approval","href":"/api-reference/platform/coding/approve-or-withdraw-approval-of-a-coding-plan"},{"title":"Read a coding task's stored patch","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/patch","href":"/api-reference/platform/coding/read-a-coding-tasks-stored-patch"},{"title":"Read queued coding task messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/queue","href":"/api-reference/platform/coding/read-queued-coding-task-messages"},{"title":"Deliver a task patch using the caller's existing repository write authorization","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/delivery","href":"/api-reference/platform/coding/deliver-a-task-patch-using-the-callers-existing-repository-write-authorization"},{"title":"Read existing autofix status for a task or pull request","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/autofix","href":"/api-reference/platform/coding/read-existing-autofix-status-for-a-task-or-pull-request"},{"title":"Enable, disable, resume or recover existing autofix","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/autofix/commands","href":"/api-reference/platform/coding/enable-disable-resume-or-recover-existing-autofix"},{"title":"List retained coding execution turns","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/turns","href":"/api-reference/platform/coding/list-retained-coding-execution-turns"},{"title":"Queue a follow-up coding message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/turns","href":"/api-reference/platform/coding/queue-a-follow-up-coding-message"},{"title":"Read a retained coding execution turn by its native start sequence","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/turns/{turn_start_seq}","href":"/api-reference/platform/coding/read-a-retained-coding-execution-turn-by-its-native-start-sequence"},{"title":"Queue a plan revision using the existing replan operation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/plan/revisions","href":"/api-reference/platform/coding/queue-a-plan-revision-using-the-existing-replan-operation"},{"title":"Implement a stored plan after its existing readiness checks","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/plan/implementation","href":"/api-reference/platform/coding/implement-a-stored-plan-after-its-existing-readiness-checks"},{"title":"Read questions recorded in a task's recent execution history","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/questions","href":"/api-reference/platform/coding/read-questions-recorded-in-a-tasks-recent-execution-history"},{"title":"Answer an existing coding task interaction","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/questions/{interaction_id}/answers","href":"/api-reference/platform/coding/answer-an-existing-coding-task-interaction"},{"title":"Request the existing human Stop action for a coding task","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/cancel","href":"/api-reference/platform/coding/request-the-existing-human-stop-action-for-a-coding-task"},{"title":"Read feedback on a specific stored plan version","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/plan/comments","href":"/api-reference/platform/coding/read-feedback-on-a-specific-stored-plan-version"}]},{"group":"Verify","pages":[{"title":"Update or archive a user journey with native revision checks","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/verify/repositories/{repository_id}/journeys/{cuj_id}","href":"/api-reference/platform/verify/update-or-archive-a-user-journey-with-native-revision-checks"},{"title":"List registered Verify repositories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories","href":"/api-reference/platform/verify/list-registered-verify-repositories"},{"title":"Register an accessible repository with an existing execution environment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/verify/repositories","href":"/api-reference/platform/verify/register-an-accessible-repository-with-an-existing-execution-environment"},{"title":"Read a Verify repository and its recent jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}","href":"/api-reference/platform/verify/read-a-verify-repository-and-its-recent-jobs"},{"title":"Configure an existing Verify repository","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/verify/repositories/{repository_id}","href":"/api-reference/platform/verify/configure-an-existing-verify-repository"},{"title":"List registered user journeys","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/journeys","href":"/api-reference/platform/verify/list-registered-user-journeys"},{"title":"Create a user journey","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/verify/repositories/{repository_id}/journeys","href":"/api-reference/platform/verify/create-a-user-journey"},{"title":"List Verify jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/jobs","href":"/api-reference/platform/verify/list-verify-jobs"},{"title":"Start an existing Verify authoring, testability or execution operation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/verify/repositories/{repository_id}/jobs","href":"/api-reference/platform/verify/start-an-existing-verify-authoring-testability-or-execution-operation"},{"title":"Read a Verify job and execution statuses","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/jobs/{job_id}","href":"/api-reference/platform/verify/read-a-verify-job-and-execution-statuses"},{"title":"List Verify schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/schedules","href":"/api-reference/platform/verify/list-verify-schedules"},{"title":"Read Verify schedule occurrences","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/schedules/{schedule_id}/history","href":"/api-reference/platform/verify/read-verify-schedule-occurrences"},{"title":"Create, update or delete a Verify schedule with native revision checks","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/verify/repositories/{repository_id}/schedules/changes","href":"/api-reference/platform/verify/create-update-or-delete-a-verify-schedule-with-native-revision-checks"},{"title":"Read observed bugs from a Verify job","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/jobs/{job_id}/bugs","href":"/api-reference/platform/verify/read-observed-bugs-from-a-verify-job"},{"title":"Read a Verify bug's observed history","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/bugs/{bug_id}/history","href":"/api-reference/platform/verify/read-a-verify-bugs-observed-history"},{"title":"Read a Verify execution result","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/executions/{execution_id}","href":"/api-reference/platform/verify/read-a-verify-execution-result"},{"title":"Read published Verify evidence metadata","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/executions/{execution_id}/evidence/{artifact_id}","href":"/api-reference/platform/verify/read-published-verify-evidence-metadata"},{"title":"List current Verify findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/findings","href":"/api-reference/platform/verify/list-current-verify-findings"},{"title":"Download published Verify evidence","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/executions/{execution_id}/evidence/{artifact_id}/content","href":"/api-reference/platform/verify/download-published-verify-evidence"}]},{"group":"Coding environments","pages":[{"title":"List existing repository environment assignments","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/environment-assignments","href":"/api-reference/platform/coding-environments/list-existing-repository-environment-assignments"},{"title":"List coding environments","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/environments","href":"/api-reference/platform/coding-environments/list-coding-environments"},{"title":"Create a coding environment with existing preparation behavior","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/environments","href":"/api-reference/platform/coding-environments/create-a-coding-environment-with-existing-preparation-behavior"},{"title":"Read environment configuration without secret values","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/environments/{environmentId}","href":"/api-reference/platform/coding-environments/read-environment-configuration-without-secret-values"},{"title":"Update environment configuration with native revision checks","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/code/environments/{environmentId}","href":"/api-reference/platform/coding-environments/update-environment-configuration-with-native-revision-checks"},{"title":"Archive a coding environment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/code/environments/{environmentId}","href":"/api-reference/platform/coding-environments/archive-a-coding-environment"},{"title":"Assign a repository to a coding environment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/environments/{environmentId}/repositories","href":"/api-reference/platform/coding-environments/assign-a-repository-to-a-coding-environment"},{"title":"Update repository setup using its native revision check","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/code/environments/{environmentId}/repositories/{repositoryAssignmentId}","href":"/api-reference/platform/coding-environments/update-repository-setup-using-its-native-revision-check"},{"title":"Remove a repository environment assignment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/code/environments/{environmentId}/repositories/{repositoryAssignmentId}","href":"/api-reference/platform/coding-environments/remove-a-repository-environment-assignment"},{"title":"Set an environment variable using existing encrypted storage","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/code/environments/{environmentId}/variables","href":"/api-reference/platform/coding-environments/set-an-environment-variable-using-existing-encrypted-storage"},{"title":"Delete an environment variable","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/code/environments/{environmentId}/variables/{variableId}","href":"/api-reference/platform/coding-environments/delete-an-environment-variable"}]},{"group":"Reports","pages":[{"title":"List existing report configurations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/reports","href":"/api-reference/platform/reports/list-existing-report-configurations"},{"title":"Create an on-demand or scheduled report","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/reports","href":"/api-reference/platform/reports/create-an-on-demand-or-scheduled-report"},{"title":"Read an existing report configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/reports/{report_id}","href":"/api-reference/platform/reports/read-an-existing-report-configuration"},{"title":"Replace a recurring report configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/reports/{report_id}","href":"/api-reference/platform/reports/replace-a-recurring-report-configuration"},{"title":"Delete a report configuration","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/reports/{report_id}","href":"/api-reference/platform/reports/delete-a-report-configuration"},{"title":"Enable or disable a report schedule","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/reports/{report_id}","href":"/api-reference/platform/reports/enable-or-disable-a-report-schedule"}]},{"group":"Administration","pages":[{"title":"List organization roles","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/roles","href":"/api-reference/platform/administration/list-organization-roles"},{"title":"Create a custom role by copying an existing role","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/configuration/roles","href":"/api-reference/platform/administration/create-a-custom-role-by-copying-an-existing-role"},{"title":"Read a role and its permissions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/roles/{roleId}","href":"/api-reference/platform/administration/read-a-role-and-its-permissions"},{"title":"Delete an unassigned custom role","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/configuration/roles/{roleId}","href":"/api-reference/platform/administration/delete-an-unassigned-custom-role"},{"title":"Update a custom role","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/configuration/roles/{roleId}","href":"/api-reference/platform/administration/update-a-custom-role"},{"title":"List supported role permissions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/roles/permissions","href":"/api-reference/platform/administration/list-supported-role-permissions"}]}]}]},{"group":"API Reference","expanded":false,"pages":[{"group":"Metrics","pages":[{"openapi":"get /v1/metrics/reviews","title":"Metrics Data","href":"/api-reference/metrics-data-api"},{"openapi":"get /v1/metrics/review-comments","title":"Review comment metrics","href":"/api-reference/review-comment-metrics"},{"openapi":"get /v1/metrics/mcp","title":"MCP server usage","href":"/api-reference/mcp-metrics"}]},{"group":"Learnings","pages":[{"openapi":"get /v1/learnings","title":"Learnings","href":"/api-reference/learnings-list"},{"openapi":"patch /v1/learnings/{learning_id}","title":"Update Learning","href":"/api-reference/learnings-update"},{"openapi":"delete /v1/learnings/{learning_id}","title":"Delete Learning","href":"/api-reference/learnings-delete"}]},{"group":"Security","pages":[{"openapi":"get /v1/security/scans/code","title":"Deep Scan code findings","href":"/api-reference/security-scans-code-list"}]},{"group":"Organizations","pages":[{"title":"List organizations","openapi":"get /v1/organizations","href":"/api-reference/organizations-list"},{"title":"List organization repositories","openapi":"get /v1/organizations/{organization_id}/repositories","href":"/api-reference/organization-repositories-list"},{"title":"List linked repositories","openapi":"get /v1/linked-repositories","href":"/api-reference/linked-repositories-list"}]},{"group":"User Management","pages":[{"openapi":"get /v1/users","title":"Users","href":"/api-reference/users-list"},{"openapi":"post /v1/users/seats","title":"Seats","href":"/api-reference/users-manage-seats"},{"openapi":"post /v1/users/seats/assignment","title":"Seat Assignment Mode","href":"/api-reference/users-seat-assignment-mode"}]},{"group":"Roles","pages":[{"openapi":"post /v1/users/roles","title":"Assign roles","href":"/api-reference/users-change-roles"}]},{"group":"Audit Logs","pages":[{"openapi":"get /v1/audit-logs","title":"Audit Logs","href":"/api-reference/audit-logs"}]},{"group":"Legacy APIs","pages":[{"openapi":"post /api/v1/report.generate","title":"","href":"/api-reference/report-generate"}]}]}]},{"title":"Caching","href":"/reference/caching"},{"title":"Early Access Program","href":"/early-access"}]}]},"basePath":"","title":"Roles - CodeRabbit","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DV-WToSZ.js","dist-CBUH0-zX.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-CR-RHrVC.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","AssistantPageLink-BmARFYNC.js"]}