Deployments.ai Docs
Command reference

deployments identity-provider

The organization's OIDC or SAML identity provider for single sign-on

CommandSummary
deployments identity-provider showShow the identity provider and the values to register with it
deployments identity-provider setConfigure the OIDC or SAML identity provider; a new OIDC issuer or client ID needs a new secret
deployments identity-provider set-stateActivate, require, or disable sign-in through the identity provider
deployments identity-provider deleteDelete the identity provider and its client secret
deployments identity-provider linksList identities linked through the identity provider
deployments identity-provider unlinkRemove a federated identity link

deployments identity-provider show

Show the identity provider and the values to register with it.

deployments identity-provider show

Also accepts the global flags.

deployments identity-provider set

Configure the OIDC or SAML identity provider; a new OIDC issuer or client ID needs a new secret.

deployments identity-provider set --display-name <display-name> --jit <json>
  • Calls PUT /v1/identity-provider (SDK putIdentityProvider).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--protocoloidc | samloidc or saml (default oidc)
--display-namestringyesName shown on the sign-in button
--jitstring (json)yesJust-in-time provisioning, such as {"kind":"enabled","role":"member"}
--issuerstringOIDC issuer URL
--client-idstringOIDC OAuth client ID
--client-secretstringOIDC OAuth client secret (prefer env or file source)
--client-secret-envstringEnvironment variable containing the OIDC OAuth client secret
--client-secret-filestringFile containing the OIDC OAuth client secret
--metadata-urlstringHTTPS URL of the SAML identity provider's metadata
--metadata-filestringFile containing the SAML identity provider's metadata XML
--email-attributestringSAML attribute that carries the email; when set, the NameID is never used
--unsolicited-sign-indisabled | enabledIdP-initiated SAML sign-in (default disabled)

Also accepts the global flags.

deployments identity-provider set-state

Activate, require, or disable sign-in through the identity provider.

deployments identity-provider set-state --kind <kind>
  • Calls PUT /v1/identity-provider/state (SDK setIdentityProviderState).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--kindstringyesactive or disabled
--enforcementstringoptional or required, when active

Also accepts the global flags.

deployments identity-provider delete

Delete the identity provider and its client secret.

deployments identity-provider delete
  • Calls DELETE /v1/identity-provider (SDK deleteIdentityProvider).
  • Needs an organization: --org or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.

Also accepts the global flags.

List identities linked through the identity provider.

deployments identity-provider links
  • Calls GET /v1/identity-provider/links (SDK listIdentityProviderLinks).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

Remove a federated identity link.

deployments identity-provider unlink <id>
  • Calls DELETE /v1/identity-provider/links/{id} (SDK deleteIdentityProviderLink).
  • Needs an organization: --org or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

On this page