There are two ways to add new users; one is from the Users page and the other from the roles page.

Types of Users

The following kinds of users can be added to a role:

User type Info Needed Description Example
Individual User email A person with an email address. person@email.com
Team org path A team with an org path. /WHO/*
Client Application Client ID Only applies to the data API. The data API is available to an external client application. bb4bfe5b-92a5-4246-a78d-318e5264bc5b

Add Users from Users Page

Go to the Users tab in Admin

Image showing the menu options to get to the Users tab. The Main Menu is on Admin and there is a red box around the Users tab name. There is a list of users with a blue box in the middle with "+ New User". To the right are two blue buttons marked Export and Import

A User can either be added directly be pressing the Add User button

Add individual user for the Users Page

Image showing a red box around the "+ New User" button

This will bring up a pop-up allowing an individual to be added

Image showing a pop-up window titled 'Add individual'. The window contains a text field labeled 'Account Email' with placeholder text that reads 'Search for an User Email.' Below the text field, there are two buttons: a grey button labeled 'Cancel' and a blue button labeled 'Save.'

This will lead to a second pop-up with the user name and email and a list of roles. The user must be added to at least one role before the record can be created.

Image showing pop-up with the title of "Add individual". Underneath is a field titled "Account Email" which has the email the user has just entered in it. Underneath is another box titled "Email" with the same email address. Under that is a field titles "Name" and beneath that is a list of all of the roles in the mart with an unchecked checkbox to the left

Once the role has been selected. scroll to the bottom and press the Create button

New User Menu

The New User button has a menu which can be dropped down by clicking on the down arrow to the right.

It has these options

Image showing the New User button with a menu expanded underneath it. The options in the menu are "Add Team", "Add Client Application" and "Add List of Users"

Add Team

In xMart, it is possible to add a team of people. So if, for example, you wanted to add everyone in the WHO to your mart, you would click on “Add Team” which would bring up the “Add Team” pop-up.

Image showing a pop-up with the heading "Add Team". There is a text field labeled 'Team Org Path:' with placeholder text that reads 'Search for an existing OrgPath.' Below the text field, there are two buttons: one labeled 'Cancel' in gray and another labeled 'Save' in blue

Type the OrgPath (e.g. WHO) into the “Team Org Path” text box and then press Enter. “/*” may be added to the end of the team to indicate that all sub-teams are also included.

The team needs to be allocated to one or more roles as before.

Image showing pop-up with the title of "Add Team". Underneath is a field titled "Team Org Path" which has the team name just entered in it. Underneath is a list of all of the roles in the mart with an unchecked checkbox to the left

Add Client Application

In order to access private (i.e. non-public) data, the external users needs to register a client application. This then needs to be registerd as a user in your mart. To do this, click on “Add Client Application” which would bring up the “Add App” pop-up.

Image showing pop-up with the title of "Add app". Underneath is a textbox with the text "Client ID". UNderneath is another checkbox marked "Name of the application". Underneath is a list of all of the roles in the mart with an unchecked checkbox to the left

Enter the Client ID of the app in the Client ID box and the name of the application underneath it.

The app needs to be allocated to one or more roles as before.

Add List of Users

You can add a delimited list of users using the “Add List of Users” menu option.

Image showing pop-up with the title of "Add list of users". Underneath is a multi-line field titled "List of Emails (addresses will be recognized regardless for format" which is emptx. Underneath is a list of all of the roles in the mart with an unchecked checkbox to the left

The user list can be in any delimited format.

The users need to be allocated to one or more roles as before.

Note that you can not assign the RLS using this method but should follow the procedure in the Row Level Security article.

Add Users from Roles Page

In order to manage the roles, navigate to the roles page from the Admin menu option

Go to the Roles tab in Admin

Image showing the menu options to get to the Roles tab. The Main Menu is on Admin and there is a red box around the Roles tab name"

Users can be added to individual roles. First, the roles need to be created.

Once they have been created, select the roles page and press Configure against the role to which you wish to add the users.

Image showing the menu options at the top with the Roles tab selected. Underneath is the text Roles and to the right is a blue button marked "New". Underneath that is a Role called "PIP Data Consumer" with the word "Configure" in a light blue. This has a red box around it

Select the Users tab

Image showing the main menu at the top with the Admin option selected. Below that is the Tab list with Roles selected. Underneath that are more tabs which from left to right are marked "Users", "Perms", "Properties" and "RLS". There is a red box around the "Users" option. Underneath that are 5 buttons which, from left to right are marked "Add Individual User", "Add Team" "Add Anonymous User", "Add Client Application" and "Add List of Users"

Add Individual User

Select Add Individual user and enter their email. The name of the person will be obtained from the account provider system when they login.

Image showing a pop-up window titled 'Add individual'. The window contains a text field labeled 'Account Email' with placeholder text that reads 'Search for an User Email.' Below the text field, there are two buttons: a grey button labeled 'Cancel' and a blue button labeled 'Save.'

Add Team

Select Add Team and enter the absolute org path of the team.

Image showing a pop-up with the heading "Add Team". There is a text field labeled 'Team Org Path:' with placeholder text that reads 'Search for an existing OrgPath.' Below the text field, there are two buttons: one labeled 'Cancel' in gray and another labeled 'Save' in blue

Type the OrgPath (e.g. WHO) into the “Team Org Path” text box and then press Enter. “/*” may be added to the end of the team to indicate that all sub-teams are also included.

Add Anonymous User

The Add Anonymous User button is no longer functional. To make tables available to the public via the OData API, add read permission in the Public/Anonymous API Consumer role.

Add Client Application

Select Add Client Application and enter the Client ID of the application as well as a human-readable name (so you know what the application is later).

Image showing a pop-up window titled 'Add app'. It contains two input fields and two buttons. The first input field is labeled 'Client ID (ex: cb36754f-20a2-47a9-bba1-cce2ea4a1c2a)' and the second input field is labeled 'Name of the application (ex: eJRF).' Below these fields, there are two buttons: a blue button labeled 'Create' and a gray button labeled 'Cancel.'

Just adding the Client ID in this manner is not sufficient to grant rights to an external application. It is necessary to register the client application.

Add List of Users

You can add a delimited list of users using the “Add List of Users” menu option.

Image showing a pop-up window titled 'Add list of users.' Inside the window, there is a text box with the placeholder text 'List of Emails (addresses will be recognized regardless of format).' Below the text box, in red font, it says 'List of Emails (addresses will be recognized regardless of format) is required.' At the bottom of the pop-up window, there are two buttons: one labeled 'Cancel' in gray and another labeled 'Save' in blue.

The user list can be in any delimited format.