Sign in
Tenants

Get Portal Redirect URL

Returns a redirect URL containing a JWT to authenticate the user with the portal. Requires Admin API Key.

get/tenants/{tenant_id}/portal

Query parameters

theme'light' | 'dark'

Optional theme preference for the portal.

Response

Portal redirect URL.

redirect_urlstring url

Redirect URL containing a JWT to authenticate the user with the portal.

tenant_idstring

The ID of the tenant associated with this portal session.

Example response

{
  "redirect_url": "https://webhooks.acme.com/?token=JWT_TOKEN&tenant_id=tenant_123",
  "tenant_id": "tenant_123"
}

Changes

Changed in 3 of the 50 revisions of this API.5

  • c36d2dacd2013See the full diff
    • ○

      added the media type application/json for the response with the status 404

      response-media-type-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • 42cbfe5197541See the full diff
    • ○

      the endpoint scheme security AdminApiKey was added to the API

      api-security-added

  • 07bb5388b4761See the full diff
    • ○

      endpoint added

      endpoint-added