Broadleaf Microservices
  • v1.0.0-latest-prod

Sandbox Types

PreviewToken

The response object used to provide the details of the preview token as well as the token itself.

Property Type Description

token

string

the token string to be used in API requests

author

string

the author whose changes are being previewed

expirationTime

string

ISO8601 date-time used to indicate when the token expires

sandboxId

string

the current user sandbox ID

tenantId

string

The ID of the tenant this preview token is authorized for.

applicationId

string

The ID of the application this preview token is authorized for.

PreviewTokenValidated

The details provided when a preview token is validated.

Property Type Description

valid

boolean

Whether or not the token provided is valid.

content?

PreviewToken

If valid, this will include the content of the decoded preview token.

If not valid, this will be null.

sandboxes

Array<Sandbox>

If valid, this will include the set of Sandbox available for preview. This sandbox information may be used for display purposes in the client.

If not valid, this will be empty.

reason?

string

If invalid, this will include the reason for why the token was found not to be valid.

Sandbox

Property Type Description

id

string

the id of the sandbox

name

string

the name of the sandbox

color?

string

The color of the sandbox, usually a hex value