/bff/terminal/session

Initialize terminal session

TerminalpostBffTerminalSession

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success

userobjectRequired

Authenticated user info

idstringRequired

User ID

namestringRequired

Display name of the user

rolestringRequired

User role in the organisation

Examplemember

tenantobjectRequired

Current organisation context

idstringRequired

Organisation ID

namestringRequired

Organisation name

cwdstringRequired

Initial working directory

Example/drive

motdstringRequired

Message of the day shown on session start

Response example

application/json

{
  "user": {
    "id": "example_id",
    "name": "example_name",
    "role": "member"
  },
  "tenant": {
    "id": "example_id",
    "name": "example_name"
  },
  "cwd": "/drive",
  "motd": "example_motd"
}

Request example

POST /bff/terminal/session

post

curl -X POST "https://api.bizkithub.com/bff/terminal/session" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key