@qualithm/device - v0.12.2
    Preparing search index...

    Type Alias DeviceCredential

    A device credential persisted across restarts.

    The credential is written to the CredentialStore after a successful claim so that a power cycle reconnects without re-claiming (claim codes are single-use). For the token path only DeviceCredential.token is set; for the certificate path the key/cert/chain fields are set instead.

    type DeviceCredential = {
        broker?: BrokerEndpoint;
        caCertificatePem?: string;
        certificatePem?: string;
        deviceId: string;
        expiresAt?: string;
        issuedAt: string;
        kind: CredentialKind;
        privateKeyPem?: string;
        spaceId: string;
        teamId: string;
        token?: string;
    }
    Index

    Properties

    broker? caCertificatePem? certificatePem? deviceId expiresAt? issuedAt kind privateKeyPem? spaceId teamId token?

    Properties

    broker?: BrokerEndpoint

    The gateway the platform assigned for the device's zone at claim or certificate enrollment. Used when no broker host is configured.

    caCertificatePem?: string

    PEM-encoded issuing CA chain, so the device can assemble its chain.

    certificatePem?: string

    PEM-encoded device certificate for the certificate path.

    deviceId: string

    The device's stable ID, used as the MQTT client id. Treat it as an opaque string.

    expiresAt?: string

    ISO-8601 expiry, when the credential is time-bounded.

    issuedAt: string

    ISO-8601 time the credential was issued/stored.

    kind: CredentialKind

    Which authentication mechanism this credential uses.

    privateKeyPem?: string

    PEM-encoded private key for the certificate path.

    spaceId: string

    The space the device belongs to.

    teamId: string

    The owning team (tenant boundary).

    token?: string

    Bearer secret for the token path; presented as the MQTT password.

    Settings

    Member Visibility

    On This Page

    Properties