Command reference
deployments login-domain
Email domains the organization proves it controls for single sign-on
| Command | Summary |
|---|---|
deployments login-domain list | List login domains |
deployments login-domain add | Add a login domain and print the DNS TXT record that verifies it |
deployments login-domain verify | Verify a login domain once its DNS TXT record is published |
deployments login-domain remove | Remove a login domain |
deployments login-domain list
List login domains.
deployments login-domain list- Calls
GET /v1/login-domains(SDKlistLoginDomains). - 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 login-domain add
Add a login domain and print the DNS TXT record that verifies it.
deployments login-domain add --domain <domain>- Calls
POST /v1/login-domains(SDKaddLoginDomain). - 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 |
|---|---|---|---|---|
--domain | string | yes | Domain, such as example.com |
Also accepts the global flags.
deployments login-domain verify
Verify a login domain once its DNS TXT record is published.
deployments login-domain verify <id>- Calls
POST /v1/login-domains/{id}/verify(SDKverifyLoginDomain). - 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 |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments login-domain remove
Remove a login domain.
deployments login-domain remove <id>- Calls
DELETE /v1/login-domains/{id}(SDKremoveLoginDomain). - 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.