Matter Cluster 1294 — Account Login Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1294 values in the device shadow use this format:

endpoint_id / 1294 / attribute_id

Cluster 1294 Attributes

Cluster 1294 defines no cluster-specific attributes; only the global attributes are present.

Global attributes

Cluster 1294 Commands

Cluster 1294 has 3 client-to-server commands and 1 response.

AcceptedCommandList

The AcceptedCommandList attribute lists the command IDs the endpoint actually implements:

endpoint_id / 1294 / 65529

{
  "1/1294/65529": [
    0,
    2,
    3
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1294,
    "command_name": "GetSetupPIN",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

For Cluster 1294, always use "cluster_id": 1294. Payload keys are the command field names in lowerCamelCase. Octet-string fields are base64-encoded. timed_request_timeout_ms is required for timed commands and ignored otherwise.

Command: GetSetupPIN

Purpose

GetSetupPIN is a client-to-server command of the Account Login cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1294,
    "command_name": "GetSetupPIN",
    "payload": {
      "tempAccountIdentifier": "example"
    },
    "timed_request_timeout_ms": 1000
  }
}

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

The device answers with GetSetupPINResponse (see below).

Command: GetSetupPINResponse

Purpose

GetSetupPINResponse is a server response of the Account Login cluster.

Command Identity

Response Fields

Command: Login

Purpose

The purpose of this command is to allow the Content App to assume the user account of a given Commissionee by leveraging the Setup PIN input by the user during the commissioning process. For example, a Video Player with a Content App Platform may invoke this command on one of its Content App endpoints after the commissioning has completed of a Phone App made by the same vendor as the Content App. The Content App may determine whether the Temporary Account Identifier maps to an account with a corresponding Setup PIN and, if so, it may automatically login to the account for the corresponding user.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1294,
    "command_name": "Login",
    "payload": {
      "tempAccountIdentifier": "example",
      "setupPIN": "example"
    },
    "timed_request_timeout_ms": 1000
  }
}

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

Command: Logout

Purpose

The purpose of this command is to instruct the Content App to clear the current user account. This command should be used by clients of a Content App to indicate the end of a user session.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1294,
    "command_name": "Logout",
    "payload": {
      "node": 1
    },
    "timed_request_timeout_ms": 1000
  }
}

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

Cluster 1294 Events

Event 0 — LoggedOut

This event can be used by the Content App to indicate that the current user has logged out. In response to this event, the Fabric Admin must remove access to this Content App by the specified Node. If no Node is provided, then the Fabric Admin must remove access to all non-Admin Nodes.

SmartphoneKey Notes

• Cluster 1294 is not currently exposed by SmartphoneKey devices. This page documents the Matter 1.6.1 specification so that future devices can be interpreted without changes to the backend.
• Shadow paths follow endpoint/1294/attribute; attribute values that the device reports as unreadable are written as n/a.
• Attribute IDs, command IDs and enum values on this page come from the CSA Matter 1.6.1 data model; descriptions are condensed from the specification text.