GOV.UK One Login

https://docs.sign-in.service.gov.uk
Admin
GOV.UK One Login is a government identity verification and authentication service that enables...
Tokens:30,019
Snippets:341
Trust Score:8.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies and Run Application

Source: https://docs.sign-in.service.gov.uk/quick-start

Installs project dependencies and starts the example application in the integration environment.

```bash
npm ci && npm run dev:int
```

--------------------------------

### Install Dependencies and Run Example Service with Simulator

Source: https://docs.sign-in.service.gov.uk/quick-start

Install project dependencies and build/run the example service that connects to the GOV.UK One Login simulator. This command is used when running the example from source code.

```bash
npm ci && npm run dev:sim
```

--------------------------------

### Build and start the GOV.UK One Login simulator from source

Source: https://docs.sign-in.service.gov.uk/test-your-integration/gov-uk-one-login-simulator

Install dependencies, build the simulator, and start it. After running, check if it's working by accessing http://localhost:3000.

```bash
npm install && npm run build
npm run start
```

--------------------------------

### Clone Example Repository and Navigate

Source: https://docs.sign-in.service.gov.uk/quick-start

Clones the example repository and changes the directory to the Node.js client examples. Ensure you have Node.js version 22.11.0 installed and active.

```bash
git clone https://github.com/govuk-one-login/onboarding-examples && cd onboarding-examples/clients/nodejs
nvm install 22.11.0 && nvm use 22.11.0
```

--------------------------------

### Example Request to the /userinfo Endpoint

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

This example shows how to make a GET request to the /userinfo endpoint, including the necessary Host and Authorization headers. Ensure the User-Agent header is populated as required.

```http
GET /userinfo HTTP/1.1
Host: oidc.integration.account.gov.uk
Authorization: Bearer <access_token>
User-Agent: my-platform/version (https://my-service-url.gov.uk)


```

--------------------------------

### Start GOV.UK One Login Simulator from Source

Source: https://docs.sign-in.service.gov.uk/quick-start

Start the GOV.UK One Login simulator in a Docker container using npm scripts. This is part of the process when running the example service from source code.

```bash
npm run simulator:start
```

--------------------------------

### Clone and Navigate to Node.js Examples

Source: https://docs.sign-in.service.gov.uk/quick-start

Clone the GOV.UK One Login onboarding examples repository and change the directory to the Node.js client examples. This is the initial step for both Docker Compose and source code simulator methods.

```bash
git clone https://github.com/govuk-one-login/onboarding-examples && cd onboarding-examples/clients/nodejs
```

--------------------------------

### Example User-Agent Header Format

Source: https://docs.sign-in.service.gov.uk/before-integrating/set-user-agent-header

This is an example of a correctly formatted User-Agent header. It includes platform/version and an optional service URL for debugging.

```text
User-Agent: my-platform/version (https://my-service-url.gov.uk)

```

--------------------------------

### Make a GET request to the /authorize endpoint for medium authentication

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

This example demonstrates how to make a GET request to the /authorize endpoint to authenticate your user with a medium level of authentication. Replace placeholder values with your specific information.

```APIDOC
## GET /authorize

### Description
Authenticates the user with a medium level of identity confidence.

### Method
GET

### Endpoint
/authorize

### Parameters
#### Query Parameters
- **response_type** (string) - Required - Must be 'code'.
- **scope** (string) - Required - The scopes your service can request.
- **client_id** (string) - Required - Your service's client ID.
- **state** (string) - Required - An opaque value used to maintain state between the request and callback.
- **redirect_uri** (string) - Required - The URI to redirect to after authentication.
- **nonce** (string) - Required - A unique value to mitigate replay attacks.
- **vtr** (string) - Required - Vector of Trust, specifying the authentication level. For medium authentication, use `["Cl.Cm"]`.
- **ui_locales** (string) - Optional - User interface locale, e.g., 'en'.

### Request Example
```
GET /authorize?response_type=code&scope=YOUR_SCOPES&client_id=YOUR_CLIENT_ID&state=STATE&redirect_uri=YOUR_REDIRECT_URI&nonce=aEwkamaos5B&vtr=["Cl.Cm"]&ui_locales=en HTTP/1.1
Host: oidc.integration.account.gov.uk
```
```

