Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Fields

expirationTime

string (Timestamp format)

[Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

publicKey

object(PublicKeyCredential)

A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or modifications, this public key credential may be required to be signed by one of the registry-level certificates. More specifically, if the registry contains at least one certificate, one of them must sign any new device credential must be signed by one of them. As a result, only X.509 certificates are accepted as device credentials when the registry contains certificates. However, self-signed certificates and public keys will be accepted if the registry does not contain a certificate. New device credentials must be different from every registry-level certificate.

...

The Status type defines a logical error model suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be:

...

Enums

GATEWAY_AUTH_METHOD_UNSPECIFIED

No authentication/authorization method specified. No devices are allowed to access the gateway.

ASSOCIATION_ONLY

The device is authenticated through the gateway association only, and device credentials are ignored even if provided.

DEVICE_AUTH_TOKEN_ONLY

The device is authenticated through its credentials, and the gateway association is not checked.

ASSOCIATION_AND_DEVICE_AUTH_TOKEN

The device is authenticated through device credentials and gateway association. The device must be bound to the gateway and provide its credentials.

Methods

create

Creates a device in a device registry.

delete

Deletes a device.

get

Gets details about a device.

list

List devices in a device registry.

modifyCloudToDeviceConfig

Modifies the configuration for the device, which is eventually sent from the ClearBlade IoT Core servers.

patch

Updates a device.

sendCommandToDevice

Sends a command to the specified device.