Skip to main content
DocumentationIdentity and access · console.eu.ccsio.ai

Roles

The roles of an organization: the built-in ones and its custom roles.

Documentation menu

The descriptions of the operations and fields are the contract’s own, in English.

GET/identity/v1/organizations/{org}/roles

List the organization's roles and the permission catalog

Credential
API key
Permission
Any ofroles.readsupport-access.read

Requires roles.read held by an active membership of the organization at ANY level - organization or team: a Team Admin whose only binding is a team's can resolve custom role names to render its own roster. Every built-in organization role holds roles.read.

Read more

Returns the four built-in roles in rank order — root, organization_admin, team_admin, user; ccsio_admin is platform-only and never listed — followed by the organization's custom roles by name, and the catalog of permissions a custom role may carry. A custom role renders member_count, created_at and updated_at in addition.

curl
curl "https://console.eu.ccsio.ai/identity/v1/organizations/{org}/roles" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameters

NameInDescription
X-Request-ID
optional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

org
required
pathstring

The organization id (C7 identifier). A value outside the pattern is refused with 400 name-invalid.

Responses

  • 200

    The roles and the permission catalog.

    Schema
    ListRolesResponse
    • rolesarray of Rolerequired

      The four built-in roles in rank order (root, organization_admin, team_admin, user; ccsio_admin is platform-only and never listed), then the organization's custom roles by name.

      • idstringrequired

        pattern ^(ccsio_admin|ccsio_model_registrar|root|organization_admin|team_admin|user|role_[a-z0-9_]{1,59})$

      • kindstringrequired

        Allowed values: "builtin""custom"

      • namestringrequired

        1 to 64 characters

      • descriptionstringrequired

        at most 512 characters

      • levelsarray of stringrequired

        Where the role may be assigned: root and organization_admin at organization level, team_admin at team level, user and every custom role at both.

        Allowed values: "organization""team"

        at least 1 items

      • permissionsarray of Permissionrequired

        In the closed vocabulary's canonical order.

      • member_countintegeroptional

        Custom roles only.

        at least 0

      • created_atstring (date-time)optional

        Custom roles only. RFC 3339, second precision, UTC.

      • updated_atstring (date-time)optional

        Custom roles only. RFC 3339, second precision, UTC.

    • permission_catalogarray of PermissionCatalogEntryrequired

      The permissions a custom role may carry, in the closed vocabulary's canonical order.

      • idstringrequired

        A permission a custom role may carry: every permission except organization.delete and members.transfer (root alone), users.manage (held by ccsio_admin alone) and the platform-scoped ones (34 strings, teams.read_own among them; the two AI-199 platform-scoped permissions, the two platform-operators permissions, registry.manage, platform-usage.read, the three that write the model catalog and manage deployments, models.manage, deployments.read and deployments.manage, the two of the model groups, model-groups.read and model-groups.manage, and the three of model credits, credits.read, credits.grant and credits.revoke, are not among them; mcp.invoke, mcp.read, mcp.manage and model-providers.manage are). The acting principal must effectively hold every permission it puts into a role.

        Allowed values: "organization.read""organization.update""teams.read""teams.read_own""teams.create""teams.update""teams.archive""team-members.read""team-members.manage""members.read""members.manage""users.read""roles.read""roles.manage""sso.manage""api-keys.read""api-keys.manage""entitlements.read""team-entitlements.manage""models.read""memory.read""memory.manage""memory.use""memory.review""brain.read""brain.manage""audit.read""audit.read_own""audit.sensitive.read""usage.read""usage.read_own""usage.manage""inference.invoke""inference.read""mcp.invoke""mcp.read""mcp.manage""model-providers.manage"

      • levelsarray of stringrequired

        The levels a role carrying this permission may be assigned at.

        Allowed values: "organization""team"

        at least 1 items

  • 400

    Client refusal unrelated to authentication, including malformed input, a denied or failed request.

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Read more

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 402

    The organization has to pay first: its standing is payment_required.

    Read more

    The request boundary applies this payment gate to every route except an organization's billing routes, the caller's own context, organization list, onboarding, session report and personal keys, the public routes, and the routes of platform operators, who administer an organization that has to pay. The operations the gate covers declare this response. On /v1 the refusal is rendered in the OpenAI error format. Code: payment-required

  • 403

    No role of the caller holds either `roles.read` or `support-access.read` in the organization, at organization or team level (policy-denied), or the organization the request names is not the caller's own (tenant-mismatch). Codes: policy-denied, tenant-mismatch

  • 404

    The requested resource or path was not found.

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 500

    Platform failure, rendered without internal cause details.

  • 503

    Custom roles are not configured on this plane, or an operator's read under an open support session could not be recorded, so nothing was served. Codes: role-management-unavailable (no custom role use case is wired on this plane), support-audit-unavailable (the support read could not be recorded)

