agent-registrations · MachineMail Docs

agent-registrations delete

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

Field Description
<agent-id> string Required. ID of the registration.

Examples

shell

machinemail agent-registrations delete reg_01m4fykg1y0000pkp9n2xbbzhg

API

agent-registrations get

Get agent registration.

Requires an organization-scoped credential with api_key_read.

shell

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

Arguments

Field Description
<agent-id> string Required. ID of the registration.

Examples

shell

machinemail agent-registrations get reg_01m4fykg1y0000pkp9n2xbbzhg

API

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

Field Description
--limit <n> integer Maximum number of items to return. Default 50, maximum 500; larger values are capped.
--page-token <value> string next_page_token from the previous page.
--ascending boolean Sort oldest first.
--status `pending_claim
--all boolean 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