Application: account-api
An account for GOV.UK
- GitHub
- account-api
- Ownership
- #govuk-patterns-and-pages
- Category
- APIs
We’d like to set some cookies to understand how you use this site and remember your settings.
We also use cookies set by other sites to help us deliver content from their services.
You have accepted additional cookies. You can change your cookie settings at any time.
You have rejected additional cookies. You can change your cookie settings at any time.
An account for GOV.UK
Provides sign in / sign out and attribute storage functionality to other GOV.UK applications.
In production, this app currently uses the Digital Identity authentication service.
In development, this app uses a stub OIDC provider which signs you in as the first user in the database.
This app does not serve any user-facing pages. To see the app working, you must run an app which uses it, such as frontend.
After starting Frontend, you should be able to access the account dashboard.
This is a Ruby on Rails app, and should follow our Rails app conventions.
Use GOV.UK Docker to run any of the following commands.
This repository follows the standards for testing described in the GOV.UK RFC on continuous deployment:
The default rake task runs all the tests and records code coverage:
bundle exec rake
If you make changes to the API, you must update the Pact tests.
A Pact test has two parts:
The consumer test (defined in gds-api-adapters), which:
The provider configuration (defined in this repo), which defines all of the provider states referenced by the consumer tests.
See the GOV.UK Developer Docs for how to update a Pact test.