/bff/iot-lock/credentials-detail

Returns the TTLock OAuth2 credentials currently configured for the authenticated organisation. Non-secret values (clientId, username) are returned in full so the frontend can display and pre-fill them. Secret values (clientSecret, password) are never returned — instead the response contains boolean flags (clientSecretIsSet, passwordIsSet) indicating whether each secret is configured. The auto-managed access and refresh tokens are never exposed by this endpoint.

IoTgetBffIot-lockCredentials-detail

Parameters

No parameters required

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

Response schema

1 status code documented

200Success

clientIdstringRequired

TTLock OAuth2 client ID (app identifier issued by TTLock). Empty string when not set.

clientSecretIsSetbooleanRequired

True when a non-empty ttlock_client_secret is stored. The value itself is never returned.

usernamestringRequired

TTLock account username / e-mail. Empty string when not set.

passwordIsSetbooleanRequired

True when a non-empty ttlock_password (MD5) is stored. The value itself is never returned.

Response example

application/json

{
  "clientId": "example_clientId",
  "clientSecretIsSet": false,
  "username": "example_username",
  "passwordIsSet": false
}

Request example

GET /bff/iot-lock/credentials-detail

get

curl -X GET "https://api.bizkithub.com/bff/iot-lock/credentials-detail" \
  -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