Docs
Workspaces

Get Microsoft consent URL

Get the Microsoft admin-consent URL

Microsoft-only first step. A tenant administrator opens this URL in a browser; the redirect returns a tenantId and state to POST back to this collection. Google tenants skip this step and POST an adminEmail directly. Pass domain (the customer's Microsoft domain or tenant GUID) to pin the prompt to that tenant and get its tenantId back here, so you do not have to rely on the admin reading it to you; an unresolvable domain returns 422 rather than silently falling back to the generic prompt.

GET
/v2/workspaces/{workspaceId}/provider-workspaces/microsoft/consent-url

Path Parameters

workspaceIdnumber

Query Parameters

domain?string

The customer's Microsoft domain (or tenant GUID). Pins the consent prompt to that tenant and resolves its tenantId into the response. Omit for the generic prompt, where the admin consents for whichever Microsoft account they are signed into. An unresolvable domain is rejected rather than falling back to the generic prompt.

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/provider-workspaces/microsoft/consent-url?domain=customerdomain.com"
{
  "data": {
    "url": "https://login.microsoftonline.com/customerdomain.com/adminconsent?...",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}