Skip to main content
POST
Start OAuth connect

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

provider
enum<string>
required
Available options:
google,
microsoft

Response

authorizationUrl
string
required

Open this consent URL in a browser so the mailbox owner can grant access.

Example:

"https://accounts.google.com/o/oauth2/v2/auth?client_id=…&state=…"

state
string
required

Opaque handle. Pass it to the status endpoint to poll the result.

Example:

"aB3dEf6hIjKlMnOpQrStUvWxYz0123456789_-AbCdE"

expiresInSeconds
number
required

How long the consent link / state stays valid.

Example:

600