Admin APIs
groups

Create Group

Changed on

Create a group, optionally setting its MCP period limit, MCP access and Block role in the same request.

Runs under the router's groups:create permission even when it revokes MCP access, unlike revoke_group_access below which requires groups:edit — a brand-new group has no members, so creating one pre-revoked takes access away from nobody and cannot escalate anyone's privileges. No OktaService dependency for the same reason: the revocation touches no existing membership, so there is nothing to sync.

post/api/v1/admin/groups

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/admin/groups
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Request body

namestring required
descriptionstring nullable
transaction_limitnumber nullable
allocated_amountnumber nullable
client_idstring uuid required
is_defaultboolean nullable
is_activeboolean nullable
meta_dataobject nullable
user_idsstring[] nullable
block_role'block_user' | 'block_admin'

Additive Block role values stored directly on users.block_role and groups.block_role (block_role_enum Postgres enum). Matches the snake_case value set used elsewhere in the Block domain.

mcp_period_limitnumber nullable
mcp_access_revokedboolean nullable

Response

Successful Response

namestring required
descriptionstring nullable
transaction_limitnumber nullable
allocated_amountnumber nullable
client_idstring uuid required
is_defaultboolean nullable
is_activeboolean nullable
meta_dataobject nullable
user_idsstring[] nullable
block_role'block_user' | 'block_admin'

Additive Block role values stored directly on users.block_role and groups.block_role (block_role_enum Postgres enum). Matches the snake_case value set used elsewhere in the Block domain.

idstring uuid required
keystring required
current_consumptionnumber nullable
mcp_period_limitnumber nullable
mcp_period_consumptionnumber nullable
mcp_period_reset_datestring date-time nullable
mcp_period_next_reset_datestring date-time nullable
mcp_period_start_datestring date-time nullable
mcp_access_revokedboolean nullable
mcp_access_revoked_atstring date-time nullable

Changes

  • a8ca30023371Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property