Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update JWT docs for outgoing security events #531

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update JWT docs for outgoing security events #531

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc7cf86
Update JWT docs for outgoing security events
monfresh Dec 17, 2024
79be391
Link to OIDC certs in "kid" description
monfresh Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions _pages/security-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,9 @@ s41MmdQzalGuKMX3Hr7Rn5xtnmJiQ5HQ7pcdCh5ZidWvw7VcblStN-rTLEBCUUO14pCfdAzVCs09Wb1W
* **typ** (string)
The type header will be set to **secevent+jwt**

* **kid** (string)
The kid header provides a hint indicating which key was used to sign the JWT. The keys are listed in the [Certificates Endpoint](/oidc/certificates/).

#### JWT Claims

* **aud** (string)
Expand All @@ -340,6 +343,9 @@ s41MmdQzalGuKMX3Hr7Rn5xtnmJiQ5HQ7pcdCh5ZidWvw7VcblStN-rTLEBCUUO14pCfdAzVCs09Wb1W
* **events**
An object containing an event, keyed by event type. The keys and values depend on the event types, see [Supported Outgoing Events](#supported-outgoing-events) for event types and their payloads.

* **exp** (integer)
Time at which the JWT expires (12 hours after it was issued), an integer timestamp representing the number of seconds since the Unix Epoch.

### Response
Login.gov will interpret any response other than a 200-level status as a failure, and will ignore any response body. Failure requests may be retried.

Expand Down
Loading