v1

latestOpenAPI 3.0.12026-07-17265663.1 KB

Configuration

plgd hub clients configuration

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

get/.well-known/configuration

Response

Configuration

jwtOwnerClaimstring

JWT claim identifying device owner.

jwtDeviceIdClaimstring

JWT claim identifying device id. Empty means that JWT doesn't contain it.

idstring uuid

Unique ID of the cloud, required for device registration at the plgd hub.

coapGatewaystring

URL of the device endpoint - plgd CoAP Gateway where the device connects.

certificateAuthoritiesstring

Public key of the certificate authority issuing the plgd identity certificates.

defaultCommandTimeToLiveinteger

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.

currentTimeinteger

Current time of server in nanoseconds.

authoritystring

URL of the authorization server.

httpGatewayAddressstring

address where plgd HTTP Gateway handles API calls.

Example response

{
  "jwtOwnerClaim": "sub",
  "authority": "https://auth.plgd.cloud/realms/shared",
  "id": "adebc667-1f2b-41e3-bf5c-6d6eabc68cc6",
  "coapGateway": "coaps+tcp://try.plgd.cloud:5684",
  "cloudAuthorizationProvider": "plgd",
  "currentTime": 1629728394151716600,
  "defaultCommandTimeToLive": 0,
  "certificateAuthorities": "-----BEGIN CERTIFICATE-----\nMIIBRTCB66ADAgECAhAYrP/8939ZQulrospE3RuHMAoGCCqGSM49BAMCMBIxEDAO\nBgNVBAMTB1Jvb3QgQ0EwHhcNMjAwODE3MDcyMzM3WhcNMjEwODE3MDcyMzM3WjAS\nMRAwDgYDVQQDEwdSb290IENBMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEad6z\nXxjrEezHI8IvNH8RZkc10CM2CdaeU0S+azvpEqV+LMIh0CFLHw9WLEUaTV8JBmXU\nm2Ien4YsLfHbAC4Q/6MjMCEwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMB\nAf8wCgYIKoZIzj0EAwIDSQAwRgIhAIyyCjzD8YzCNSY6YbnLgJ7TaXz5HPE0Eyqm\ngfQCLUhwAiEAmfMN+GW05NyB3n5OxYHqVmHGDZJ8rHUUBCPJ3WbCweM=\n-----END CERTIFICATE-----\n",
  "deviceOauthClient": {
    "audience": "https://try.plgd.cloud",
    "clientId": "cYN3p6lwNcNlOvvUhz55KvDZLQbJeDr5",
    "providerName": "plgd.web",
    "scopes": [
      "offline_access"
    ]
  },
  "httpGatewayAddress": "https://api.try.plgd.cloud",
  "webOauthClient": {
    "audience": "https://try.plgd.cloud",
    "clientId": "LXZ9OhKWWRYqf12W0B5OXduqt02q0zjS",
    "scopes": [
      "openid"
    ]
  },
  "buildInfo": {
    "version": "2.7.19",
    "commitHash": "abfe0011",
    "commitDate": "2023-07-04T15:30:33Z",
    "buildDate": "2023-07-04T15:31:17Z"
  },
  "ui": {
    "visibility": {
      "mainSidebar": {
        "certificates": true,
        "chatRoom": true,
        "configuration": true,
        "deviceProvisioning": true,
        "devices": true,
        "docs": true,
        "pendingCommands": true,
        "remoteClients": true
      }
    }
  }
}