← API reference
CANONICAL TYPE REFERENCE

CreateDeviceTokenPayload

Result of creating a device token

The created token record

tokenString

Deprecated: The broker is mTLS-only, so this is never read: a client that presents no certificate fails the TLS handshake, and one that does is authenticated from its certificate without the bearer path running. Use clientCertPem / clientKeyPem with serverCaCertPem instead. removal:2027-03-18

The signed token value, historically the MQTT password (only returned on creation)

mqttUrlString

MQTT broker URL for device connection (only returned on creation)

Deprecated: Unread on the mTLS path, which is the only one the broker accepts — the connecting identity comes from the certificate's URI SAN. The device ID itself is on deviceToken.deviceId. removal:2027-03-18

The device ID, historically the MQTT username (only returned on creation)

MQTT client ID for this device token. Use this exact token ID (dtk_…): metrics and device MQTT workflow triggers use it to identify this device, and messages with an invalid, unknown, revoked or expired token ID are dropped. Authentication uses the client certificate.

Device client cert (PEM) signed by the tenant CA. Only returned on creation; not persisted.

Device private key (PKCS#8 PEM). Cloud-generated; only returned on creation; not persisted.

Platform server CA cert (PEM). Trust root for verifying broker / edge listener certs.

Tenant CA cert (PEM) that signed the device's leaf.

Validation errors if the operation failed

View exact SDL
"""Result of creating a device token"""
type CreateDeviceTokenPayload {
  """The created token record"""
  deviceToken: DeviceTokenState
  """
  The signed token value, historically the MQTT password (only returned on creation)
  """
  token: String @deprecated(reason: "The broker is mTLS-only, so this is never read: a client that presents no certificate fails the TLS handshake, and one that does is authenticated from its certificate without the bearer path running. Use clientCertPem / clientKeyPem with serverCaCertPem instead. removal:2027-03-18")
  """MQTT broker URL for device connection (only returned on creation)"""
  mqttUrl: String
  """
  The device ID, historically the MQTT username (only returned on creation)
  """
  mqttUsername: String @deprecated(reason: "Unread on the mTLS path, which is the only one the broker accepts — the connecting identity comes from the certificate's URI SAN. The device ID itself is on deviceToken.deviceId. removal:2027-03-18")
  """
  MQTT client ID for this device token. Use this exact token ID (dtk_…): metrics and device MQTT workflow triggers use it to identify this device, and messages with an invalid, unknown, revoked or expired token ID are dropped. Authentication uses the client certificate.
  """
  mqttClientId: String
  """
  Device client cert (PEM) signed by the tenant CA. Only returned on creation; not persisted.
  """
  clientCertPem: String
  """
  Device private key (PKCS#8 PEM). Cloud-generated; only returned on creation; not persisted.
  """
  clientKeyPem: String
  """
  Platform server CA cert (PEM). Trust root for verifying broker / edge listener certs.
  """
  serverCaCertPem: String
  """Tenant CA cert (PEM) that signed the device's leaf."""
  tenantCaCertPem: String
  """Validation errors if the operation failed"""
  errors: [FieldError!]!
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.