org · MachineMail Docs

The authenticated organization. Also spelled organization.

Command	Summary
`org get`	Get organization
`org members`	List members
`org update`	Update organization

Every command also takes the global flags.

org get

Get organization.

The organization of the credential, with inbox and domain counts and usage. inbox_count and usage count what the credential can see (a pod key: its pod).

shell

machinemail org get [flags]

Examples

shell

machinemail org get

API

GET /v0/organizations

org members

List members.

The people who sign in to the dashboard for this organization, with their role in it, oldest first. Organization-scoped credentials only: pod and inbox credentials get 403.

shell

machinemail org members [flags]

Flags

--limit <n>integer

Maximum number of items to return. Default 50, maximum 500; larger values are capped.

Default50

--page-token <value>string

next_page_token from the previous page.

--ascendingboolean

Sort oldest first.

--allboolean

Follow next_page_token and return every page.

Examples

shell

machinemail org members
machinemail org members --all --json | jq '.members | length'

API

GET /v0/organizations/members

org update

Update organization.

Rename the organization. Organization-scoped credentials only: pod and inbox credentials get 403.

shell

machinemail org update [flags]

Flags

--name <value>string

New name. Must not be blank.

-d, --data <json|@file|->string

Request body as JSON, @file or - for stdin; field flags override its keys.

Examples

shell

machinemail org update
machinemail org update --data @body.json

API

PATCH /v0/organizations