Admin APIs
polaris

Set Client Polaris Credentials

Changed on

Persist an externally-obtained Polaris client_id/secret pair.

Use when the Polaris principal already exists with credentials CAMS didn't mint (e.g. created by a non-internal-token flow), so the normal mint/rotate path is unavailable. The operator pastes the existing pair — sourced from the customer's vault, the original onboarding ticket, etc. — and CAMS stores them so the SQL editor's "Connect Your Query Engine" modal can surface them like any other client.

Does not call Polaris and does not validate the pair against Polaris. If the values are wrong, the customer's SQL editor sessions will 401 when they try to use them.

All three columns (principal_name, client_id, client_secret) are required on the request and written together — the row never carries client_id/secret without a principal_name.

put/api/v1/admin/polaris/clients/{client_id}/credentials

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/polaris/clients/{client_id}/credentials
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Path parameters

client_idstring required

Request body

polaris_client_idstring required

Existing Polaris client_id for this client's principal — obtained out-of-band (customer's vault, original onboarding ticket, etc.).

polaris_client_secretstring required

Existing Polaris client_secret matching polaris_client_id. Polaris does not expose existing secrets, so this is the only path for CAMS to hold creds for a principal it didn't mint.

polaris_principal_namestring required

Polaris principal name the pair belongs to. Required: CAMS will not derive or carry forward a stored value — the operator must name the principal explicitly so the three columns are always written together from a single source.

Response

Successful Response

mintedboolean required
polaris_principal_namestring nullable
polaris_client_idstring nullable
polaris_client_secretstring nullable
polaris_provisioned_atstring date-time nullable
polaris_provisioning_statusstring nullable
polaris_provisioning_errorstring nullable
polaris_provisioning_attempted_atstring date-time nullable
polaris_provisioning_attempted_bystring nullable
polaris_provisioning_attempted_sourcestring nullable

Changes

  • d1966b531e25Revision changes
    • breaking

      added the pattern ^[a-zA-Z0-9_-]+$ to the request property

    • warning

      the request property's maxLength was set to 128