Command reference
deployments member
Organization members and roles
| Command | Summary |
|---|---|
deployments member list | List organization members |
deployments member add | Add an organization member |
deployments member update | Update a member role |
deployments member remove | Remove an organization member |
deployments member list
List organization members.
deployments member list- Calls
GET /v1/members(SDKlistOrganizationMembers). - 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 member add
Add an organization member.
deployments member add --principal-id <principal-id> --role <role>- Calls
POST /v1/members(SDKaddOrganizationMember). - 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 |
|---|---|---|---|---|
--principal-id | string | yes | Human principal ID | |
--role | string | yes | Organization role |
Also accepts the global flags.
deployments member update
Update a member role.
deployments member update <id> --role <role>- Calls
PATCH /v1/members/{id}(SDKupdateOrganizationMember). - 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 | |
--role | string | yes | Organization role |
Also accepts the global flags.
deployments member remove
Remove an organization member.
deployments member remove <id>- Calls
DELETE /v1/members/{id}(SDKremoveOrganizationMember). - 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 | |
--reason | string | Reason for this operation |
Also accepts the global flags.