/
GO
government-digital-service
/
Adminusers API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 22m ago · Updated 23h ago
8f9d543f352b
latest
OpenAPI 3.0.1
raw.githubusercontent.com
2026-08-11
43
25
47.0 KB
Invites
9
get
List invites for a service
post
Creates an invitation to allow a new team member to join an existing service.
post
Creates an invitation to allow self provisioning new service with Pay
get
Find invite for invite code
patch
Update an invite
post
Completes the invite by creating user/service and invalidating the invite code
post
Re-provision otp secret key for the invite
post
Sends otp verification code to the phone number registered in the invite
post
Validates OTP for the invite
Other
1
get
Healthcheck endpoint for adminusers. Check database, and deadlocks
Passwords
3
post
Create a new forgotten password request (sends email to user)
get
Verify forgotten password code
post
Reset password
Services
14
get
Find service associated with gateway account ID
post
Create new service
get
Get all services
post
Search services by name or merchant name
get
Find service by external ID
patch
Patch service attributes
get
Get details about the acceptance of GOV.UK Pay terms
post
Record acceptance of GOV.UK Pay terms
put
Update merchant details of a service
post
Sends an email to the user who signed the service agreement to inform them that their service is live
get
Get details about the acceptance of Stripe terms
post
Record acceptance of Stripe terms
get
Find users of a service
delete
Delete user from a service
Tasks
1
post
Deletes and archives historical data based on `expungeAndArchiveDataConfig`. Currently, 1. deletes historical users not attached to any service 2. deletes historical invites 3. deletes forgotten passwords 4. archives services without transactions within the configured number of days and detaches users from service
Toolbox
1
delete
Remove user from service (Toolbox use only)
Users
14
get
Gets users with the associated external ids
post
Create new user
post
Get admin user emails for given gateway account IDs
post
Authenticate a given email/password
post
Find user by email
get
Find user by user external ID
patch
Update user attributes
post
Reset 2FA to SMS
post
Send OTP via SMS for an existing user
post
Activate a new OTP key and method for a user
post
Authenticate 2FA code
post
Create a new provisional OTP key for a user
post
Assign a new service along with role to a user
put
Update user's role for a service
Other
Healthcheck endpoint for adminusers. Check database, and deadlocks
get
/healthcheck
Response
OK
string
required