Workspaces

Get Microsoft Consent URL

GET/v1/workspaces/microsoft/consent-url
GET
/v1/workspaces/microsoft/consent-url

Microsoft bulk connect requires the customer's Microsoft tenant admin to grant admin consent to the TrulyInbox app — an interactive browser step with no headless equivalent. Call this to get the link, send it to that admin, and once they approve, call POST /v1/workspaces with the tenantId. Pass domain to pin the prompt to that tenant (otherwise the admin consents for whichever Microsoft account they are signed into) and to get its tenantId back here, so you do not have to rely on the admin reading it to you. Google needs no equivalent — domain-wide delegation is granted in the customer's Google Admin Console.

Authorization

X-Api-Key<token>

In: header

Query Parameters

domainstring

The customer's Microsoft domain (or tenant GUID). Pins the consent prompt to that tenant and lets the response include its tenantId. Omit to use the generic prompt, where the admin consents for whichever Microsoft account they are signed into.

Responses

200
200 response
{
  "url": "https://login.microsoftonline.com/customerdomain.com/adminconsent?client_id=...&redirect_uri=...&state=...",
  "tenantId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
}

Request

curl -X GET \
  "https://lupus-edge.trulyinbox.com/v1/workspaces/microsoft/consent-url" \
  -H "X-Api-Key: YOUR_API_KEY"

Response

No response body