Skip to main content

Defining Roles and Users for the Public Service Registry

Defining Roles and Users for the Public Service Registry

You can configure an ESB so that anyone can access the information in the registry or you can limit access by individual registry entries to specific accounts.

To allow open access to some or all entries in the Public Service Registry, do the following:

  1. Create a role by doing the following:

    1. Select System Administration > Security > Roles to display the Roles portal page.

    2. Click Create New Role and name the role, for example, ServReg_Unauthenticated, and click Save.

  2. Edit or create a web application for the Public Service Registry by doing the following:

    1. For Allowed Authentication Methods, select the Unauthenticated check box.

    2. Include the role that you defined in the previous step in the Application Roles.

    See Configuring a Web Application for the Public Service Registry API for details including other roles that you should include.

  3. For each entry in the Public Service Registry that you want to be available to unauthenticated users, add the role that was defined in Step 1 to the Required Roles field, which is a comma-separated list in Internal Information.

To allowed unauthenticated access, you only need to define the role—you do not need to define a user.

To limit access to entries in the Public Service Registry to a one or more users, do the following:

  1. Create a role by doing the following:

    1. Select System Administration > Security > Roles to display the Roles portal page.

    2. Click Create New Role and name the role, for example, ServReg_IDServices, and click Save.

  2. Edit or create a web application for the Public Service Registry specify the following:

    1. Select the Allowed Authentication Methods Password check box.

    2. Do not include the role that you defined in the previous step in the Application Roles.

    See Configuring a Web Application for the Public Service Registry API for details including other roles that you should include.

  3. For each entry in the Public Service Registry that you want to be available to users with this role, add the role to the Allowed Roles field, which is a comma-separated list.

  4. Create or edit a user account and assign the role to the user as follows:

    1. Select System Administration > Security > Users to display the Users portal page.

    2. Click Create New User, name the user, fill in the relevant fields, such as password, and click Save or select an existing user to edit.

    3. On the Roles tab, click the role or roles you created, click the right-arrow button, and click Assign.

    To access the Public Service Registry REST API, you do not have to assign any additional roles to the user. You may need to assign additional roles to provide access to the service itself.

Note:

Restricting or permitting access to a registry entry is entirely independent of restricting or permitting access to the service described by the registry entry. You can control access to the service itself by controlling access to the web application that invokes the service or by using custom code in the service.

FeedbackOpens in a new tab