Deployments.ai Docs
Command reference

deployments member

Organization members and roles

CommandSummary
deployments member listList organization members
deployments member addAdd an organization member
deployments member updateUpdate a member role
deployments member removeRemove an organization member

deployments member list

List organization members.

deployments member list
  • Calls GET /v1/members (SDK listOrganizationMembers).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (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 (SDK addOrganizationMember).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--principal-idstringyesHuman principal ID
--rolestringyesOrganization role

Also accepts the global flags.

deployments member update

Update a member role.

deployments member update <id> --role <role>
  • Calls PATCH /v1/members/{id} (SDK updateOrganizationMember).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--rolestringyesOrganization role

Also accepts the global flags.

deployments member remove

Remove an organization member.

deployments member remove <id>
  • Calls DELETE /v1/members/{id} (SDK removeOrganizationMember).
  • Needs an organization: --org or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--reasonstringReason for this operation

Also accepts the global flags.

On this page