Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx notify mailbox_oauth_apps
Every sylphx notify mailbox_oauth_apps command: its argument, its flags and a run line.
The mailbox_oauth_apps commands of Sylphx Notify, as the CLI spells them: the same
calls as the mailbox_oauth_apps API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a mailbox OAuth app.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify mailbox-oauth-apps get orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-appGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app · scope notify:read · effect read · Request, response and examples
#list
Lists mailbox OAuth apps.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx notify mailbox-oauth-apps list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps · scope notify:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | AIP-160 filter over labels and filterable fields. |
--order-by | string | AIP-132 ordering over filterable fields. |
#create
Creates a mailbox OAuth app.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx notify mailbox-oauth-apps create --parent orgs/acme/projects/shop/envs/production --spec.provider google --spec.client-id …POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps · scope notify:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.provider | enum | The provider. Required. One of google, microsoft. |
--spec.client-id | string | The client id the provider issued. Required. |
--spec.client-secret | string | The client secret; write-only, sealed at rest, never returned. The value is never returned. |
--spec.tenant | string | Microsoft only: who may consent, common (the default: any work, school or personal account), organizations, consumers, or one tenant id. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Updates a mailbox OAuth app.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify mailbox-oauth-apps update orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app --spec.client-id …PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app · scope notify:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.client-id | string | The client id the provider issued. Required. |
--spec.client-secret | string | The client secret; write-only, sealed at rest, never returned. The value is never returned. |
--spec.tenant | string | Microsoft only: who may consent, common (the default: any work, school or personal account), organizations, consumers, or one tenant id. |
--allow-missing | bool | Create the mailbox OAuth app when it does not exist (declarative upsert). |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes a mailbox OAuth app; refused while a mailbox uses it.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify mailbox-oauth-apps delete orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app · scope notify:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--allow-missing | bool | Succeed when the mailbox OAuth app does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--yes | bool | Do not ask before this destructive call. |