POST/identity/v1/organizations/{org}/roles

Create a custom role

Credential
API key
Permission
roles.manage
Request body
Body up to 1 MiB

Requires roles.manage. Creates a per-organization custom role: a name (unique within the organization case-insensitively, never a built-in role's name), an optional description and a permission set chosen from the catalog (every permission except organization.delete and the platform-scoped ones).

Read more

The id is server-generated (role_<id>), path-safe and can never collide with a built-in id; it is used verbatim as the role value everywhere a role travels. Anti-escalation: the acting principal must effectively hold every permission it puts into the role at organization scope (403 role-escalation). Sensitive: audited.

curl
curl -X POST "https://console.eu.ccsio.ai/identity/v1/organizations/{org}/roles" \
  -H "Authorization: Bearer $CCSIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Usage analyst",
  "description": "Reads usage and the member list of the whole organization.",
  "permissions": [
    "members.read",
    "usage.read"
  ]
}'

Parameters

NameInDescription
X-Request-ID
optional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

org
required
pathstring

The organization id (C7 identifier). A value outside the pattern is refused with 400 name-invalid.

Request body application/json

CreateRoleRequest
  • namestringrequired

    Trimmed, 1 to 64 characters, no control characters; unique within the organization case-insensitively and never a built-in role's name (Root, Admin, Team Admin, User).

    1 to 64 characters

  • descriptionstringoptional

    Optional; trimmed.

    at most 512 characters

  • permissionsarray of CustomRolePermissionrequired

    Duplicates are collapsed. May be empty.

    Allowed values: "organization.read""organization.update""teams.read""teams.read_own""teams.create""teams.update""teams.archive""team-members.read""team-members.manage""members.read""members.manage""users.read""roles.read""roles.manage""sso.manage""api-keys.read""api-keys.manage""entitlements.read""team-entitlements.manage""models.read""memory.read""memory.manage""memory.use""memory.review""brain.read""brain.manage""audit.read""audit.read_own""audit.sensitive.read""usage.read""usage.read_own""usage.manage""inference.invoke""inference.read""mcp.invoke""mcp.read""mcp.manage""model-providers.manage"

Responses

  • 201

    The created custom role (member_count 0).

    Schema
    Role
    • idstringrequired

      pattern ^(ccsio_admin|ccsio_model_registrar|root|organization_admin|team_admin|user|role_[a-z0-9_]{1,59})$

    • kindstringrequired

      Allowed values: "builtin""custom"

    • namestringrequired

      1 to 64 characters

    • descriptionstringrequired

      at most 512 characters

    • levelsarray of stringrequired

      Where the role may be assigned: root and organization_admin at organization level, team_admin at team level, user and every custom role at both.

      Allowed values: "organization""team"

      at least 1 items

    • permissionsarray of Permissionrequired

      In the closed vocabulary's canonical order.

      Allowed values: "organization.create""organization.read""organization.update""organization.delete""organization.status""teams.read""teams.read_own""teams.create""teams.update""teams.archive""team-members.read""team-members.manage""members.read""members.manage""members.transfer""users.read""users.manage""roles.read""roles.manage""sso.manage""api-keys.read""api-keys.manage""entitlements.read""entitlements.manage""team-entitlements.manage""issuers.read""issuers.manage""models.read""models.manage""models.register""model-registrars.manage""platform-operators.read""platform-operators.manage""registry.manage""platform-usage.read""support-sessions.start""support-sessions.manage""support-access.read""deployments.read""deployments.manage""model-groups.read""model-groups.manage""credits.read""credits.grant""credits.revoke""memory.read""memory.manage""memory.use""memory.review""brain.read""brain.manage""audit.read""audit.read_own""audit.sensitive.read""usage.read""usage.read_own""usage.manage""inference.invoke""inference.read""mcp.invoke""mcp.read""mcp.manage""model-providers.manage"

    • member_countintegeroptional

      Custom roles only.

      at least 0

    • created_atstring (date-time)optional

      Custom roles only. RFC 3339, second precision, UTC.

    • updated_atstring (date-time)optional

      Custom roles only. RFC 3339, second precision, UTC.

  • 400

    Client refusal. Codes: invalid-request (the body is not valid JSON, has an unknown or trailing member, or lacks a required one), custom-role-invalid (the name is empty, too long or has control characters, the description is too long, or a permission is outside the catalog)

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Read more

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 402

    The organization has to pay first: its standing is payment_required.

    Read more

    The request boundary applies this payment gate to every route except an organization's billing routes, the caller's own context, organization list, onboarding, session report and personal keys, the public routes, and the routes of platform operators, who administer an organization that has to pay. The operations the gate covers declare this response. On /v1 the refusal is rendered in the OpenAI error format. Code: payment-required

  • 403

    No role of the caller holds `roles.manage` in the organization (policy-denied), or the organization the request names is not the caller's own (tenant-mismatch). Codes: policy-denied, tenant-mismatch, role-escalation (the caller does not hold every permission it puts into the role)

  • 404

    The organization was deleted while the request ran. Codes: organization-not-found

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 409

    The name is taken in the organization (case-insensitively) or is a built-in role's name. Codes: role-name-taken

  • 500

    Platform failure, rendered without internal cause details.

  • 503

    Custom roles are not configured on this plane. Codes: role-management-unavailable (no custom role use case is wired on this plane)

