Zum Hauptinhalt springen
DokumentationIdentität und Zugriff · console.eu.ccsio.ai

API keys

The service-account API keys of an organization: issue, read, revoke and delete, and the principals that hold them.

Menü der Dokumentation

Die Beschreibungen der Operationen und Felder stammen aus dem Vertrag und sind auf Englisch.

GET/identity/v1/api-keys

List the organization's API keys

Anmeldedaten
API-Key
Berechtigung
Eine vonapi-keys.readsupport-access.read

Lists the organization's key views WITHOUT raw, deterministic by key id. The org id is the required org query parameter. A deleted key is not listed.

curl
curl "https://console.eu.ccsio.ai/identity/v1/api-keys?org=<org>" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameter

NameInBeschreibung
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
Pflicht
querystring

The organization whose API keys or eligible service-account principals are listed (C7 identifier).

Antworten

  • 200

    The API-key list (views without raw).

    Schema
    ListAPIKeysResponse
    • api_keysarray of APIKeyPflicht
      • key_idstringPflicht

        The platform-minted key id (uppercase ULID).

        pattern ^[0-9A-HJKMNP-TV-Z]{26}$

      • org_idstringPflicht

        pattern ^[a-z][a-z0-9._-]{0,63}$

      • namestringPflicht

        1 to 128 characters

      • principal_refstringPflicht

        pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

      • prefixstringPflicht

        The display prefix (ccsio_ plus the first 8 entropy characters) — never the raw value, never a digest.

        pattern ^ccsio_[A-Za-z0-9_-]{8}$

      • created_bystringPflicht

        pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

      • created_atstring (date-time)Pflicht

        RFC 3339, second precision, UTC.

      • expires_atstring (date-time) or nullPflicht

        RFC 3339, second precision, UTC; null when the key has no expiry.

      • statestringPflicht

        The key state; revoked is terminal.

        Erlaubte Werte: "active""revoked"

      • revoked_atstring (date-time) or nullPflicht

        RFC 3339, second precision, UTC; null while active.

      • kindstringPflicht

        The persisted credential type; existing service-account keys retain service_account.

        Erlaubte Werte: "personal""service_account"

      • ownerobjectoptional
        • display_namestringPflicht

          Readable owner name from the identity profile.

        • emailstringoptional

          Owner email when known; presentation only, never an authorization identifier.

        • kindstringPflicht

          Erlaubte Werte: "human""service_account"

  • 400

    Client refusal. Codes: invalid-request (the org query parameter is missing or empty)

  • 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:

    Weiterlesen

    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.

    Weiterlesen

    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 `api-keys.read` or `support-access.read` in the organization (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

    An operator's read under an open support session could not be recorded, so nothing was served. Codes: support-audit-unavailable

POST/identity/v1/api-keys

Issue a new API key for the organization

Anmeldedaten
API-Key
Berechtigung
api-keys.manage
Request-Body
Body bis 1 MiB

org_id, name, and principal_ref are required; created_by is an optional compatibility field that is ignored: the server records the verified actor as the creator. principal_ref must identify an active service account with an active membership in the same organization.

Weiterlesen

Requires api-keys.manage in that organization; expires_at (RFC 3339) is optional — absent or an empty string means no expiry, and an expiry not after creation is refused with 400 api-key-invalid. The 200 response carries the raw key exactly once — on successful issuance; every later key view carries the ccsio_ display prefix and never the raw value or a digest. No idempotency: the key id is platform-minted, so a redelivered issue mints a second key (the operator revokes the unneeded one) — pinned deliberately.

curl
curl -X POST "https://console.eu.ccsio.ai/identity/v1/api-keys" \
  -H "Authorization: Bearer $CCSIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "org_id": "acme",
  "name": "billing-app production",
  "principal_ref": "svc/01K7YP2C9W4X5E8H3J6M0N1Q2R",
  "expires_at": "2027-01-31T00:00:00Z"
}'

Parameter

NameInBeschreibung
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.

Request-Body application/json