--------------------------------

### Make a GET request to the /authorize endpoint for authentication and medium identity verification

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

This example shows how to make a GET request to the /authorize endpoint to authenticate your user and verify their identity with a medium level of confidence. This involves two separate requests, the second specifying a higher 'vtr' value.

```APIDOC
## GET /authorize

### Description
Authenticates the user and verifies their identity with a medium level of confidence (P2).

### Method
GET

### Endpoint
/authorize

### Parameters
#### Query Parameters
- **response_type** (string) - Required - Must be 'code'.
- **scope** (string) - Required - The scopes your service can request.
- **client_id** (string) - Required - Your service's client ID.
- **state** (string) - Required - An opaque value used to maintain state between the request and callback.
- **redirect_uri** (string) - Required - The URI to redirect to after authentication.
- **nonce** (string) - Required - A unique value to mitigate replay attacks.
- **vtr** (string) - Required - Vector of Trust, specifying authentication and identity level. For medium authentication and medium identity, use `["Cl.Cm.P2"]`.
- **ui_locales** (string) - Optional - User interface locale, e.g., 'en'.
- **claims** (string) - Optional - A claims request object.

### Request Example
```
GET /authorize?response_type=code&scope=YOUR_SCOPES&client_id=YOUR_CLIENT_ID&state=STATE&redirect_uri=YOUR_REDIRECT_URI&nonce=aEwkamaos5B&vtr=["Cl.Cm.P2"]&ui_locales=en&claims=<claims-request> HTTP/1.1
Host: oidc.integration.account.gov.uk
```
```

--------------------------------

### Make a GET request with JWT-secured OAuth 2.0 authorization request

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

Use this example to make a GET request to authorize a user, securing parameters with a JWT. Replace placeholder values with your specific client details and scopes. Ensure 'response_type', 'scope', and 'client_id' match between query parameters and the request object.

```http
GET /authorize?response_type=code
&scope=YOUR_SCOPES
&client_id=YOUR_CLIENT_ID
&request=YOUR_REQUEST_OBJECT
HTTP/1.1
Host: oidc.integration.account.gov.uk


```

--------------------------------

### GET Request to /authorize Endpoint (Medium Authentication)

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

Use this example to authenticate your user by making a GET request to the /authorize endpoint. Ensure the request is a continuous line of text without extra separators.

```http
GET /authorize?response_type=code
&scope=YOUR_SCOPES
&client_id=YOUR_CLIENT_ID
&state=STATE
&redirect_uri=YOUR_REDIRECT_URI
&nonce=aEwkamaos5B
&vtr=["Cl.Cm"]
&ui_locales=en

HTTP/1.1
Host: oidc.integration.account.gov.uk

```

--------------------------------

### Install OpenSSL on Windows

Source: https://docs.sign-in.service.gov.uk/before-integrating/integrating-third-party-platform

Installs OpenSSL on Windows using Chocolatey. Ensure Chocolatey is installed first.

```bash
choco install openssl
```

--------------------------------

### Start GOV.UK One Login Simulator with Docker Compose

Source: https://docs.sign-in.service.gov.uk/quick-start

Start the GOV.UK One Login simulator using Docker Compose. This method allows you to see simulated responses without viewing additional code.

```bash
docker compose up
```

--------------------------------

### Example Authorization Code Redirect

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

This example shows the redirect URI with an authorization code and state parameter after a user successfully authenticates.

```http
HTTP/1.1 302 Found
Location: https://YOUR_REDIRECT_URI?code=AUTHORIZATION_CODE&state=xyzABC123

```

