ESciDoc User Account List

This page has been created for discussion of the requirements of Issue 319

Retrieval of a Filtered List of User Accounts

Requirements

Content of List of User Accounts

We should discuss what information about the user account shall be shown in the list of user accounts.

• A reference to the user account (objid or xlink:href, depending on the interface), only?
• A reference to the user account including name, login name, email information?
• A reference to the user account including name, login name, email information, and active flag?
• All properties of the user account including the list of related organizational units?

Filter Criteria

Filter criterias for user account could be, e.g.

• Ids
• Name
• Primary Organizational Unit
• Organizational Unit
• Active/Deactive

Sorting Criteria

It has to be clarified if sorting of the list is needed and by which values the list shall be sorted, e.g. by

• Name
• Login name
• Email
• Id

Prototype Implementation

There still exists a prototype-like implementation within the base services, but this is currently not available as a REST/SOAP service. This implementation creates a non-filtered list of all user accounts containing the xlink to the user account (in case of REST) or the objid of the user account (in case of SOAP), the name, the login name, the email and the value of the active flag per user account. This prototype implementation could be made available as a service of the REST and SOAP interface, immediately.

Related pages

see also Role lists

Representational State Transfer

Simple Object Access Protocol