IssueKeyRequest
  • org_idstringPflicht

    The organization id (C7 identifier) the key belongs to.

    pattern ^[a-z][a-z0-9._-]{0,63}$

  • namestringPflicht

    The operator-facing key name.

    1 to 128 characters

  • principal_refstringPflicht

    An active service account in this organization, selected from GET /identity/v1/api-key-principals.

    pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

  • created_bystringoptional

    Ignored compatibility field. The server always records the verified actor as created_by; clients should omit this field.

  • expires_atstring (date-time) or nulloptional

    Optional RFC 3339 expiry, second precision, UTC; absent or an empty string (or null) means no expiry. A non-empty value not after the creation instant is refused (api-key-invalid).

Antworten

  • 200

    The issued service-account key view, including its raw value exactly once.

    Schema
    IssuedAPIKey
    • key_idstringPflicht

      The platform-minted key id (uppercase ULID).

      pattern ^[0-9A-HJKMNP-TV-Z]{26}$

    • org_idstringPflicht

      pattern ^[a-z][a-z0-9._-]{0,63}$

    • namestringPflicht

      1 to 128 characters

    • principal_refstringPflicht

      pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

    • prefixstringPflicht

      The display prefix (ccsio_ plus the first 8 entropy characters) — never the raw value, never a digest.

      pattern ^ccsio_[A-Za-z0-9_-]{8}$

    • created_bystringPflicht

      pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

    • created_atstring (date-time)Pflicht

      RFC 3339, second precision, UTC.

    • expires_atstring (date-time) or nullPflicht

      RFC 3339, second precision, UTC; null when the key has no expiry.

    • statestringPflicht

      A freshly issued key is always active.

      Erlaubte Werte: "active"

    • revoked_atnull or nullPflicht

      A freshly issued key is never revoked; renders null.

    • rawstringPflicht

      The raw key value, returned exactly once on successful issuance (service-account or personal): ccsio_ followed by 32 alphanumeric characters. Never returned by list, read or revoke operations, or included in errors or logs. Keys issued before this form (ccsio_ plus 43 base64url characters) remain valid credentials but are never minted again.

      pattern ^ccsio_[A-Za-z0-9]{32}$

    • kindstringPflicht

      The persisted credential type; existing service-account keys retain service_account.

      Erlaubte Werte: "personal""service_account"

    • ownerobjectoptional
      • display_namestringPflicht

        Readable owner name from the identity profile.

      • emailstringoptional

        Owner email when known; presentation only, never an authorization identifier.

      • kindstringPflicht

        Erlaubte Werte: "human""service_account"

  • 400

    Client refusal. Codes: invalid-request (the body is not valid JSON, has an unknown or trailing member, lacks org_id, name or principal_ref, or expires_at is not an RFC 3339 instant), api-key-invalid (the name is empty or longer than 128 bytes, the expiry is not in the future, or principal_ref is the reserved bootstrap principal), ref-invalid (principal_ref outside the C0 ref pattern)

  • 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:

    Weiterlesen

    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.

    Weiterlesen

    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 `api-keys.manage` in the organization (policy-denied), or the organization the request names is not the caller's own (tenant-mismatch).

    Weiterlesen

    Codes: policy-denied, tenant-mismatch, platform-principal-refused (principal_ref already holds a platform role and the caller is not a platform administrator), membership-forbidden (principal_ref is not an active service account of the organization, or the key would give it more authority than the caller may hand out)

  • 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.

  • 500

    Platform failure, rendered without internal cause details.

Beispielantwort
{
  "key_id": "01K7YQ4D8M2P6S9V3X5Z7B1C4F",
  "kind": "service_account",
  "owner": {
    "display_name": "billing-app",
    "kind": "service_account"
  },
  "org_id": "acme",
  "name": "billing-app production",
  "principal_ref": "svc/01K7YP2C9W4X5E8H3J6M0N1Q2R",
  "prefix": "ccsio_ExampleK",
  "created_by": "user/onboard/01K7YN1B3C5D7F9H2K4M6P8R0T",
  "created_at": "2026-10-14T09:30:00Z",
  "expires_at": "2027-01-31T00:00:00Z",
  "state": "active",
  "revoked_at": null,
  "raw": "ccsio_ExampleKeyShownOnceAtCreation000"
}
GET/identity/v1/api-keys/{id}