--------------------------------

### Retrieve DID Document Example

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/prove-users-identity

Make an HTTP GET request to the .well-known/did.json endpoint to retrieve the DID document. Ensure the User-Agent header is populated.

```http
GET /.well-known/did.json HTTP/1.1
Host: identity.integration.account.gov.uk
User-Agent: my-platform/version (https://my-service-url.gov.uk)


```

--------------------------------

### Install and Use Node.js Version for Simulator

Source: https://docs.sign-in.service.gov.uk/quick-start

Ensure you are using the correct Node.js version for running the GOV.UK One Login simulator from source code. This involves installing a specific version and then using it.

```bash
nvm install 22.11.0 && nvm use 22.11.0
```

--------------------------------

### Install OpenSSL on macOS

Source: https://docs.sign-in.service.gov.uk/before-integrating/integrating-third-party-platform

Installs OpenSSL on macOS using Homebrew. Ensure Homebrew is installed first.

```bash
brew install openssl
```

--------------------------------

### Run GOV.UK One Login simulator locally with Docker

Source: https://docs.sign-in.service.gov.uk/test-your-integration/gov-uk-one-login-simulator

This command runs the GOV.UK One Login simulator locally using Docker. Ensure Docker Desktop is installed and host networking is enabled.

```bash
docker run --rm --detach --publish 3000:3000 --name simulator ghcr.io/govuk-one-login/simulator:latest
```

--------------------------------

### Userinfo Response Example

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/prove-users-identity

This is an example of the JSON response received from the `/userinfo` endpoint. It contains various claims about the authenticated user, including their subject identifier, verified email and phone number, a core identity JWT, and optionally, address and identity document details.

```json
HTTP/1.1 200 OK
Content-Type: application/json

  "sub": "urn:fdc:gov.uk:2022:56P4CMsGh_02YOlWpd8PAOI-2sVlB2nsNU7mcLZYhYw=",
  "email": "test@example.com",
  "email_verified": true,
  "phone": "+441406946277",
  "phone_verified": true,
  "https://vocab.account.gov.uk/v1/coreIdentityJWT": <JWT>,
  "https://vocab.account.gov.uk/v1/address": [
    {
      "uprn": 10022812929,
      "subBuildingName": "FLAT 5",
      "buildingName": "WEST LEA",
      "buildingNumber": "16",
      "dependentStreetName": "KINGS PARK",
      "streetName": "HIGH STREET",
      "doubleDependentAddressLocality": "EREWASH",
      "dependentAddressLocality": "LONG EATON",
      "addressLocality": "GREAT MISSENDEN",
      "postalCode": "HP16 0AL",
      "addressCountry": "GB",
      "validFrom": "2022-01-01"
    },
    {
      "uprn": 10002345923,
      "buildingName": "SAWLEY MARINA",
      "streetName": "INGWORTH ROAD",
      "dependentAddressLocality": "LONG EATON",
      "addressLocality": "NOTTINGHAM",
      "postalCode": "BH12 1JY",
      "addressCountry": "GB",
      "validUntil": "2022-01-01"
    }
  ],
  "https://vocab.account.gov.uk/v1/drivingPermit": [
    {
      "expiryDate": "2023-01-18",
      "issueNumber": "5",
      "issuedBy": "DVLA",
      "personalNumber": "DOE99802085J99FG"
    }
  ],
  "https://vocab.account.gov.uk/v1/passport": [
    {
      "documentNumber": "1223456",
      "icaoIssuerCode": "GBR",
      "expiryDate": "2032-02-02"
    }
  ]
}
```

--------------------------------

### Example HTTP 302 Redirect with Error Parameters

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

This example shows the structure of an HTTP 302 Found response when an error occurs during the authentication flow. The error details are appended to the redirect URI.

