Prerequisites
- An identity provider that supports SCIM 2.0 provisioning, such as Okta or Microsoft Entra ID
- The SCIM API enabled for your deploy. Contact your Cake team to enable it.
openssl,python3, andshasumto generate a token
SCIM endpoint
Configure your identity provider with this base URL:
The API supports
PATCH operations and filtering, and returns at most 100 results per page.
Each userName must be a valid DNS subdomain name: letters, numbers, -, and ., starting and ending with a letter or number. If a user name fails this check, the API returns 400 Bad Request.
Create a SCIM token
The SCIM API authenticates requests with a bearer token. You generate the token yourself and send Cake only its SHA-256 hash, so the token never leaves your organization.1
Generate a token and its hash
Run this script:Tokens use the format
ckmz_<random>_<checksum>. The ckmz_ prefix lets secret scanning tools detect leaked tokens, and the checksum catches copy errors.2
Send the hash to Cake
Send the
sha256:... hash to your Cake team, along with a client ID that identifies the tenant this token provisions. Cake adds the hash to your deploy configuration.3
Configure your identity provider
In your identity provider’s SCIM settings, set the base URL to
https://marzipan.<base-hostname>/scim/v2 and the bearer token to your token.Tenants
Each token is tied to a client ID. The SCIM API uses that client ID to scope resources such asexternalId. If you provision users for more than one tenant, create a separate token for each tenant.