Command reference
deployments directory
SCIM directory sync, which provisions organization members from an identity provider
| Command | Summary |
|---|---|
deployments directory show | Show directory sync, its tokens, and the SCIM base URL to give the identity provider |
deployments directory set | Turn on directory sync or change the role it grants provisioned members |
deployments directory token create | Create a SCIM bearer token; it is shown only in this response, so pass --reveal |
deployments directory token revoke | Revoke a SCIM bearer token |
deployments directory show
Show directory sync, its tokens, and the SCIM base URL to give the identity provider.
deployments directory show- Calls
GET /v1/directory(SDKgetDirectory). - Needs an organization:
--orgor the saved context.
Also accepts the global flags.
deployments directory set
Turn on directory sync or change the role it grants provisioned members.
deployments directory set --default-role <default-role>- Calls
PUT /v1/directory(SDKputDirectory). - 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 |
|---|---|---|---|---|
--default-role | string | yes | Role for provisioned members: member or viewer |
Also accepts the global flags.
deployments directory token create
Create a SCIM bearer token; it is shown only in this response, so pass --reveal.
deployments directory token create- Calls
POST /v1/directory/tokens(SDKcreateDirectoryToken). - Needs an organization:
--orgor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely. - Output contains secrets. They are redacted unless you pass
--reveal.
Also accepts the global flags.
deployments directory token revoke
Revoke a SCIM bearer token.
deployments directory token revoke <id>- Calls
DELETE /v1/directory/tokens/{id}(SDKrevokeDirectoryToken). - 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.