Skip to the documentation
CLI

openemail security

Every command in this namespace, with its arguments, flags and examples.

Commands

Verification codes for apps connected with OAuth: check whether sensitive changes are unlocked, ask for a code and verify it. API keys are never asked for one. It also reads the security log of the workspace: who invited, added or removed people, changed roles or changed how the workspace is protected.

Every command here also takes the global flags, such as --json, --profile and --dry-run. See the global flags

openemail security list-events

Read the workspace security log

Scopesmembers:readNeeds a sign-in

Usage

openemail security list-events [flags]

Resolves one page of the changes people made to who can reach the workspace, newest first: invitations sent and withdrawn, members added and removed, roles created, changed and deleted, the two-factor requirement, passwords set for an address and directory sync. Each one names who did it in actor. Nothing is ever removed from it.

Add --all to walk every page: a table on a terminal, one JSON object per line when piped or with --ndjson, and one { items, hasMore, nextCursor } document with --json. --max <n> stops after that many items.

Flags

--limit <n>

Page size, from 1 to 100. The server defaults to 25.

Default25
--cursor <value>

The nextCursor of the previous page. Leave it out for the first page.

--all

Fetch every page and stream the items as they arrive.

--max <n>

Stop after this many items. Implies --all.

--ndjson

Print every item as one JSON object per line. Implies --all

Examples

openemail security list-events
With optional flags
openemail security list-events --limit 50
Walk every page and stop after 100 items
openemail security list-events --all --max 100
One JSON object per line when piped
openemail security list-events --all > security.ndjson

Also available in

API
GET /security/events
TypeScript
security.listEvents()
Python
security.list_events()
Ruby
security.list_events
PHP
security->listEvents
Go
Security.ListEvents
Java
security().listEvents
C#
Security.ListEventsAsync