Create a User Management Profile#

This guide explains how to create and initialize a User Management profile using the Admin UI setup wizard.

Check Prerequisites#

Before running the wizard, ensure that a Token profile and also core facilities like data sources already exist. A credential manager and an account manager might also be needed.

Run the Setup Wizard#

The User Management profile wizard can be started in the Admin UI from multiple places. Either

  • navigate to System → Overview and click the + New Profile button and select User Management in the shown modal, or
  • go to Profiles page and click the + New Profile button and select User Management Profile.

  1. Name and Prefix

    The first step of the wizard requests a name and a URL prefix for User Management endpoints. The name can be anything, but it can be used to identify the profile in web-requests as the realm parameter, so picking a meaningful name is recommended. The prefix will be used for all endpoints in this profile.

    Create User Management profile - set name and prefix
    Create User Management profile - set name and prefix. (Admin UI version: 10.6)

  2. Authentication and Authorization

    Next, the wizard requests to link a Token profile and an Authorization Manager. The selected Token profile will be used to protect the API endpoints exposed in this profile. All requests to the API need an access token issued by the selected Token profile.

    An Authorization Manager is used to authorize access to the API endpoints. See the section about authorization on the User Managemement configuration page for more information about this setting.

    Create User Management profile - set authentication and authorization
    Create User Management profile - set authentication and authorization. (Admin UI version: 10.6)

  3. Data Sources

    Next, configure data sources used to store users and associated resources. See the Data Sources section on the User Managemement configuration page for more information about these settings.

    Create User Management profile - set data sources
    Create User Management profile - set data sources. (Admin UI version: 10.6)

  4. Deployment Status

    Next, deploy the configuration to one or more service roles, to expose the user management endpoints. For a simple deployment, select the default service role.

    Create User Management profile - set deployment
    Create User Management profile - set deployment. (Admin UI version: 10.6)

  5. Done

    Finally, commit all changes and select the new profile to view its details in the Admin UI.

Go to the Configure a User Management Profile guide to learn how to adjust settings after creation.

Was this helpful?