coap.psk.list

The coap.psk.list command is used to list details of pre-shared keys.

TR50 Request

{
  "1": {
    "command": "coap.psk.list",
    "params": {
      "offset": 0,
      "limit": 10
    }
  }
}

Request Parameters

Name	Type	Required	Description
offset	Integer		The starting list offset, used for pagination. Defaults to 0 if not specified.
limit	Integer		Limits the number of results returned. Defaults to the maximum configured size.

TR50 Response

If the command is sent successfully a success message and the list of pre-shared keys is returned. Otherwise, an error and error message will be returned.

{
  "1": {
    "success": true,
    "params": {
      "count": 2,
      "result": [
        {
          "id": "59a06544b5143858b3af5941",
          "name": "My New PSK",
          "desc": "My New PSK",
          "identity": "PSK1",
          "psk": "858b3af594159a06544b5143",
          "createdBy": "user@example.com",
          "createdOn": "2021-01-01T01:23:45.678Z",
          "updatedBy": "user@example.com",
          "updatedOn": "2021-01-01T01:23:45.678Z"
        },
        ...
      ]
    }
  }
}

Response Parameters

Name	Type	Description
count	Integer	The total number of pre-shared keys.
result	Array	The array of pre-shared key records.

Result Object

Name	Type	Description
id	String	The id of the pre-shared key.
orgId	String	The orgId that the pre-shared key belongs to.
name	String	The name of the pre-shared key.
desc	String	The description of the pre-shared key.
identity	String	The identity of the pre-shared key.
createdBy	String	The email address of the user who created the pre-shared key.
createdOn	String	The date and time that the pre-shared key got created.
updatedBy	String	The email address of the user who last updated the pre-shared key.
updatedOn	String	The date and time that the pre-shared key got updated.