Command reference
deployments identity-provider
The organization's OIDC or SAML identity provider for single sign-on
| Command | Summary |
|---|---|
deployments identity-provider show | Show the identity provider and the values to register with it |
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-state | Activate, require, or disable sign-in through the identity provider |
deployments identity-provider delete | Delete the identity provider and its client secret |
deployments identity-provider links | List identities linked through the identity provider |
deployments identity-provider unlink | Remove a federated identity link |
deployments identity-provider show
Show the identity provider and the values to register with it.
deployments identity-provider show- Calls
GET /v1/identity-provider(SDKgetIdentityProvider). - Needs an organization:
--orgor the saved context.
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(SDKputIdentityProvider). - Needs an organization:
--orgor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--protocol | oidc | saml | oidc or saml (default oidc) | ||
--display-name | string | yes | Name shown on the sign-in button | |
--jit | string (json) | yes | Just-in-time provisioning, such as {"kind":"enabled","role":"member"} | |
--issuer | string | OIDC issuer URL | ||
--client-id | string | OIDC OAuth client ID | ||
--client-secret | string | OIDC OAuth client secret (prefer env or file source) | ||
--client-secret-env | string | Environment variable containing the OIDC OAuth client secret | ||
--client-secret-file | string | File containing the OIDC OAuth client secret | ||
--metadata-url | string | HTTPS URL of the SAML identity provider's metadata | ||
--metadata-file | string | File containing the SAML identity provider's metadata XML | ||
--email-attribute | string | SAML attribute that carries the email; when set, the NameID is never used | ||
--unsolicited-sign-in | disabled | enabled | IdP-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(SDKsetIdentityProviderState). - Needs an organization:
--orgor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--kind | string | yes | active or disabled | |
--enforcement | string | optional 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(SDKdeleteIdentityProvider). - Needs an organization:
--orgor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
Also accepts the global flags.
deployments identity-provider links
List identities linked through the identity provider.
deployments identity-provider links- Calls
GET /v1/identity-provider/links(SDKlistIdentityProviderLinks). - Needs an organization:
--orgor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size |
Also accepts the global flags.
deployments identity-provider unlink
Remove a federated identity link.
deployments identity-provider unlink <id>- Calls
DELETE /v1/identity-provider/links/{id}(SDKdeleteIdentityProviderLink). - Needs an organization:
--orgor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.