```http
HTTP/1.1 302 Found
Location: https://YOUR_REDIRECT_URI?error=invalid_request
&error_description=Unsupported%20response
&state=1234


```

--------------------------------

### Example JWT Body Structure

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

This is an example of the required claims for a JWT assertion used to authenticate with GOV.UK One Login. Ensure all fields are correctly populated.

```json
{
  "aud":"https://oidc.integration.account.gov.uk/token",
  "iss":"229pcVGuHP1lXX37T7Wfbr5SIgm",
  "sub":"229pcVGuHP1lXX37T7Wfbr5SIgm",
  "exp":1536165540,
  "jti":"RANDOM_VALUE_JTI",
  "iat":1536132708
}

```

--------------------------------

### POST Request to /token Endpoint

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

This example shows the structure of a POST request to the /token endpoint. Ensure the request is a continuous line of text with parameters separated by ampersands (&) and includes a User-Agent header.

```http
POST /token HTTP/1.1
Host: oidc.integration.account.gov.uk
Content-Type: application/x-www-form-urlencoded
User-Agent: my-platform/version (https://my-service-url.gov.uk)

grant_type=authorization_code
&code=SplxlOBeZQQYbYS6WxSbIA
&redirect_uri=https%3A%2F%2Fclient.example.org%2F
&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer
&client_assertion=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIiLCJpc3MiOiIiLCJhdWQi
OiIiLCJqdGkiOiIifQ.r1Ylfhhy6VNSlhlhW1N89F3WfIGuko2rvSRWO4yK1BI
```

--------------------------------

### Decoded Back-Channel Logout Token Example

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/managing-your-users-sessions

An example of a decoded back-channel logout token received from GOV.UK One Login. This token contains information about the logout event and the user.

```JSON
{
  "kid": "644af598b780f54106c2465489765230c4f8373f35f32e18e3e40cc7acff6",
  "alg": "ES256"
}.{
   "iss": "https://oidc.integration.account.gov.uk/",
   "sub": "urn:fdc:gov.uk:2022:56P4CMsGh_02YOlWpd8PAOI-2sVlB2nsNU7mcLZYhYw=",
   "aud": "YOUR_CLIENT_ID",
   "iat": 1713185467,
   "exp": 1713185587,
   "jti": "30642c87-6167-413f-8ace-f1643c59e398",
    "events": {
         "http://schemas.openid.net/event/backchannel-logout": {}
     }
  }
```

--------------------------------

### Sample UK Address Claim

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/prove-users-identity

This is an example of a UK address claim as returned by GOV.UK One Login. It includes various address components and a `validFrom` date.

```json
{
  "uprn": 100021051133,
  "organisationName": "Acme Corporation",
  "departmentName": "Sales Department",
  "subBuildingName": "Unit 3B",
  "buildingNumber": "42",
  "buildingName": "Riverside House",
  "dependentStreetName": "Industrial Estate",
  "streetName": "River Lane",
  "doubleDependentAddressLocality": "Riverside",
  "dependentAddressLocality": "Newtown",
  "addressLocality": "Birmingham",
  "postalCode": "B12 8QT",
  "addressCountry": "GB",
  "validFrom": "2000-01-01"
}
```

--------------------------------

### JWKS Document Example

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

This JSON object shows an example of a JWKS (JSON Web Key Set) document published by GOV.UK One Login. It contains public keys used to validate the signature of ID tokens.

