Get session ID

Create new session using a valid API key, which will return a JWT token in the response.

This allows API users to create a timed session from the backend, before passing the resultant JWT token to an unauthenticated frontend application. This prevents any risks of the API key being exposed to the frontend application.

See also the PUT /v2/auth/session endpoint.

GET /v2/auth/session

Get session ID

cURL

curl --request GET \
  --url https://rest.forestreet.com/v2/auth/session \
  --header 'x-api-key: <api-key>'

200

{
  "message": "<string>",
  "accessToken": "<string>",
  "refreshToken": "<string>",
  "expiresIn": 123,
  "expiresAt": 123
}

Authorizations

apiKeyAuthbearerAuthsessionIdQuery

x-api-key · string · header · required

Pass a static API key for every request, provided by your customer support.

Headers

x-api-key · string · required

API key for authentication.

Minimum string length: 1

Response

200

application/json

Session created successfully

message · string · required

Message from the server.

accessToken · string · required

Access token for the user.

Pattern: ^[A-Za-z0-9-_]+(?:\.[A-Za-z0-9-_]+)+$

refreshToken · string · required

Refresh token for the user.

Pattern: ^[A-Za-z0-9-_]+(?:\.[A-Za-z0-9-_]+)+$

expiresIn · number · required

Expires duration for the access token.

expiresAt · number · required

Expires timestamp for the access token.