Read one API key

Anmeldedaten
API-Key
Berechtigung
Eine vonapi-keys.readsupport-access.read

The key view WITHOUT raw. The path is the platform-minted key id (ULID). A deleted key is gone: 404 api-key-not-found.

curl
curl "https://console.eu.ccsio.ai/identity/v1/api-keys/{id}" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameter

NameInBeschreibung
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.

id
Pflicht
pathstring

The platform-minted API-key id (uppercase ULID).

Antworten

  • 200

    The key view (without raw).

    Schema
    APIKey
    • key_idstringPflicht

      The platform-minted key id (uppercase ULID).

      pattern ^[0-9A-HJKMNP-TV-Z]{26}$

    • org_idstringPflicht

      pattern ^[a-z][a-z0-9._-]{0,63}$

    • namestringPflicht

      1 to 128 characters

    • principal_refstringPflicht

      pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

    • prefixstringPflicht

      The display prefix (ccsio_ plus the first 8 entropy characters) — never the raw value, never a digest.

      pattern ^ccsio_[A-Za-z0-9_-]{8}$

    • created_bystringPflicht

      pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

    • created_atstring (date-time)Pflicht

      RFC 3339, second precision, UTC.

    • expires_atstring (date-time) or nullPflicht

      RFC 3339, second precision, UTC; null when the key has no expiry.

    • statestringPflicht

      The key state; revoked is terminal.

      Erlaubte Werte: "active""revoked"

    • revoked_atstring (date-time) or nullPflicht

      RFC 3339, second precision, UTC; null while active.

    • kindstringPflicht

      The persisted credential type; existing service-account keys retain service_account.

      Erlaubte Werte: "personal""service_account"

    • ownerobjectoptional
      • display_namestringPflicht

        Readable owner name from the identity profile.

      • emailstringoptional

        Owner email when known; presentation only, never an authorization identifier.

      • kindstringPflicht

        Erlaubte Werte: "human""service_account"

  • 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:

    Weiterlesen

    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.

    Weiterlesen

    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 `api-keys.read` or `support-access.read` in the organization (policy-denied). Codes: policy-denied

  • 404

    No such key in the caller's organization: an unknown id, another organization's key, or a deleted one. Codes: api-key-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

    An operator's read under an open support session could not be recorded, so nothing was served. Codes: support-audit-unavailable

DELETE/identity/v1/api-keys/{id}

Delete a revoked API key

Anmeldedaten
API-Key
Berechtigung
api-keys.manage

Requires api-keys.manage, the permission revoking a key needs.

Weiterlesen

Deletes a key of the caller's organization, and only once it is revoked: the key then disappears from every list and read (GET /identity/v1/api-keys, GET /identity/v1/api-keys/{id}, a personal key list) and from the console, and can never authenticate - it was revoked already. The record itself is kept, so audit references keep resolving: a security event's item label and actor.key_id still name the key. An ACTIVE key is refused 409 api-key-active (revoke it first); an unknown id, another organization's key and an already deleted key are all 404 api-key-not-found. Sensitive: audited as api_key.deleted. No request body.

curl
curl -X DELETE "https://console.eu.ccsio.ai/identity/v1/api-keys/{id}" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameter

NameInBeschreibung
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.

id
Pflicht
pathstring

The platform-minted API-key id (uppercase ULID).

Antworten

  • 204

    The key is deleted. No body.

  • 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:

    Weiterlesen

    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.

    Weiterlesen

    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 `api-keys.manage` in the organization (policy-denied). Codes: policy-denied

  • 404

    No such key in the caller's organization: an unknown id, another organization's key, or one already deleted. Codes: api-key-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 key is still active: revoke it first. Codes: api-key-active

  • 500

    Platform failure, rendered without internal cause details.

POST/identity/v1/api-keys/{id}/revoke

Revoke an API key (terminal)

Anmeldedaten
API-Key
Berechtigung
api-keys.manage

