From 57033a1b8057874fe1a69bf1d3f74d0063f7ec1a Mon Sep 17 00:00:00 2001
From: ImogenCraigmile <148544978+ImogenCraigmile@users.noreply.github.com>
Date: Fri, 7 Feb 2025 08:26:39 +0000
Subject: [PATCH] updated max_age_param to be clearer
---
.../authenticate-your-user.html.md.erb | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/source/integrate-with-integration-environment/authenticate-your-user.html.md.erb b/source/integrate-with-integration-environment/authenticate-your-user.html.md.erb
index 01aa0be..b5364af 100644
--- a/source/integrate-with-integration-environment/authenticate-your-user.html.md.erb
+++ b/source/integrate-with-integration-environment/authenticate-your-user.html.md.erb
@@ -175,7 +175,7 @@ Use the guidance in the following table to replace placeholder values in your ex
| `ui_locales` | Optional | GOV.UK One Login supports English and Welsh as language choices.
If your service is in Welsh, you may want to display GOV.UK One Login in Welsh for a consistent user experience. You can use `ui_locales` to do this.
In the `ui_locales` parameter, you can choose either `en` (English) or `cy` (Welsh).
Using `ui_locales` is optional. If you do not include it, your service will continue using English by default.
GOV.UK One Login does not support any other languages. |
| `vtr` | Optional | The `vtr` parameter represents ‘Vectors of Trust’ where you request authentication and, optionally, identity proving. For example, if you want the medium level of authentication and medium identity confidence, request `vtr=[“Cl.Cm.P2”]`.
You selected your Vector of Trust when you [chose the level of authentication][integrate.choose-level-of-auth] and [the level of identity confidence][integrate.choose-level-of-confidence] for your service.
You can read more about how to combine the vectors for authentication level and identity confidence in [Section 3 of RFC 8485](https://datatracker.ietf.org/doc/html/rfc8485#section-3.1). If you need identity proving, you must request `Cl.Cm` (the medium level of authentication).
If you do not specify the `vtr` parameter, your service will automatically log your users in at the medium level of authentication (`Cl.Cm`). This means you will not receive identity attributes in your response. |
| `claims` | Optional | To get the identity attributes your service needs, you should specify these in the `claims` parameter using the `/userinfo` endpoint. The `/userinfo` endpoint returns a JSON object listing the requested claims.
You can read more about [choosing which user attributes your service can request][integrate.choose-user-attributes].
You can [read more about the structure of the claims request in OpenID Connect section 5.5](https://openid.net/specs/openid-connect-core-1_0.html#ClaimsParameter). |
-| `max_age` | Optional | `max_age` is only available to services not on the GOV.UK domain and those handling particularly sensitive data. Contact GOV.UK One Login support (https://www.sign-in.service.gov.uk/support) for more information. When the `max_age` parameter is included in your request, your user will be forced to reauthenticate if the time in seconds since authentication is greater than `max_age`. `max_age` must be set to zero or a positive integer. |
+| `max_age` | Optional | `max_age` is only available to services not on the GOV.UK domain and those handling particularly sensitive data. When the `max_age` parameter is included in your request, your user will be forced to re-authenticate if the time in seconds since authentication is greater than `max_age`. `max_age` must be set to zero or a positive integer.
You'll need to [contact GOV.UK One Login support](https://www.sign-in.service.gov.uk/support) to request to use `max_age`. |
### Generate an authorisation code