User and client management procedures

User management is performed from the realm administration console by a user with service desk privileges.

This is available from [authorisation-base-url]/auth/admin/[realm_name]/console/ relative to the authorisation server’s URL base and authorisation realm name. For example if the authorisation server’s base is “https://www.acme.com“, and the realm name “nhs-digital-terminology” then the account mangement console would be hosted at https://www.acme.com/auth/admin/nhs-digital-terminology/console/

This section contains instructions for the following user management procedures:

Create a user

View User Agreement Acceptance records

Reset a user’s password

Suspend a user

Delete a user

Manage system “user roles” for a user

Create credentials to enable systems to access the APIs

Manage the privileges associated with credentials for system API access

Regenerate a secret for client credentials

Delete a client