OAuth2 Applications

Verify OAuth2 application setup

Runs the provider authentication chain step by step and reports which steps pass or fail, with hints for fixing failures. For service-account apps an optional mailbox address enables the delegation and live mailbox checks.

post/v1/oauth2/{app}/verify

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/oauth2/{app}/verify
  • Auth: HTTP bearer

Path parameters

appstring required

OAuth2 application ID

Example:AAABhaBPHscAAAAH

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Request body

accountstring

Mailbox address used to verify domain-wide delegation and live mailbox access

testConnectionboolean

Perform the live IMAP/API connection step when an access token is obtained

Example request

{
  "account": "user@example.com"
}

Response

Returns the outcome of the credential check against the provider.

appstring required

OAuth2 application ID

providerstring

Provider type

authMethodstring nullable

Authentication method for service-account apps

accountstring nullable

Mailbox used for the delegation/mailbox checks

okboolean

True when no verification step failed

Example response

{
  "app": "AAABhaBPHscAAAAH",
  "provider": "gmailService",
  "authMethod": "externalAccount",
  "account": "user@example.com",
  "ok": true,
  "steps": [
    {
      "id": "signJwt",
      "label": "Sign assertion (signJwt)",
      "status": "ok",
      "message": "Assertion signed via IAM signJwt",
      "hint": "Grant roles/iam.serviceAccountTokenCreator to the workload principal"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.