AP-614 - Update state parameter explanation on authenticate-your-user.html.md.erb#454
Open
ImogenCraigmile wants to merge 4 commits intomainfrom
Open
AP-614 - Update state parameter explanation on authenticate-your-user.html.md.erb#454ImogenCraigmile wants to merge 4 commits intomainfrom
ImogenCraigmile wants to merge 4 commits intomainfrom
Conversation
ImogenCraigmile
changed the title
pauldougan
changed the title
pauldougan
changed the title
CarlyG55
reviewed
Mar 11, 2026
source/integrate-with-integration-environment/authenticate-your-user.html.md.erb
Outdated
Show resolved
Hide resolved
CarlyG55
reviewed
Mar 11, 2026
| | `scope` | Required | A space-separated list of scopes. You must include `openid` as one scope value. If you request `openid` but also request other incorrect scopes, the error `invalid_scope` will return with an HTTP 302 instead.<br><br>You should refer to the guidance on [choosing which user attributes your service can request][integrate.choose-user-attributes] for the `scope` parameter.<br><br>If you’re using JAR, make sure the `scope` values in the query parameters and the request object are identical. | | ||
| | `client_id` | Required | The [client identifier][integrate.client-id], which we generated for you when you [registered your service to use GOV.UK One Login][integrate.register-your-service] must match your client configuration.<br><br>If you’re using JAR, make sure the `client_id` values in the query parameters and the request object are identical. | | ||
| | `state` | Required | When you receive a response at the redirect URL, there must be a way to verify the response came for a request which you sent. The `state` value solves this issue by binding the request and response, which reduces impact of [Cross Site Request Forgery](https://owasp.org/www-community/attacks/csrf) attacks.<br>This value will be returned to the client in the authentication response. | | ||
| | `state` | Required | When you receive a response at the redirect URL, there must be a way to verify the response came for a request which you sent. The `state` value solves this issue by binding the request and response, which reduces impact of [Cross Site Request Forgery](https://owasp.org/www-community/attacks/csrf) attacks.<br>This value will be returned to the client in the authentication response. <br> The parameter should be:<ul><li> a unique value</li><li>opaque and not open to inspection</li><li>small, to avoid hitting the Web Application Firewall (WAF) limit on the logout endpoint</li></ul><br> The WAF limit depends on the length of the whole query. The limits are:<ul><li>4096 for /authorize endpoint</li><li>2048 for /logout endpoint</li></ul>| |
Contributor
There was a problem hiding this comment.
You could also possibly hit the limit on the authorize call as well FYI so probably don't want to single out logout in the description
Co-authored-by: Carly Gilson <carly.gilson@digital.cabinet-office.gov.uk>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://govukverify.atlassian.net/browse/AP-614
Why
At the moment, the documentation around the State parameter is very vague on the topic and a specific RP encountered an issue with an error but tighter guidance should avoid this happening again.
What
Added specific WAF limits and dimensions
Technical writer support
Do you need a tech writer's support, for example to review your PR? Yes
How to review
Tell reviewers how to assess your changes.
Changelog
If this change is significant (for example, launching a new feature or deprecating a feature), you should update the changelog found at
partials/_changelog.erbunder the heading 'Documentation updates'.Confirm