Mailboxes / Oauth validate

Test credentials.

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/mailboxes/oauth_validate

Method: POST

Authorisation: Minimum role: ADMIN

Request Arguments
Name Type Source
inputDTO_mailbox_oauth2_validation_inputBody

  Request body example

Response object

Response status: 200 (OK)

Response type: DTO_mailbox_oauth2_validation_response[]

Wrapper: DTO_response_wrap

Other response statuses: 400 (BadRequest), 403 (Forbidden)

  Response body example

DTO_mailbox_oauth2_validation_input
NameTypeReadOnlyDescription
identifierStringIdentifier
emailStringOptional. If the user has multiple mailboxes, this is the mailbox that the user wants to use.
DTO_mailbox_oauth2_validation_response
NameTypeReadOnlyDescription
successBooleanSuccess
emailStringEmail
error_messageStringError message
authorized_accountStringAuthorized account

left_arrow POST Mailboxes / Delete auth

POST Mailboxes / Verify forward right_arrow