Revokes the key (the revoked state is terminal). Re-revoking returns the stored revoked key (idempotent). No request body. A deleted key is 404 api-key-not-found like an unknown one.

curl
curl -X POST "https://console.eu.ccsio.ai/identity/v1/api-keys/{id}/revoke" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameter

NameInBeschreibung
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.

id
Pflicht
pathstring

The platform-minted API-key id (uppercase ULID).

Antworten

  • 200

    The key view, state revoked, with revoked_at.

    Schema
    APIKey
    • key_idstringPflicht

      The platform-minted key id (uppercase ULID).

      pattern ^[0-9A-HJKMNP-TV-Z]{26}$

    • org_idstringPflicht

      pattern ^[a-z][a-z0-9._-]{0,63}$

    • namestringPflicht

      1 to 128 characters

    • principal_refstringPflicht

      pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

    • prefixstringPflicht

      The display prefix (ccsio_ plus the first 8 entropy characters) — never the raw value, never a digest.

      pattern ^ccsio_[A-Za-z0-9_-]{8}$

    • created_bystringPflicht

      pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

    • created_atstring (date-time)Pflicht

      RFC 3339, second precision, UTC.

    • expires_atstring (date-time) or nullPflicht

      RFC 3339, second precision, UTC; null when the key has no expiry.

    • statestringPflicht

      The key state; revoked is terminal.

      Erlaubte Werte: "active""revoked"

    • revoked_atstring (date-time) or nullPflicht

      RFC 3339, second precision, UTC; null while active.

    • kindstringPflicht

      The persisted credential type; existing service-account keys retain service_account.

      Erlaubte Werte: "personal""service_account"

    • ownerobjectoptional
      • display_namestringPflicht

        Readable owner name from the identity profile.

      • emailstringoptional

        Owner email when known; presentation only, never an authorization identifier.

      • kindstringPflicht

        Erlaubte Werte: "human""service_account"

  • 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:

    Weiterlesen

    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.

    Weiterlesen

    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 `api-keys.manage` in the organization (policy-denied). Codes: policy-denied

  • 404

    No such key in the caller's organization: an unknown id, or another organization's key. Codes: api-key-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.

GET/identity/v1/api-key-principals

List service accounts available for API-key issuance

Anmeldedaten
API-Key
Berechtigung
api-keys.manage

Requires api-keys.manage in the requested organization. Returns active service accounts with an active organization membership, ordered by stable principal reference. Human users and principals from other organizations are excluded. The cursor is opaque and bound to the organization.

curl
curl "https://console.eu.ccsio.ai/identity/v1/api-key-principals?org=<org>" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameter

NameInBeschreibung
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
Pflicht
querystring

The organization whose API keys or eligible service-account principals are listed (C7 identifier).

limit
optional
queryinteger
cursor
optional
querystring

Opaque next_cursor from the preceding page for this organization.

Antworten

  • 200

    The eligible service-account page.

    Schema
    ListAPIKeyPrincipalsResponse
    • principalsarray of APIKeyPrincipalPflicht
      • principal_refstringPflicht

        Stable service-account reference sent as principal_ref when issuing a key.

        pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

      • display_namestringPflicht
      • kindstringPflicht

        always "service_account"

    • next_cursorstring or nullPflicht

      Opaque continuation cursor; null at the end of the result set.

  • 400

    Client refusal. Codes: invalid-request (the org query parameter is missing, limit is not an integer in 1 to 100, or the cursor is malformed, longer than 2048 characters or bound to another organization)

  • 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:

    Weiterlesen

    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.

    Weiterlesen

    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 `api-keys.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, membership-forbidden (service accounts are not wired on this plane)

  • 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.

Erzeugt aus den Plattformverträgen beim Commit 5954fbc1.

Plattform entdecken

Deinen ersten API-Key holen

Die Registrierung ist offen. Vier Schritte bis zum ersten Aufruf: Konto erstellen, Organisation anlegen, API-Key erzeugen, loslegen.

  1. 01Konto erstellen
  2. 02Organisation anlegen
  3. 03API-Key erzeugen
  4. 04Loslegen