Zum Hauptinhalt springen
POST
/
customers
/
{id}
/
authenticate
cURL
curl -X POST \
 /customers/{id}/authenticate \
 --header "Authorization: Bearer <token>"
{
  "data": {
    "accessToken": "<string>",
    "refreshToken": "<string>",
    "customerAreaLink": "<string>"
  }
}
Generates authentication tokens and a pre-authenticated link to the customer portal.

​
Use Cases

  • Customer Portal Access: Generate a link that allows customers to access their portal without entering credentials
  • API on Behalf of Customer: Use the access token to make API calls on behalf of the customer
  • Email Integration: Include the customer area link in emails to provide seamless access

​
Response

The endpoint returns:
FieldDescription
accessTokenJWT access token for API authentication on behalf of the customer
refreshTokenJWT refresh token to obtain new access tokens
customerAreaLinkPre-authenticated short link to the customer portal

​
Example Response

{
    "data": {
        "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
        "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
        "customerAreaLink": "https://example.customerfront.app/customer-area/login?token=abc123"
    }
}
The customerAreaLink contains a short-lived token. Generate a new link if the customer needs to access the portal at a later time.
Use the accessToken to make API calls on behalf of the customer, for example to retrieve their entitlements or subscriptions.

Autorisierungen

​
Authorization
string
header
erforderlich

Value for the Authorization header parameter.

Pfadparameter

​
id
string
erforderlich

Customer identifier

Antwort

Returns authentication tokens and a customer area link for the customer

​
data
object