13.3.4.9. User endpoints

The user endpoints is a subset of the system endpoint.

GET /user/

list the users in a realm

Parameters:

• realm – a realm that contains several resolvers. Only show users from this realm
• resolver – a distinct resolvername
• <searchexpr> – a search expression, that depends on the ResolverClass

Return:

json result with “result”: true and the userlist in “value”.

Example request:

GET /user?realm=realm1 HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

 {
   "id": 1,
   "jsonrpc": "2.0",
   "result": {
     "status": true,
     "value": [
       {
         "description": "Cornelius K\u00f6lbel,,+49 151 2960 1417,+49 561 3166797,cornelius.koelbel@netknights.it",
         "email": "cornelius.koelbel@netknights.it",
         "givenname": "Cornelius",
         "mobile": "+49 151 2960 1417",
         "phone": "+49 561 3166797",
         "surname": "K\u00f6lbel",
         "userid": "1009",
         "username": "cornelius"
       }
     ]
   },
   "version": "privacyIDEA unknown"
 }