Consumers

Create portal session

Opens the customer portal for this consumer. The response carries the token once; only its hash is stored.

post/api/v1/projects/{projectId}/consumers/{consumerId}/portal-sessions

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/projects/{projectId}/consumers/{consumerId}/portal-sessions
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

projectIdstring uuid required
consumerIdstring uuid required

Request body

ttlMinutesinteger

How long the session lasts, in minutes. Defaults to 60.

allowedOriginstring

The origin of the page that embeds the portal, e.g. https://app.example.com. When set, the portal refuses to render inside any other page.

Example request

{
  "allowedOrigin": "https://app.example.com"
}

Response

Session created

Changes

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