/
CA
carbonarc
/
Carbon Arc - Client Admin API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 5h ago · Updated 2d ago
View markdown
carbonarc
Carbon Arc - Client Admin API
put
Update Role
latest
OpenAPI 3.1.0
2026-08-21
866
757
1.2 MB
a8ca30023371
Admin APIs
644
get
Get Account Manager Candidates
get
Get Client Feature Filter Options
get
Get Clients
post
Create Client
get
Get Client
put
Update Client
delete
Delete Client
patch
Patch Mcp Provider Access Follows
put
Set Client Exchange
post
Bulk Set Client Plan Type
get
Get Client Plan Type
put
Set Client Plan Type
post
Send Payment Collection Email
get
Get Groups By Client
get
Get Default Group
get
Get Users By Client
get
List Client Sso Domains
post
Add Client Sso Domain
delete
Delete Client Sso Domain
patch
Update Client Sso Domain
post
Issue Promotional Grants
post
Buy Grants
get
Get Mcp Daily Window
get
Get Client Recurring Token Grant Schedules
get
Get Client Health
get
Get Users
post
Create User
get
Get Admin Users
get
Get User
put
Update User
delete
Delete User
get
Get Okta User Status
get
Get User Marketing Preferences
put
Update User Marketing Preferences
put
Update User Data Collection Consent
get
Get User Payment Methods
put
Change User Group
delete
Remove User From Group
post
Reset User Password
post
Resend User Activation
patch
Update User Mcp Daily Limit
post
Bulk Update Mcp Daily Limit
post
Bulk Update Consumption Limits
post
Bulk Revoke User Access
post
Bulk Restore User Access
post
Revoke User Access
post
Restore User Access
get
Get User Data Collection Consent History
get
Get User Data Collection Consent History Record
get
Get Client Data Collection Consent Restriction
put
Set Client Data Collection Consent Restriction
get
Get Products
post
Create Product
get
Get Product
put
Update Product
delete
Delete Product
get
Get Client Products
post
Create Client Product
get
Get Client Product
put
Update Client Product
delete
Delete Client Product
get
Get Features
post
Create Feature
get
Get Feature
put
Update Feature
delete
Delete Feature
get
Get Client Feature Accesses
post
Create Client Feature Access
get
Get Client Feature Access
put
Update Client Feature Access
delete
Delete Client Feature Access
get
Get User Feature Accesses
post
Create User Feature Access
get
Get User Feature Access
put
Update User Feature Access
delete
Delete User Feature Access
get
Get Feature Flags
post
Create Feature Flag
get
Get Feature Flag
put
Update Feature Flag
delete
Delete Feature Flag
get
Get Client Feature Flags
post
Create Client Feature Flag
get
Get Client Feature Flag
put
Update Client Feature Flag
delete
Delete Client Feature Flag
get
Get User Feature Flags
post
Create User Feature Flag
get
Get User Feature Flag
put
Update User Feature Flag
delete
Delete User Feature Flag
get
Get Api Keys
get
Get Api Key
get
Get Feature Elements
get
Get Feature Element
delete
Delete Feature Element
get
Get Client Feature Element Accesses
get
Get Client Feature Element Access
put
Update Client Feature Element Access
get
Get Feature Data Source Links
post
Create Feature Data Source Link
get
Get Feature Data Source Link
delete
Delete Feature Data Source Link
get
Get Feature Element Data Sources
post
Create Feature Element Data Source
get
Get Feature Element Data Source
delete
Delete Feature Element Data Source
get
Get Providers
post
Create Provider
get
Get Providers Export
get
Get Provider
put
Update Provider
delete
Delete Provider
get
Get Provider Services
post
Create Provider Service
get
Get Provider Service
put
Update Provider Service
delete
Delete Provider Service
get
Get Client Provider Restrictions
post
Create Client Provider Restrictions
get
Get Provider Logs
post
Create Provider Log
get
Get Provider Log
put
Update Provider Log
delete
Delete Provider Log
get
Get Client Provider Accesses
put
Update Client Provider Access
put
Update Client Accesses For All Providers
get
Get Client Provider Accesses Table
get
Get Client Provider Access Audit
put
Update Provider Accesses For All Clients
get
Get Tags
post
Create Tag
get
Get Tag
put
Update Tag
delete
Delete Tag
post
Create Bulk Tags
get
Get Entities
post
Create Entity
post
Create Entities Bulk
put
Update Entity
get
Get Industries
post
Create Industry
post
Create Industries Bulk
put
Update Industry
get
Get Api Tokens
get
Get Api Token
put
Update Api Token
get
Get Roles
post
Create Role
get
Get Role
put
Update Role
delete
Delete Role
get
Get Policy Elements
post
Create Policy Element
get
Get Policy Element
put
Update Policy Element
delete
Delete Policy Element
get
Get Admin Users
post
Create Admin User
get
Get Admin User
put
Update Admin User
delete
Delete Admin User
get
Get Roles
post
Create Role
get
Get Role
put
Update Role
delete
Delete Role
get
Get Groups
post
Create Group
get
Get Group
put
Update Group
delete
Delete Group
get
Get Permissions
post
Create Permission
post
Bulk Create Permissions
get
Detect Resources
post
Sync Resources
get
Export Permissions
get
Get Permission
put
Update Permission
delete
Delete Permission
get
Get Delta Tables
post
Create Delta Table
get
Get Delta Table
put
Update Delta Table
delete
Delete Delta Table
get
Get Delta Schemas
post
Create Delta Schema
get
Get Delta Schema
put
Update Delta Schema
delete
Delete Delta Schema
get
Get Delta Shares
post
Create Delta Share
get
Get Delta Share
put
Update Delta Share
delete
Delete Delta Share
get
Get Client Delta Config
post
Create Client Delta Config
post
Create Client Delta Config With Shares Names
post
Regenerate Client Token
get
Get Groups
post
Create Group
get
Get Group
put
Update Group
get
Get Group Users
post
Add Users To Group
delete
Remove User From Group
get
Get Group Limits
patch
Update Group Mcp Period Limit
post
Revoke Group Access
post
Restore Group Access
get
Get Dashboard
get
Search
get
Get Resource Hierarchy
get
Get Permissions
post
Set Auth Cookie
post
Clear Auth Cookie
get
Signup Ops Meta
get
Signup Ops Analytics
get
Signup Ops Pending
patch
Signup Ops Patch Tracking
get
Signup Ops List Tracking Audit
get
Signup Ops List Notes
post
Signup Ops Add Note
get
Search Signup Details
get
Get Signup Details
post
Retry Signup Provisioning
post
Reset Signup Verification Attempts
get
Get Token
put
Update Token
get
Get Tokens
post
Activate Token
post
Deactivate Token
get
List Client Accounts
get
List Created Transactions
get
Count Created Transactions Last Hours
get
Get Created Transaction Detail
get
List Upcoming Transactions
get
List Recurring Actions
post
Adjustment Credit
post
Adjustment Credit Recurring
post
Adjustment Debit
get
Get Client S3 Summary
get
List S3 Grants
post
Create S3 Grant
post
Cancel S3 Grant
post
Adjustment Credit Scheduled
post
Sync Okta Data
post
Sync Okta Data Background
post
Sync Element Data Sources
post
Fill Client Provider Accesses Table
get
Generate Api Tokens For Users
get
Deactivate Api Tokens And Keys For Deactivated Users
post
Client Provider Access Locks
get
Precompute Status
get
Precompute Shape
get
Precompute Diff
get
Precompute Archive
post
Start Precompute Build
get
Precompute Build
post
Stop Precompute Build
post
Activate Precompute
post
Clear Cache
get
List CAMS Audit Logs
get
List Okta Events
get
Get Release Timer
put
Set Release Timer
get
Preview Transactions
post
Export Transactions
post
Export Promo Codes
get
Preview Promo Codes
get
Deployment Report Options
get
Export Deployment Report
get
Exchange Admin Overview
get
Exchange Admin Listings
patch
Exchange Admin Update Listing Status
get
Exchange Admin Transactions
get
List Distributors
get
List Enterprise Clients
get
List Tou Templates
get
Get Provisioning Template
get
List Wholesale Templates
post
Create Wholesale Template
get
List Library Tous
post
Create Library Tou
get
Get Library Tou
post
Create Library Tou Version
get
List Contract Accounts
put
Switch Contract Tou
patch
Update Contract
get
List Tier Changes
post
Add Contract Tier
post
Update Tier Capacity
get
Get Distributor Detail
post
Create Contract
get
List Distributor Access Candidates
post
Grant Distributor Access
delete
Revoke Distributor Access
get
Get Mcp Token Limit Mappings
post
Create Mcp Token Limit Mapping
get
Get Mcp Token Limit Mapping
put
Update Mcp Token Limit Mapping
delete
Delete Mcp Token Limit Mapping
get
Get Mcp Token Limit Mapping References
get
Get Mcp Token Limit Mapping By Product Id
get
Get Mcp M2M Access
post
Create Mcp M2M Access
get
Get Mcp M2M Access By Id
get
Get Available Scripts
post
Run Migration
post
Run Migration Sync
post
Run Migration From Csv
post
Run Migration From Csv Sync
post
Run Migration From Csv Async
get
Get Task Status
post
Backfill Sector
post
Assign Feature Flags To All Clients
get
Get Client Polaris Credentials
put
Set Client Polaris Credentials
post
Mint Client Polaris Credentials
post
Reset Client Polaris Credentials
get
List Catalog Assets
put
Bulk Status Change
get
Get Catalog Asset
put
Update Catalog Asset
put
Publish Catalog Asset
put
Unpublish Catalog Asset
put
Archive Catalog Asset
put
Flag Catalog Asset For Compliance
put
Set Catalog Asset Status
put
Set Catalog Asset Visibility
put
Set Catalog Asset Tier
get
List Catalog Clients
post
Create Catalog Client
get
Get Catalog Client
put
Update Catalog Client
delete
Delete Catalog Client
get
List Transcripts
put
Bulk Status Change
get
Search Transcript Entities
get
List Transcript Regions
get
Get Transcript
get
Get Transcript Purchases
get
Get Transcript Downloads
get
Get Transcript Content
get
Get Transcript Download Url
put
Set Transcript Status
patch
Update Transcript Metadata
get
List All Client Wide Price Overrides
get
List Transcripts Feature Access
get
Get Default Price
patch
Update Default Price
get
Get Default Price History
get
List Client Price Overrides
put
Set Client Wide Price
delete
Clear Client Wide Price
get
Get Client Wide Price History
put
Bulk Set Client Transcript Price
get
List Transcript Client Price Overrides
put
Bulk Set Transcript Client Price
put
Set Transcript Client Price
delete
Clear Transcript Client Price
get
Get Transcript Client Price History
get
List active catalog sources for the source_type dropdown
get
List portal users
post
Provision a new portal user
get
Get a portal user
delete
Delete a portal user and remove their Okta portal group memberships
patch
Update a portal user
post
Regenerate an activation link for a pending portal user
get
List portals
get
Get Client Types
get
Get Client Type
post
Create Client Type
get
Get Featured Items
get
Get Featured Entities
get
Get Featured Insights
post
Bulk Replace Featured Entities
post
Bulk Replace Featured Insights
get
List Stripe Products
get
List Stripe Products Visibility
put
Update Stripe Products Visibility
get
List Stripe Prices
get
Check Chargeable Payment Method
get
List Plan Subscriptions
post
Create Enterprise Subscription
get
Get Subscription
post
Cancel Subscription
get
List Stripe Cancellations
get
Get Plans
post
Create Plan
get
Get Plan
put
Update Plan
delete
Delete Plan
get
List Plan Configs
get
List Plan Ids
get
Get Plan Overview
get
Get Provider Channel Restrictions For Plan
get
Get Plan Config
put
Update Plan Config
get
List Plan Config Versions
get
Get Plan Config By Version
get
List Plan Config Audit
post
Seed From Json
get
Get Alert Settings
patch
Update Alert Settings
get
Get In Progress Outreach Settings
patch
Update In Progress Outreach Settings
get
Get Block Data Settings
patch
Update Block Data Settings
get
Get Distributor Prompt Settings
patch
Update Distributor Prompt Settings
get
List All Block Requests
get
List Provisioned Clients
get
List Active Contract Billing
get
List Contract Payments
get
Get Block Request Admin
get
List Provisioning Errors
get
Get Block Request Provisioning Timeline
get
Get Block Request Timeline
get
List Internal Queue
post
Internal Approve Accounts
post
Internal Approve Legal
post
Internal Approve Engineering
post
Reset Rejection
post
Approve Contract Cancellation
post
Decline Contract Cancellation
get
Get Contract Grace
post
Extend Contract Grace
post
Retry Provisioning
post
Force Start Trial
post
Force Expire Trial
put
Shift Trial Window
post
Internal Reject Accounts
post
Internal Reject Legal
post
Internal Reject Engineering
get
Get Client Workflow Settings
put
Update Client Workflow Settings
get
List Client Dataset Preapprovals
put
Admin Add Dataset Preapproval
delete
Admin Remove Dataset Preapproval
get
List Active Pricing
post
Schedule Price Change
get
List Pricing Catalog
get
Get Pricing History
post
Import Pricing Csv
get
Export Pricing
put
Update Dataset Setting
get
List Dataset Stripe Skus
patch
Update Stripe Sku Metadata
post
Link Stripe Sku Product
post
Create Stripe Sku Product
post
Create All Stripe Sku Products
put
Update Dataset Sample Settings
get
Get Dataset Sample Preflight
get
Get Dataset Sample Status
post
Reapply Dataset Sample Access
put
Update Dataset Fees
get
List Access Grants
put
Set Access Grant
delete
Clear Access Grant
delete
Delete Access Grant By Id
get
Get Access Audit
get
Get Client Access History
get
List Bulk Apply Eligible Clients
put
Bulk Update Access
patch
Set Client Sample Coupled
put
Bulk Apply Access
get
List Upcoming Invoices
get
List Generated Invoices
post
Override Applied Tokens
patch
Set Auto Apply
post
Mark Invoice Ready
post
Send Invoice Now
get
List All Dataset Audit
get
List Dataset Audit
get
List Entity Types
post
Create Entity Type
get
Get Permission Map By Role
post
Provision Entity With Users
get
List Entities
post
Create Entity
get
Get Entity
put
Update Entity
get
List Users
post
Move User
get
Get User By Email
delete
Delete User By Email
get
List Entity Users
post
Create User
put
Update User Entity
delete
Delete User
get
Get Cart Stats
get
Get Cart Statuses
get
Get Cart Status
delete
Clear Reporting Cache
get
Get Health
post
Set Health Override
delete
Clear Health Override
get
Get Filters
get
Get Kpi Weekly History
get
Get Kpi Weekly
get
Get Kpi Weekly Drilldown
post
Backfill Kpi Weekly
post
Backfill Snapshot Reporting
get
Export Snapshot Reporting
get
Export Snapshot Suppliers
post
Import Snapshot Reporting
get
Get Snapshot History
get
List Snapshot Clients
get
Get Client Engagement
get
Get User Consumption
get
Get User Access
get
Get Supplier Engagement
get
Get Supplier Combined
get
Raw Export
get
Get Client Rum Metrics
get
Get User Rum Metrics
get
Get Summary Pdf
get
Get Product Metrics Endpoint
get
Get User Tracking
get
Get Rum Page Performance Endpoint
get
Get Rum Events
get
Get Cohort Ltv Endpoint
get
Get Conversion Funnel Endpoint
get
List Release Timing Logs
get
List Tools
get
Date Bounds
get
Filter Clients
get
Summary
get
Traces By Tool
get
Latency By Tool
get
Traces By Client
get
Error Codes
get
Error Codes Heatmap
get
Tool Error Hierarchy
get
Traces By Dataset
get
Volume Over Time
get
Latency Over Time
get
Latency By Error Code
get
Insight Error Rate
get
Trace Details
get
Trace Details Csv
get
Get Status
post
Query
get
Get Eval Config
get
List Eval Runs
post
Create Eval Run
get
Get Eval Run
post
Cancel Eval Run
get
Get Replay Config
get
List Replay Runs
post
Create Replay Run
get
Get Replay Run
post
Cancel Replay Run
get
List Tou Versions
post
Update Tou
get
Get Latest Tou
get
Get Tou Version
get
Get Previous Tou Revision
get
List Pending Tou Users
get
Get Latest Block Dataset Tou
get
List Block Dataset Tou Versions
post
Publish Block Dataset Tou
delete
Clear Block Dataset Tou
get
List Privacy Policy Versions
post
Create Privacy Policy Version
get
Get Latest Privacy Policy
get
Get Privacy Policy Version
get
Get Previous Privacy Policy Revision
get
Get Tickers
post
Create Ticker
get
Get Ticker
put
Update Ticker
delete
Delete Ticker
get
Graph Insight Catalog
get
Graph Linked Insight Ids
get
Search Graph Entities
post
Location Resolutions
post
Framework Filters
post
Framework Filter Options
get
List Prisms Tou Versions
post
Create Prisms Tou Version
get
Get Latest Prisms Tou
get
List Prism Categories
post
Create Prism Category
get
List Prism Creators
put
Rename Prism Category
delete
Delete Prism Category
get
Get Prism Account
get
Prism Restriction Impact
get
List Prisms
post
Create Prism
get
Get Prism
put
Update Prism
post
Preview Prism
post
Refresh All Prisms
post
Refresh Prism
post
Archive Prism
get
List Prism Computes
get
Get Prism Compute
post
Recompute Prism Day
get
List Prism Recompute Attempts
get
Get Prism Restrictions
get
List Email Recipient Groups
post
Create Email Recipient Group
get
List Cams Groups
get
List Internal User Suggestions
get
Get Allowed Recipient Domains
get
Get Email Recipient Group
put
Update Email Recipient Group
delete
Delete Email Recipient Group
get
List Effective Members
get
List Email Recipient Group Members
post
Add Email Recipient Group Member
delete
Remove Email Recipient Group Member
get
List Linked Cams Groups
post
Add Linked Cams Group
delete
Remove Linked Cams Group
get
List Email Triggers
post
Create Email Trigger
get
Get Email Trigger
put
Update Email Trigger
delete
Delete Email Trigger
get
List Email Trigger Groups
post
Assign Group To Trigger
delete
Unassign Group From Trigger
get
Get Trigger Emails
get
List Email Notifications
post
Create Email Notification
post
Preview Email Notification Audience
post
Preview Email Notification Audience Users
get
Get Email Notification
put
Update Email Notification
delete
Delete Email Notification
post
Send Email Notification
post
Resend Failed Email Notification
get
List Email Notification Recipients
get
Get Client Onboarding
post
Complete Onboarding Step
post
Parse Csv
get
Get Entity Insights
put
Set Platform Maintenance Mode
Billing Webhooks
1
Integration APIs
20
Okta Event Hook
2
Portal APIs
6
Super Admin APIs
5
System
1
User APIs
184
get
Perform Healthcheck
get
Perform Healthcheck
get
Perform Healthcheck
Admin APIs
roles
Update Role
put
/api/v1/admin/roles/{role_id}
Path parameters
role_id
string
required
Request body
RoleUpdate
required
name
string
required
description
string
nullable
parent_id
string
uuid4
nullable
policy_rules
PolicyRule[]
required
Response
Successful Response
RoleRead
required
name
string
required
description
string
nullable
parent_id
string
uuid4
nullable
id
string
uuid4
required
policy_rules
PolicyRule[]
required