```json
{
  "keys": [
    {
      "kty": "EC",
      "use": "sig",
      "crv": "P-256",
      "kid": "644af598b780f54106ca0f3c017341bc230c4f8373f35f32e18e3e40cc7acff6",
      "x": "5URVCgH4HQgkg37kiipfOGjyVft0R5CdjFJahRoJjEw",
      "y": "QzrvsnDy3oY1yuz55voaAq9B1M5tfhgW3FBjh_n_F0U",
      "alg": "ES256"
    },
    {
      "kty": "EC",
      "use": "sig",
      "crv": "P-256",
      "kid": "e1f5699d068448882e7866b49d24431b2f21bf1a8f3c2b2dde8f4066f0506f1b",
      "x": "BJnIZvnzJ9D_YRu5YL8a3CXjBaa5AxlX1xSeWDLAn9k",
      "y": "x4FU3lRtkeDukSWVJmDuw2nHVFVIZ8_69n4bJ6ik4bQ",
      "alg": "ES256"
    },
    {
      "kty": "RSA",
      "e": "AQAB",
      "use": "sig",
      "kid": "76e79bfc350137593e5bd992b202e248fc97e7a20988a5d4fbe9a0273e54844e",
      "alg": "RS256",
      "n": "lGac-hw2cW5_amtNiDI-Nq2dEXt1x0nwOEIEFd8NwtYz7ha1GzNwO2LyFEoOvqIAcG0NFCAxgjkKD5QwcsThGijvMOLG3dPRMjhyB2S4bCmlkwLpW8vY4sJjc4bItdfuBtUxDA0SWqepr5h95RAsg9UP1LToJecJJR_duMzN-Nutu9qwbpIJph8tFjOFp_T37bVFk4vYkWfX-d4-TOImOOD75G0kgYoAJLS2SRovQAkbJwC1bdn_N8yw7RL9WIqZCwzqMqANdo3dEgSb04XD_CUzL0Y2zU3onewH9PhaMfb11JhsuijH3zRA0dwignDHp7pBw8uMxYSqhoeVO6V0jz8vYo27LyySR1ZLMg13bPNrtMnEC-LlRtZpxkcDLm7bkO-mPjYLrhGpDy7fSdr-6b2rsHzE_YerkZA_RgX_Qv-dZueX5tq2VRZu66QJAgdprZrUx34QBitSAvHL4zcI_Qn2aNl93DR-bT8lrkwB6UBz7EghmQivrwK84BjPircDWdivT4GcEzRdP0ed6PmpAmerHaalyWpLUNoIgVXLa_Px07SweNzyb13QFbiEaJ8p1UFT05KzIRxO8p18g7gWpH8-6jfkZtTOtJJKseNRSyKHgUK5eO9kgvy9sRXmmflV6pl4AMOEwMf4gZpbKtnLh4NETdGg5oSXEuTiF2MjmXE"
    }
  ]
}
```

--------------------------------

### Example return code claim response

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/prove-users-identity

This JSON response shows an example of the return code claim, which may contain an array of codes indicating issues during identity verification. Contact GOV.UK One Login for detailed explanations of each code.

```json
HTTP/1.1 200 OK
Content-Type: application/json
{
  "sub": "urn:fdc:gov.uk:2022:56P4CMsGh_02YOlWpd8PAOI-2sVlB2nsNU7mcLZYhYw=",
  "email": "test@example.com",
  "email_verified": true,
  "phone_number": "+441406946277",
  "phone_number_verified": true,
  "https://vocab.account.gov.uk/v1/returnCode": [
    {
      "code": "B"
    },
    {
      "code": "C"
    }
  ]
}
```

--------------------------------

### Simulator Configuration

Source: https://docs.sign-in.service.gov.uk/test-your-integration/gov-uk-one-login-simulator

A simulator configuration endpoint for modifying and requesting the current configuration using POST and GET.

```APIDOC
## GET /config

### Description
Requests the current simulator configuration.

### Method
GET

### Endpoint
/config

## POST /config

### Description
Modifies the current simulator configuration.

### Method
POST

### Endpoint
/config
```

--------------------------------

### Configure Integration Environment Variables

Source: https://docs.sign-in.service.gov.uk/quick-start

Copies the example environment file and updates placeholders for Client ID and private key. Ensure the private key is the raw content without headers or line breaks.

```bash
cp .env.integration.example .env.integration
# Edit .env.integration and update {CLIENT_ID} and {PRIVATE_KEY}
```

