Skip to content

Commit

Permalink
Remove documentation of rate limits
Browse files Browse the repository at this point in the history
  • Loading branch information
Sgtpluck committed Dec 30, 2024
1 parent 8dbda77 commit abd7fc8
Show file tree
Hide file tree
Showing 15 changed files with 18 additions and 19 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
User has exceeded the number of email reset notifications (20 attempts within 60 mins) that can be sent to one user’s email addresses.
User has exceeded the number of email reset notifications that can be sent to one user’s email addresses.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
When the user exceeds the limit (5 attempts in 15 minutes) for entering their personal key to reactivate their account incorrectly.
When the user exceeds the limit for entering their personal key to reactivate their account incorrectly.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
A user exceeds the failure limit for document capture (5 times) during identity proofing.
A user exceeds the failure limit for document capture during identity proofing.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
When the user exceeds the limit (3 attempts in 10 minutes) for entering the security code that should have been received in a letter incorrectly during the letter verification process.
When the user exceeds the limit for entering the security code that should have been received in a letter incorrectly during the letter verification process.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
When the user exceeds the number of times they can request a new security code to be sent to their provided phone number (10 requests in 5 minutes) for address verification.
When the user exceeds the number of times they can request a new security code to be sent to their provided phone number for address verification.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
When the user exceeds the number of times (10) they can try verifying the security code that they received on their phone for phone or address verification during identity proofing.
When the user exceeds the number of times they can try verifying the security code that they received on their phone for phone or address verification during identity proofing.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
When the user is rate limited (5 attempts) for submitting a phone number to receive a mobile upload link too many times during identity verification.
When the user is rate limited for submitting a phone number to receive a mobile upload link too many times during identity verification.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
description: |
The user reaches verification submission rate limits (see below) when identity proofing.
The user reaches verification submission rate limits when identity proofing.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
properties:
throttle_context:
type: string
description: |
`single-session` context means that one session attempted to submit verification using the same PII multiple times with failure and exceeded the rate limit (5 within 6 hours).
`multi-session` context means that multiple sessions attempted to submit verification using the same Social Security number multiple times with failure and exceeded the rate limit (10 within 60 minutes).
`single-session` context means that one session attempted to submit verification using the same PII multiple times with failure and exceeded the rate limit.
`multi-session` context means that multiple sessions attempted to submit verification using the same Social Security number multiple times with failure and exceeded the rate limit.
enum:
- single-session
- multi-session
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
The user has exceeded the rate limit (10) for entering an MFA code when setting up an MFA device. Note that this event is currently only generated for phone mfa types.
The user has exceeded the rate limit for entering an MFA code when setting up an MFA device. Note that this event is currently only generated for phone mfa types.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
The user has exceeded the rate limit (9) for requesting OTPs be sent to their phone when setting up an MFA device.
The user has exceeded the rate limit for requesting OTPs be sent to their phone when setting up an MFA device.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
This event can occur during sign up when a user attempts to submit the same email address multiple (20)times without setting up a password. Note that Login.gov does not actually prevent the user from retrying in this case.
This event can occur during sign up when a user attempts to submit the same email address multiple times without setting up a password. Note that Login.gov does not actually prevent the user from retrying in this case.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Expand All @@ -11,5 +11,5 @@ allOf:
# i'm not sure what this description means, exactly. can we come
# up with better language to describe this case?
description: |
A 'true' value indicates that the user has exceeded the rate limit (3) for submitting an email address that is already registered. A 'false' value indicates that the user has exceeded the rate limit (4) for submitting an email address that has not been registered previously.
A 'true' value indicates that the user has exceeded the rate limit for submitting an email address that is already registered. A 'false' value indicates that the user has exceeded the rate limit for submitting an email address that has *not* been registered previously.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
When the user exceeds the limit (3) for entering their current Login.gov password during the logged-in change profile-info flow incorrectly.
When the user exceeds the limit for entering their current Login.gov password during the logged-in change profile-info flow incorrectly.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
The user has exceeded the limit (5 attempts within 1 minute) for providing their email address and password all resulting in a failed login attempt.
The user has exceeded the limit for providing their email address and password all resulting in a failed login attempt.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
description: |
During a login attempt, the user has exceeded the limit (9) for requesting an OTP be sent to their phone.
# is 9 correct? should it be 10?
During a login attempt, the user has exceeded the limit for requesting an OTP be sent to their phone.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: |
The user has exceeded the limit (3) for submitting an MFA code when signing in with a registered MFA device.
The user has exceeded the limit for submitting an MFA code when signing in with a registered MFA device.
allOf:
- $ref: '../shared/EventProperties.yml'
- type: object
Expand Down

0 comments on commit abd7fc8

Please sign in to comment.