Skip to content

Commit

Permalink
ATO-1291: Updates README
Browse files Browse the repository at this point in the history 
Co-authored-by: Craig Earl <[email protected]>
  • Loading branch information
@Ryan-Andrews99 @cearl1
Ryan-Andrews99 and cearl1 committed Jan 8, 2025
1 parent 8b1d633 commit 9cc9e4b
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The simulator aims to mirror GOV.UK One Login but does not support all of the fe

- You **must** use the[`private_key_jwt` authentication method](https://openid.net/specs/openid-connect-core-1_0.html#:~:text=OAuth.JWT%5D.-,private_key_jwt,-Clients%20that%20have) at the `/token` endpoint
- You **must** attach a `nonce` parameter in the `/authorize` request
- You **must** use a `GET` request with query parameters when making a request to `/authorize`. The simulator does not[support request objects](https://openid.net/specs/openid-connect-core-1_0.html#:~:text=%C2%A0TOC-,3.1.2.1.%C2%A0%20Authentication%20Request,-An%20Authentication%20Request) or the `POST` method for authorization requests.
- You **must** use a `GET` request with either query parameters or a [request object](https://openid.net/specs/openid-connect-core-1_0.html#:~:text=%C2%A0TOC-,3.1.2.1.%C2%A0%20Authentication%20Request,-An%20Authentication%20Request) when making a request to `/authorize`. The simulator does not support the `POST` method for authorization requests.

## Configuration

Expand All @@ -113,6 +113,7 @@ Parameters provided as environment variables that are parsed as an array should
Where values are not provided for the configuration, [default values](#default-configuration-values) will be used. Some provided configuration fields may be ignored if they are not valid.

### Getting the configuration:

To get the current configuration of the simulator, a GET request can be made to the `/config` endpoint. This returns the client configuration, response configuration and error configuration, as well as the url the simulator is running on, in the body of the response.

### Client Configuration
Expand Down Expand Up @@ -261,7 +262,7 @@ The default values for each configurable field are outlined below:
| Public Key | `-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmXXR3EsRvUMVhEJMtQ1wexJjfQ00Q0MQ7ARfShN53BnOQEPFnS/I8ntBddkKdE3q+vMTI72w6Fv3SsMM+ciR2LIHdEQfKgsLt6PGNcV1kG6GG/3nSW3psW8w65Q3fmy81P1748qezDrVfaGrF4PDXALzX1ph+nz8mpKmck6aY6LEUJ4B+TIfYzlKmmwFe3ri0spSW+J5wE9mmT3VkR2ySuHRYHQlxlF9dfX7ltOTsbgJFzN6TO01ZQDhY0iLwzdGwhSxO6R6N/ZINYHCKFPaQD+tdKsrw7QDIYnx0IiXFnkGnizl3UtqSmXAaceTvPM2Pz84x2JiwHrp2Sml6RYLCQIDAQAB-----END PUBLIC KEY-----` |
| Scopes | `["openid", "email", "phone"]` |
| Redirect URLs | `["http://localhost:8080/oidc/authorization-code/callback"]` |
| Claims | `["https://vocab.account.gov.uk/v1/coreIdentityJWT","https://vocab.account.gov.uk/v1/address","https://vocab.account.gov.uk/v1/returnCode"]` |
| Claims | `["https://vocab.account.gov.uk/v1/coreIdentityJWT","https://vocab.account.gov.uk/v1/address","https://vocab.account.gov.uk/v1/returnCode"]` |
| Identity Verification Supported | `true` |
| ID Token Signing Algorithm | `ES256` |
| Client Levels of Confidence | `["P0", "P2"]` |
Expand All @@ -271,11 +272,11 @@ The default values for each configurable field are outlined below:
| 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"}]}}` |
| coreIdentityVerifiableCredentials | `{"type":["VerifiableCredential","IdentityCheckCredential"],"credentialSubject":{"name":[{"nameParts":[{"value":"GEOFFREY","type":"GivenName"},{"value":"HEARNSHAW","type":"FamilyName"}]}],"birthDate":[{"value":"1955-04-19"}]}}` |
| passportDetails | `null` |
| drivingPermitDetails | `null` |
| socialSecurityRecordDetails | `null` |
| postalAddressDetails | `{"postalAddressDetails":[{"addressCountry":"GB","buildingName":"","streetName":"FRAMPTON ROAD","postalCode":"GL1 5QB","buildingNumber":"26","addressLocality":"GLOUCESTER","validFrom":"2000-01-01","uprn":100120472196,"subBuildingName":""}]}` |
| postalAddressDetails | `{"postalAddressDetails":[{"addressCountry":"GB","buildingName":"","streetName":"FRAMPTON ROAD","postalCode":"GL1 5QB","buildingNumber":"26","addressLocality":"GLOUCESTER","validFrom":"2000-01-01","uprn":100120472196,"subBuildingName":""}]}` |
| returnCodes | `null` |
| simulatorUrl | `http://localhost:3000` |
| postLogoutRedirectUrls | `["http://localhost:8080/signed-out]` |
Expand Down

0 comments on commit 9cc9e4b

Please sign in to comment.