--------------------------------

### Clone simulator repository and set up Node.js environment

Source: https://docs.sign-in.service.gov.uk/test-your-integration/gov-uk-one-login-simulator

Clone the simulator repository and set up the required Node.js version using nvm. This is the first step to running the simulator from source code.

```bash
git clone https://github.com/govuk-one-login/simulator && cd simulator
nvm install 22.11.0 && nvm use 22.11.0
```

--------------------------------

### GET Request to /authorize Endpoint (Authentication and Identity)

Source: https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/authenticate-your-user

Send two separate requests to authenticate your user and check their identity. This example shows a request for medium authentication and medium identity confidence.

```http
GET /authorize?response_type=code
&scope=YOUR_SCOPES
&client_id=YOUR_CLIENT_ID
&state=STATE
&redirect_uri=YOUR_REDIRECT_URI
&nonce=aEwkamaos5B
&vtr=["Cl.Cm.P2"]
&ui_locales=en
&claims=<claims-request>
HTTP/1.1
Host: oidc.integration.account.gov.uk

```

--------------------------------

### View Default Simulator Configuration

Source: https://docs.sign-in.service.gov.uk/test-your-integration/gov-uk-one-login-simulator

Use this command to fetch the default configuration of the GOV.UK One Login simulator. The output is formatted using jq for readability.

```bash
$ curl localhost:3000/config | jq.
```

```json
{
  "clientConfiguration": {
    "clientId": "HGIOgho9HIRhgoepdIOPFdIUWgewi0jw",
    "publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmXXR3EsRvUMVhEJMtQ1w\nexJjfQ00Q0MQ7ARfShN53BnOQEPFnS/I8ntBddkKdE3q+vMTI72w6Fv3SsMM+ciR\n2LIHdEQfKgsLt6PGNcV1kG6GG/3nSW3psW8w65Q3fmy81P1748qezDrVfaGrF4PD\nXALzX1ph+nz8mpKmck6aY6LEUJ4B+TIfYzlKmmwFe3ri0spSW+J5wE9mmT3VkR2y\nSuHRYHQlxlF9dfX7ltOTsbgJFzN6TO01ZQDhY0iLwzdGwhSxO6R6N/ZINYHCKFPa\nQD+tdKsrw7QDIYnx0IiXFnkGnizl3UtqSmXAaceTvPM2Pz84x2JiwHrp2Sml6RYL\nCQIDAQAB\n-----END PUBLIC KEY-----",
    "scopes": [
      "openid",
      "email",
      "phone"
    ],
    "redirectUrls": [
      "http://localhost:8080/oidc/authorization-code/callback"
    ],
    "postLogoutRedirectUrls": [
      "http://localhost:8080/signed-out"
    ],
    "claims": [
      "https://vocab.account.gov.uk/v1/coreIdentityJWT",
      "https://vocab.account.gov.uk/v1/address",
      "https://vocab.account.gov.uk/v1/returnCode"
    ],
    "identityVerificationSupported": true,
    "idTokenSigningAlgorithm": "ES256",
    "clientLoCs": [
      "P0",
      "P2"
    ]
  },
  "errorConfiguration": {
    "coreIdentityErrors": [],
    "idTokenErrors": [],
    "authoriseErrors": []
  },
  "responseConfiguration": {
    "sub": "urn:fdc:gov.uk:2022:56P4CMsGh_02YOlWpd8PAOI-2sVlB2nsNU7mcLZYhYw=",
    "email": "test@example.com",
    "emailVerified": true,
    "phoneNumber": "07123456789",
    "phoneNumberVerified": true,
    "maxLoCAchieved": "P2",
    "coreIdentityVerifiableCredentials": {
      "type": [
        "VerifiableCredential",
        "IdentityCheckCredential"
      ],
      "credentialSubject": {
        "name": [
          {
            "nameParts": [
              {
                "value": "GEOFFREY",
                "type": "GivenName"
              },
              {
                "value": "HEARNSHAW",
                "type": "FamilyName"
              }
            ]
          }
        ],
        "birthDate": [
          {
            "value": "1955-04-19"
          }
        ]
      }
    },
    "passportDetails": null,
    "drivingPermitDetails": null,
    "postalAddressDetails": [
      {
        "addressCountry": "GB",
        "buildingName": "",
        "streetName": "FRAMPTON ROAD",
        "postalCode": "GL1 5QB",
        "buildingNumber": "26",
        "addressLocality": "GLOUCESTER",
        "validFrom": "2000-01-01",
        "uprn": 100120472196,
        "subBuildingName": ""
      }
    ],
    "returnCodes": []
  },
  "simulatorUrl": "http://localhost:3000"
}
```

