agent-registrations · MachineMail Docs

Agent registrations bound to the organization. Also spelled agents.

Command	Summary
`agent-registrations delete`	Revoke agent registration
`agent-registrations get`	Get agent registration
`agent-registrations list`	List agent registrations

Every command also takes the global flags.

agent-registrations delete

Revoke agent registration.

Also: machinemail agent-registrations rm.

Revokes the registration; its tokens stop working immediately. Returns the registration with status: revoked (revoking twice is not an error). Requires an organization-scoped credential with api_key_delete.

shell

machinemail agent-registrations delete <agent-id> [flags]

Arguments

<agent-id>stringRequired

ID of the registration.

Examples

shell

machinemail agent-registrations delete reg_01m4fykg1y0000pkp9n2xbbzhg

API

DELETE /v0/agent-registrations/{agent_id}

agent-registrations get

Get agent registration.

Requires an organization-scoped credential with api_key_read.

shell

machinemail agent-registrations get <agent-id> [flags]

Arguments

<agent-id>stringRequired

ID of the registration.

Examples

shell

machinemail agent-registrations get reg_01m4fykg1y0000pkp9n2xbbzhg

API

GET /v0/agent-registrations/{agent_id}

agent-registrations list

List agent registrations.

Also: machinemail agent-registrations ls.

Agent registrations bound to the organization. Requires an organization-scoped credential with api_key_read; pod, inbox and sandbox credentials get 403.

shell

machinemail agent-registrations list [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.

--statuspending_claim | claimed | revoked

Only registrations with this status.

--allboolean

Follow next_page_token and return every page.

Examples

shell

machinemail agent-registrations list
machinemail agent-registrations list --all --json | jq '.agent_registrations | length'

API

GET /v0/agent-registrations