Documentation

Mistake on this page? Email us

PreSharedKey

Hierarchy

Index

Constructors

constructor

Properties

createdAt

createdAt: Date

Creation time. The date-time (RFC3339) when this PSK was uploaded to Device Management.

example

2017-07-21T17:32:28.012Z

endpointName

endpointName: string

The unique device Note: It has to be 16-64 printable (non-control) ASCII characters. It also must be globally unique. Consider using vendor-MAC-ID-device-model. For example: "myEndpoint.host.com" The unique endpoint identifier that this PSK applies to. 16-64 printable (non-control) ASCII characters.

example

my-endpoint-0001

endpoint_name

endpoint_name: string

The unique endpoint identifier that this pre-shared key applies to. 16-64 printable (non-control) ASCII characters.

id

id: string

The unique identifier of the entity

secretHex

secretHex: string

The secret Pre-Shared Key Note: It is not case sensitive; 4a is same as 4A, and it is allowed with or without 0x in the beginning. The minimum length of the secret is 128 bits and maximum 256 bits. For example: "4a4a4a4a4a4a4a4a4a4a4a4a4a4a4a4a"

secret_hex

secret_hex: string

The secret of the pre-shared key in hexadecimal. It is not case sensitive; 4a is same as 4A, and it is allowed with or without 0x in the beginning. The minimum length of the secret is 128 bits and maximum 256 bits.

Methods

delete

  • delete(): Promise<void>
  • Delete this PSK.

    Returns Promise<void>

    Promise containing any error

  • Delete this PSK.

    Parameters

    • callback: CallbackFn<void>

      A function that is passed any error

    Returns void