GOV.UK Pay Admin Console Users service
Switch branches/tags
foo approved-alpha_release-82 approved-alpha_release-81 approved-alpha_release-80 approved-alpha_release-79 approved-alpha_release-77 approved-alpha_release-76 approved-alpha_release-75 approved-alpha_release-74 approved-alpha_release-73 approved-alpha_release-72 approved-alpha_release-71 approved-alpha_release-70 approved-alpha_release-69 approved-alpha_release-68 approved-alpha_release-67 approved-alpha_release-65 approved-alpha_release-64 approved-alpha_release-63 approved-alpha_release-62 approved-alpha_release-61 approved-alpha_release-59 approved-alpha_release-58 approved-alpha_release-57 approved-alpha_release-56 approved-alpha_release-54 approved-alpha_release-53 approved-alpha_release-52 approved-alpha_release-51 approved-alpha_release-50 approved-alpha_release-49 approved-alpha_release-48 approved-alpha_release-47 approved-alpha_release-46 approved-alpha_release-45 approved-alpha_release-44 approved-alpha_release-43 approved-alpha_release-42 approved-alpha_release-41 approved-alpha_release-40 approved-alpha_release-39 approved-alpha_release-38 approved-alpha_release-37 approved-alpha_release-36 approved-alpha_release-35 approved-alpha_release-34 approved-alpha_release-33 approved-alpha_release-31 approved-alpha_release-29 approved-alpha_release-28 approved-alpha_release-27 approved-alpha_release-26 approved-alpha_release-25 approved-alpha_release-24 approved-alpha_release-23 approved-alpha_release-22 approved-alpha_release-21 approved-alpha_release-20 approved-alpha_release-19 approved-alpha_release-18 approved-alpha_release-17 approved-alpha_release-16 approved-alpha_release-15 approved-alpha_release-14 approved-alpha_release-13 approved-alpha_release-12 approved-alpha_release-11 approved-alpha_release-10 approved-alpha_release-9 approved-alpha_release-8 approved-alpha_release-7 approved-alpha_release-6 approved-alpha_release-5 approved-alpha_release-4 approved-alpha_release-3 alpha_test-12-migration-13 alpha_test-12-migration-1 alpha_staging-2-migration-3 alpha_staging-2-migration-1 alpha_staging-2-260 alpha_staging-2-256 alpha_staging-2-254 alpha_staging-2-252 alpha_staging-2-247 alpha_staging-2-246 alpha_staging-2-245 alpha_staging-2-242 alpha_staging-2-241 alpha_staging-2-237 alpha_staging-2-234 alpha_staging-2-233 alpha_staging-2-231 alpha_staging-2-230 alpha_staging-2-229 alpha_staging-2-226 alpha_staging-2-225 alpha_staging-2-224 alpha_staging-2-223 alpha_staging-2-218 alpha_staging-2-217
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
src
.editorconfig
.gitignore
.pact
CONTRIBUTING.md
Dockerfile
Jenkinsfile
LICENCE
README.md
build-local.sh
docker-startup.sh
env.sh
pom.xml
run-with-chamber.sh

README.md

pay-adminusers

The GOV.UK Pay Admin Users Module in Java (Dropwizard)

Environment Variables

  • BASE_URL: This is the publicly visible URL for the pay admin users root. Defaults to http://localhost:8080 if not set.
  • DB_USER: database username for adminusers DB.
  • DB_PASSWORD: database password for adminusers DB.

API Specification

The API Specification provides more detail on the paths and operations including examples.

Path Supported Methods Description
/v1/api/users POST Creates a new user
/v1/api/users/{externalId} GET Gets a user with the associated external id
/v1/api/users/?ids={externalId1},{externalId2}... GET Gets users with the associated external ids
/v1/api/users/{externalId} PATCH amend a specific user attribute
/v1/api/users/{externalId}/services/{serviceId} PUT update user's role for a service
/v1/api/users/{externalId}/services POST assign a new service along with role to a user
/v1/api/users/{externalId}/second-factor/provision POST Create a new provisional OTP key for a user
/v1/api/users/{externalId}/second-factor/activate POST Activate a new OTP key and method for a user
/v1/api/users/authenticate POST Authenticate a given username/password
/v1/api/forgotten-passwords POST Create a new forgotten password request
/v1/api/forgotten-passwords/{code} GET GETs a forgotten password record by code
/v1/api/services POST Creates a new service
/v1/api/invites/service POST Creates a invitation for a new service
/v1/api/invites/user POST Creates a user invitation
/v1/api/services/{externalId} GET returns the service with the given external id
/v1/api/services/{externalId}/users GET returns the users for a service with the given external id
/v1/api/services/{externalId} PATCH Updates the value of a service attribute
/v1/api/services?gatewayAccountId={gateway_account_id} GET Find the service with the given gateway account id associated with
/v1/api/invites/{code}/complete POST Completes an invitation by creating user/service
/v1/api/invites/{code}/otp/generate POST Generates and sends otp verification code to the phone number registered in the invite


Maven profiles

Default profile

By default, maven will run all the tests excluding contract tests mvn clean install

Contract tests profile

By specifying this profile, maven will run only the contract tests mvn clean install -DrunContractTests -DPACT_BROKER_USERNAME=username -DPACT_BROKER_PASSWORD=password -DPACT_CONSUMER_TAG=tag

Licence

MIT License

Responsible Disclosure

GOV.UK Pay aims to stay secure for everyone. If you are a security researcher and have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner. We will give appropriate credit to those reporting confirmed issues. Please e-mail gds-team-pay-security@digital.cabinet-office.gov.uk with details of any issue you find, we aim to reply quickly.