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
List mailbox OAUTH apps
Lists mailbox OAuth apps.
Lists mailbox OAuth apps.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps - Scope
notify:read - Effect
read— nothing is written. - Collection mailbox_oauth_apps
- Query
page_size,page_token,filter,order_by - Pagination the answer carries
mailbox_oauth_appsand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | 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. |
#Response
| Field | Type | What it is |
|---|---|---|
mailbox_oauth_apps | MailboxOauthApp[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#MailboxOauthApp
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/mailbox_oauth_apps/{mailbox_oauth_app}. |
uid | string | moa_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | MailboxOauthAppSpec | Desired state. Required. |
status | MailboxOauthAppStatus | Observed state. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#MailboxOauthAppSpec
| Field | Type | What it is |
|---|---|---|
provider | MailboxOauthProvider | The provider. Required. One of google, microsoft. |
client_id | string | The client id the provider issued. Required. |
client_secret | string | The client secret; write-only, sealed at rest, never returned. Never returned again. |
tenant | string | Microsoft only: who may consent, common (the default: any work, school or personal account), organizations, consumers, or one tenant id. |
#MailboxOauthAppStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
client_secret_set | bool | Whether a client secret is stored. Output only. |
redirect_uri | string | The redirect URI to register on the provider's client. Output only. |
scopes | string[] | The scopes a connect link asks for: Google https://mail.google.com/ (a restricted scope: a public app needs Google's verification), and Microsoft IMAP.AccessAsUser.All, SMTP.Send and offline_access, each with openid email to learn the address. Output only. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps" \
-H "Authorization: Bearer $SYLPHX_API_KEY"