Apache OFBiz · Schema

TokenResponse

Standard API response containing JWT token data.

ERPCRME-CommerceBusiness ApplicationsApacheJavaOpen SourceSupply Chain

Properties

Name Type Description
statusCode integer HTTP status code.
statusDescription string Human-readable status description.
successMessage string Success message from the server.
data object JWT token data returned after successful authentication.
View JSON Schema on GitHub

JSON Schema

apache-ofbiz-token-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-ofbiz/refs/heads/main/json-schema/apache-ofbiz-token-response-schema.json",
  "title": "TokenResponse",
  "description": "Standard API response containing JWT token data.",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP status code.",
      "example": 200
    },
    "statusDescription": {
      "type": "string",
      "description": "Human-readable status description.",
      "example": "OK"
    },
    "successMessage": {
      "type": "string",
      "description": "Success message from the server.",
      "example": "Token granted."
    },
    "data": {
      "type": "object",
      "description": "JWT token data returned after successful authentication.",
      "properties": {
        "access_token": {
          "type": "string",
          "description": "JWT access token for Bearer authentication.",
          "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.example"
        },
        "token_type": {
          "type": "string",
          "description": "Token type, always Bearer.",
          "example": "Bearer"
        },
        "expires_in": {
          "type": "string",
          "description": "Token expiry duration in seconds.",
          "example": "1800"
        },
        "refresh_token": {
          "type": "string",
          "description": "Refresh token for obtaining new access tokens.",
          "example": "dGhpc19pc19hX3JlZnJlc2hfdG9rZW4"
        }
      }
    }
  }
}