Example response
{
  "id": "role_01k7yq4d8m2p6s9v3x5z7b1c4f",
  "kind": "custom",
  "name": "Usage analyst",
  "description": "Reads usage and the member list of the whole organization.",
  "levels": [
    "organization",
    "team"
  ],
  "permissions": [
    "members.read",
    "usage.read"
  ],
  "member_count": 0,
  "created_at": "2026-10-14T09:45:00Z",
  "updated_at": "2026-10-14T09:45:00Z"
}
PATCH/identity/v1/organizations/{org}/roles/{role}

Update a custom role

Credential
API key
Permission
roles.manage
Request body
Body up to 1 MiB

Requires roles.manage. Any of name, description and permissions (at least one); permissions replaces the whole set. A built-in role is immutable (403 role-builtin). Anti-escalation: the actor must hold every permission the role carries before the change and after it (403 role-escalation). The new permission set takes effect on the next request of every holder — no stale authority beyond an in-flight request. Sensitive: audited.

curl
curl -X PATCH "https://console.eu.ccsio.ai/identity/v1/organizations/{org}/roles/{role}" \
  -H "Authorization: Bearer $CCSIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Built from the schema’s required members: replace the values.

Parameters

NameInDescription
X-Request-ID
optional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

org
required
pathstring

The organization id (C7 identifier). A value outside the pattern is refused with 400 name-invalid.

role
required
pathstring

A custom role id (role_<id>), as listed by GET /identity/v1/organizations/{org}/roles. A built-in role id is accepted by the route and refused with 403 role-builtin; any other value is 404 role-not-found.

Request body application/json

UpdateRoleRequest
  • namestringoptional

    1 to 64 characters

  • descriptionstringoptional

    at most 512 characters

  • permissionsarray of CustomRolePermissionoptional

    Replaces the whole permission set.

    Allowed values: "organization.read""organization.update""teams.read""teams.read_own""teams.create""teams.update""teams.archive""team-members.read""team-members.manage""members.read""members.manage""users.read""roles.read""roles.manage""sso.manage""api-keys.read""api-keys.manage""entitlements.read""team-entitlements.manage""models.read""memory.read""memory.manage""memory.use""memory.review""brain.read""brain.manage""audit.read""audit.read_own""audit.sensitive.read""usage.read""usage.read_own""usage.manage""inference.invoke""inference.read""mcp.invoke""mcp.read""mcp.manage""model-providers.manage"

