Deployments
Deployments (realms) running on a dedicated cluster.
Get a deployment by ID.
Returns details about a single deployment (realm).
Update a deployment by ID.
Updates mutable settings of a deployment. Only the owner may update it.
Remove a deployment by ID.
Permanently deletes a deployment (realm). Only the owner may delete it.
Create an app link for a deployment.
Authenticates the deployment's admin user against the given client and redirect URI (e.g. to jump into an admin portal or IdP wizard already signed in) and returns a single-use link.
Create an admin console link for a deployment.
Creates a single-use link that signs the caller into this deployment's Keycloak admin console.
List admin credentials for a deployment.
Lists the credentials created for this deployment, with the `realm-management` roles each one currently holds. Secrets are not included; read one back individually with `deployment.credential.secret.read`.
Create an admin credential for a deployment.
Creates a service account client on the deployment's realm for administering that realm directly -- with the Keycloak Terraform provider, a provisioning script, an audit integration, or anything else that speaks Keycloak's admin API. Grants the `realm-management` roles given in `roles`, defaulting to `realm-admin`. The secret is included in this response, and can be read again later with `deployment.credential.secret.read`. See the read-back details on that method. Create a separate credential per holder so they can be revoked independently.
Revoke an admin credential for a deployment.
Deletes the client from the deployment's realm, immediately invalidating the credential. Only credentials created through this API can be revoked here.
Read an admin credential's secret.
Returns the credential including its client secret, read from the deployment's realm. Phase Two keeps no copy; this asks the realm, which is where the secret lives. Reading does not rotate it, so a tool can fetch it on each run instead of persisting it -- which for Terraform means keeping it out of `terraform.tfstate`.
Get metrics for a deployment by ID.
Get metrics for a deployment by ID.
Exchange a token for a deployment access token.
Exchanges the caller's access token for one scoped to this deployment's Keycloak instance, for use when calling that deployment's own admin API directly.