authentication

POST

https://Example-Server.com/be/v1/auth

Last modified:2025-03-31 07:46:34

This endpoint allows users with a valid backend user session token (POST /be/v1/login) to obtain a backend authentication token.
The returned token has a lifetime of 5m.

Request

Header Params

x-rockit-besession-token

string

required

ROCKIT Edge session token (POST /be/v1/login)

Example:

Content-Type

string

required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://Example-Server.com/be/v1/auth' \
--header 'x-rockit-besession-token: eyFHsHDfjdsdH...' \
--header 'Content-Type: application/json'

Responses

🟢200Success

application/json

Body

status

string

required

Indicates that the authentication request was successful.

auth

object

required

Contains the backend authentication token details:

token

string

required

The authentication token used for accessing protected backend endpoints.

expires

integer

required

A UNIX timestamp (integer) indicating when the token expires (the token has a short lifetime of 5 minutes).

Example

{
  "status": "success",
  "auth": {
    "token": "eyJhbGc...",
    "expires": 1727679037
  }
}

🟠400missing-param

🟠401token-expired

user login

Account Management