---
title: "plgd hub clients configuration"
method: GET
path: "/.well-known/configuration"
tags: ["Configuration"]
---

# plgd hub clients configuration

`GET /.well-known/configuration`

Basic publicly available configuration required to connect the device to the plgd hub.

## Response `200`

Configuration

- HubConfiguration
  - `jwtOwnerClaim` string — JWT claim identifying device owner.
  - `jwtDeviceIdClaim` string — JWT claim identifying device id. Empty means that JWT doesn't contain it.
  - `id` string, uuid — Unique ID of the cloud, required for device registration at the plgd hub.
  - `coapGateway` string — URL of the device endpoint - plgd CoAP Gateway where the device connects.
  - `certificateAuthorities` string — Public key of the certificate authority issuing the plgd identity certificates.
  - `defaultCommandTimeToLive` integer — Exposes default command time to live in nanoseconds for CreateResource, RetrieveResource, UpdateResource, DeleteResource, and UpdateDeviceMetadata commands when it is zero value in the request. 0 - means forever.
  - `currentTime` integer — Current time of server in nanoseconds.
  - `authority` string — URL of the authorization server.
  - `httpGatewayAddress` string — address where plgd HTTP Gateway handles API calls.
  - `webOauthClient` WebOAuthClient
    - `clientId` string — Client ID of the web OAuth client.
    - `audience` string — Audience of the web OAuth client.
    - `scopes` string[] — Scopes of the web OAuth client.
  - `deviceOauthClient` DeviceOAuthClient
    - `clientId` string — Client ID of the device OAuth client.
    - `audience` string — Audience of the device OAuth client.
    - `providerName` string — Provider name of the device OAuth client.
    - `scopes` string[] — Scopes of the device OAuth client.
  - `ui` UIConfiguration
    - `visibility` UIVisibility — true - show, false - hide
      - `mainSidebar` UIVisibilityMainSidebar
        - `devices` boolean
        - `configuration` boolean
        - `remoteClients` boolean
        - `pendingCommands` boolean
        - `certificates` boolean
        - `deviceProvisioning` boolean
        - `docs` boolean
        - `chatRoom` boolean
        - `dashboard` boolean
        - `integrations` boolean
        - `deviceFirmwareUpdate` boolean
        - `deviceLogs` boolean
        - `apiTokens` boolean
        - `schemaHub` boolean
    - `deviceProvisioningService` string
  - `buildInfo` BuildInfo
    - `version` string — Version of the hub
    - `buildDate` string, date-time — build date of the hub
    - `commitHash` string — commit hash of the hub
    - `commitDate` string, date-time — commit date of the hub

## Changes

> 42 revisions in range; 3 not diffed.

- **2024-02-29** `24b9261b39f3` — 1 breaking, 14 info
  - the `ui/visibility/mainSidebar` response's property type changed from no type to `object` for status `200`
  - added the optional property `ui/visibility/mainSidebar/apiTokens` to the response with the `200` status
  - added the optional property `ui/visibility/mainSidebar/certificates` to the response with the `200` status
  - added the optional property `ui/visibility/mainSidebar/chatRoom` to the response with the `200` status
  - …11 more
- **2024-01-08** `b72604876b82` — 1 info
  - added the optional property `ui/deviceProvisioningService` to the response with the `200` status
- **2024-01-02** `edcfbfe2029e` — 1 info
  - added the optional property `ui` to the response with the `200` status
- **2023-07-04** `798f4ede6087` — 1 info
  - added the optional property `buildInfo` to the response with the `200` status
- **2022-09-16** `1aff7adddcdf` — 1 warning, 4 info
  - removed the optional property `authorizationServer` from the response with the `200` status
  - added the optional property `authority` to the response with the `200` status
  - added the optional property `deviceOauthClient` to the response with the `200` status
  - added the optional property `httpGatewayAddress` to the response with the `200` status
  - …1 more

[Full history](https://skmtc.dev/plgd-dev/apis/plgd-http-gateway/changes/.well-known/configuration/get.md)

---

[API](https://skmtc.dev/plgd-dev/apis/plgd-http-gateway.md) · [All operations](https://skmtc.dev/plgd-dev/apis/plgd-http-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/plgd-dev/apis/plgd-http-gateway/revisions/bbfd9fa43407?raw)