Skip to main content
POST
Register email sign-in application

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Body

application/json

Request body of create_email_oauth_app.

provider
enum<string>
required
Available options:
google,
microsoft
name
string
required
Required string length: 1 - 255
auth_kind
enum<string> | null

Default oauth_client.

Available options:
oauth_client,
service_account,
app_only
client_id
string

Required unless service_account_json is given.

Maximum string length: 512
client_secret
string

The client secret; a service account's PEM private key. Required unless service_account_json is given. Stored encrypted, never read back.

Maximum string length: 8192
service_account_email
string<email> | null
Maximum string length: 320
service_account_json
string | null

google service account: the key file; fills auth_kind, client_id, client_secret and service_account_email.

Maximum string length: 16384
microsoft_tenant
string | null

microsoft only: common, organizations, a tenant id or a verified domain.

Maximum string length: 255
callback_host
string | null

A custom domain of the team issued through the platform, which the provider redirects to; null: the platform's connect address.

Maximum string length: 255
google_pubsub_topic
string | null

google only: projects/{project}/topics/{topic} in the application's own project.

Maximum string length: 255
is_default
boolean | null
publishing_status
enum<string> | null
Available options:
unknown,
testing,
unverified,
verified

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required