Responses

  • 200

    The updated custom role.

    Schema
    Role
    • idstringrequired

      pattern ^(ccsio_admin|ccsio_model_registrar|root|organization_admin|team_admin|user|role_[a-z0-9_]{1,59})$

    • kindstringrequired

      Allowed values: "builtin""custom"

    • namestringrequired

      1 to 64 characters

    • descriptionstringrequired

      at most 512 characters

    • levelsarray of stringrequired

      Where the role may be assigned: root and organization_admin at organization level, team_admin at team level, user and every custom role at both.

      Allowed values: "organization""team"

      at least 1 items

    • permissionsarray of Permissionrequired

      In the closed vocabulary's canonical order.

      Allowed values: "organization.create""organization.read""organization.update""organization.delete""organization.status""teams.read""teams.read_own""teams.create""teams.update""teams.archive""team-members.read""team-members.manage""members.read""members.manage""members.transfer""users.read""users.manage""roles.read""roles.manage""sso.manage""api-keys.read""api-keys.manage""entitlements.read""entitlements.manage""team-entitlements.manage""issuers.read""issuers.manage""models.read""models.manage""models.register""model-registrars.manage""platform-operators.read""platform-operators.manage""registry.manage""platform-usage.read""support-sessions.start""support-sessions.manage""support-access.read""deployments.read""deployments.manage""model-groups.read""model-groups.manage""credits.read""credits.grant""credits.revoke""memory.read""memory.manage""memory.use""memory.review""brain.read""brain.manage""audit.read""audit.read_own""audit.sensitive.read""usage.read""usage.read_own""usage.manage""inference.invoke""inference.read""mcp.invoke""mcp.read""mcp.manage""model-providers.manage"

    • member_countintegeroptional

      Custom roles only.

      at least 0

    • created_atstring (date-time)optional

      Custom roles only. RFC 3339, second precision, UTC.

    • updated_atstring (date-time)optional

      Custom roles only. RFC 3339, second precision, UTC.

  • 400

    Client refusal. Codes: invalid-request (the body is not valid JSON, has an unknown member, or names none of name, description and permissions), custom-role-invalid (the name is empty, too long or has control characters, the description is too long, or a permission is outside the catalog)

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Read more

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 402

    The organization has to pay first: its standing is payment_required.

    Read more

    The request boundary applies this payment gate to every route except an organization's billing routes, the caller's own context, organization list, onboarding, session report and personal keys, the public routes, and the routes of platform operators, who administer an organization that has to pay. The operations the gate covers declare this response. On /v1 the refusal is rendered in the OpenAI error format. Code: payment-required

  • 403

    No role of the caller holds `roles.manage` in the organization (policy-denied), or the organization the request names is not the caller's own (tenant-mismatch). Codes: policy-denied, tenant-mismatch, role-builtin (a built-in role is immutable), role-escalation (the caller does not hold every permission the role carries before and after the change)

  • 404

    The role is not a custom role of the organization. Codes: role-not-found

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 409

    The new name is taken in the organization (case-insensitively) or is a built-in role's name. Codes: role-name-taken

  • 500

    Platform failure, rendered without internal cause details.

  • 503

    Custom roles are not configured on this plane. Codes: role-management-unavailable (no custom role use case is wired on this plane)

DELETE/identity/v1/organizations/{org}/roles/{role}

Delete a custom role

Credential
API key
Permission
roles.manage

Requires roles.manage. A custom role held by any non-removed membership (active or disabled) cannot be deleted: 409 role-in-use. A built-in role is 403 role-builtin. The actor must hold every permission the role carries (403 role-escalation). Sensitive: audited.

curl
curl -X DELETE "https://console.eu.ccsio.ai/identity/v1/organizations/{org}/roles/{role}" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameters

NameInDescription
X-Request-ID
optional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

org
required
pathstring

The organization id (C7 identifier). A value outside the pattern is refused with 400 name-invalid.

role
required
pathstring

A custom role id (role_<id>), as listed by GET /identity/v1/organizations/{org}/roles. A built-in role id is accepted by the route and refused with 403 role-builtin; any other value is 404 role-not-found.

Responses

  • 204

    The role was deleted.

  • 400

    Client refusal unrelated to authentication, including malformed input, a denied or failed request.

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Read more

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 402

    The organization has to pay first: its standing is payment_required.

    Read more

    The request boundary applies this payment gate to every route except an organization's billing routes, the caller's own context, organization list, onboarding, session report and personal keys, the public routes, and the routes of platform operators, who administer an organization that has to pay. The operations the gate covers declare this response. On /v1 the refusal is rendered in the OpenAI error format. Code: payment-required

  • 403

    No role of the caller holds `roles.manage` in the organization (policy-denied), or the organization the request names is not the caller's own (tenant-mismatch). Codes: policy-denied, tenant-mismatch, role-builtin (a built-in role cannot be deleted), role-escalation (the caller does not hold every permission the role carries)

  • 404

    The role is not a custom role of the organization. Codes: role-not-found

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 409

    A membership that is not removed still holds the role. Codes: role-in-use

  • 500

    Platform failure, rendered without internal cause details.

  • 503

    Custom roles are not configured on this plane. Codes: role-management-unavailable (no custom role use case is wired on this plane)

Generated from the platform contracts at commit 5954fbc1.

Explore the platform

Get your first API key

Registration is open. Four steps to your first call: create your account, create your organization, create your API key, and start using it.

  1. 01Create your account
  2. 02Create your organization
  3. 03Create your API key
  4. 04Start using it