--------------------------------

### Check GOV.UK One Login Simulator Configuration

Source: https://docs.sign-in.service.gov.uk/quick-start

Verify that the GOV.UK One Login simulator is working correctly by checking its configuration. This command should display the simulator's configuration details.

```bash
npm run simulator:config
```

--------------------------------

### Example JWKS Endpoint Response

Source: https://docs.sign-in.service.gov.uk/before-integrating/set-up-your-public-and-private-keys

This is an example of the JSON Web Key Set (JWKS) format that your JWKS endpoint should return. It includes RSA signing keys with a unique Key ID (kid).

```json
{
  "keys": [
    {
      "kty": "RSA",
      "e": "AQAB",
      "use": "sig",
      "kid": "f58a6bef-0d22-444b-b4d3-507a54e9892f",
      "n": "pSx43eUV2hZ3AJKYNFHxOsILQ_tUNpfPVELCy3js3FsTp5Mcbpb8mu-arekTCq0Mx5-uqRhJKuT1eGf5DIsb69P__Eyi787Q2o5CdbDwB4iUlEffgx_KuOWUm_4YEuVSjnxfS_hB9h_38zQ6WtD1NnCbcMk4RT2MRvCSiIr9OhjKn9AExH7aaDY7nPm0uVybMkNf5hzBBJWsblBGLmFqnw-qHIEGJaC0M2yZEfXJDbdeZx-IYEYMi3QrR_y4yWzQP2RC8QDU84-uj5mAy5vn06RSdAHNXdiuUX3dIFlerri8gSXo5dPps-gU7igauHnX6mP0HBDtnoNKcM1gpXrnKw"
    }
  ]
}
```

--------------------------------

### Generate Client Secret and Salt using OpenSSL

Source: https://docs.sign-in.service.gov.uk/before-integrating/integrating-third-party-platform

Generates a client secret and a salt using OpenSSL, saving them to files. The client secret should be stored securely, and the salt locally.

```bash
openssl rand 40 | openssl base64 -A -out CLIENT_SECRET.txt
```

```bash
openssl rand 64 | openssl base64 -A -out SALT.txt
```

--------------------------------

### Change GOV.UK One Login simulator port using Docker

Source: https://docs.sign-in.service.gov.uk/test-your-integration/gov-uk-one-login-simulator

Run the GOV.UK One Login simulator on a custom port (e.g., 3333) using Docker by setting the SIMULATOR_URL and PORT environment variables.

```bash
docker run -e SIMULATOR_URL='http://localhost:3333' -e PORT=3333  --rm -ti -p 3333:3333 ghcr.io/govuk-one-login/simulator:latest
```

--------------------------------

### Invalid Request Error Response

Source: https://docs.sign-in.service.gov.uk/test-your-integration/gov-uk-one-login-simulator

This is an example of an error response received when submitting an invalid field to the simulator.

```json
{
  "error": "invalid_request",
  "invalid_fields": [
    {
      "field": "a field name",
      "msg": "an error message"
    }
  ]
}
```
Tokens:
Raw