openid / openid/sharedsignals

Addition of event metadata fields inside events

Open
#320 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
78
Forks
18
PR merge metrics
No merged PRs in 30d

Description

We discussed adding device information to device compliance signal use case in today's (01/20/26) WG meeting but this is likely to apply to other event types.

Background:
Slack discussion: https://oidf.slack.com/archives/C02Q0762E83/p1767896644198309
Previous issue: https://github.com/openid/sharedsignals/issues/221
Meeting notes: https://hackmd.io/@oidf-wg-sse/SycZESaBbl

Use case:
When sending device compliance signal, there is a use case to add additional data about the device (OS type, serial #, configuration) or compliance details. Similarly, a session revoking signal may want to add additional data about the user, etc.

Summary:
In the meeting, we concluded that the best place to add such additional data is in the event payload (and not in the sub_id). The type of additional data to add is broad and it while some of it can potentially be standardized, it is unlikely that we can provide a comprehensive definition of all desired data. What we can do is define a standard location and format for the data.
The previous similar issue (https://github.com/openid/sharedsignals/issues/221) propose the addition of an optional "event_data" field to the event payload that will include all such additional information.

More discussion is likely needed if we want to define a more structured format.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing previous issue #221, the linked Slack discussion, and the meeting notes. Work toward agreement on the standard location and format for additional event data, including whether an optional event_data field is sufficient; the issue is done when the structure and scope are defined.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.