Command reference
deployments app-grant
Member roles on an app beyond its organization-wide access
| Command | Summary |
|---|---|
deployments app-grant list | List an app's member grants |
deployments app-grant set | Grant an organization member viewer or editor on an app |
deployments app-grant remove | Remove a member's grant on an app |
deployments app-grant list
List an app's member grants.
deployments app-grant list <app-id>- Calls
GET /v1/apps/{appId}/grants(SDKlistAppGrants). - Needs an environment:
--envor 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 | ||
<appId> | positional | yes | App ID |
Also accepts the global flags.
deployments app-grant set
Grant an organization member viewer or editor on an app.
deployments app-grant set <app-id> <principal-id> --role <role>- Calls
PUT /v1/apps/{appId}/grants/{principalId}(SDKputAppGrant). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<appId> | positional | yes | App ID | |
<principalId> | positional | yes | Member principal ID | |
--role | string | yes | viewer or editor |
Also accepts the global flags.
deployments app-grant remove
Remove a member's grant on an app.
deployments app-grant remove <app-id> <principal-id>- Calls
DELETE /v1/apps/{appId}/grants/{principalId}(SDKremoveAppGrant). - Needs an environment:
--envor 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 |
|---|---|---|---|---|
<appId> | positional | yes | App ID | |
<principalId> | positional | yes | Member principal ID |
Also accepts the global flags.