Create a session token

post/sessions

Creates a session token that is required to integrate components.

The response contains encrypted session data. The front end then uses the session data to make the required server-side calls for the component.

To create a token, you must meet specific requirements. These requirements vary depending on the type of component. For more information, see the documentation for Onboarding and Platform Experience components.

Endpoint destination URL
Click to copy

Request Parameters

allowOriginstringRequired

The URL where the component will appear. In your live environment, you must protect the URL with an SSL certificate and ensure that it starts with https://.

policyobjectRequired

An object that contains a description of the allowed resources and roles for the requested session.

productstringRequired

The type of component.

For Onboarding components, set this to onboarding.

For Platform Experience components, set this to platform.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200

    Successful operation

    Show moreShow less
  • 400

    Bad request

    Show moreShow less
  • 401

    Unauthorized

    Show moreShow less
  • 403

    Forbidden

    Show moreShow less