{{sidenavigation.sidenavigationExpandLabel}}
{{getMsg('Help_YouAreHere')}}: {{page.title}} {{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}} {{helpModel.downloadHelpPdfDataStatus}}

List Users

Request a list of users from the Users and Groups application. The request has to use the POST method and send a query using JSON.

POST /api/usersandgroups/users

Request a list of users using the following data:

Request Field Value Type Description
query string The query to use to search for users.

Note: the query is locale dependent. The locale is derived from the current client.

Response Field Value Type Description
id string The globally unique ID of the user
type string The user account type
displayName string The display name of the user

Example Request

# Request
POST /api/usersandgroups/users HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
{
    "query":"loginid:volker"
}
 
# Response
HTTP/1.1 200 OK
Content-Type: application/json
 
[
  {
    "id": "9pupvpj7bkbcg1qnbjbonivc9",
    "type": "Standard",
    "displayName": "Volker Berlin"
  }
]

Application Example

# Browser access
http://127.0.0.1:9000/api/usersandgroups/users
 
# Shell access using curl
curl -Ls "http://127.0.0.1:9000/api/usersandgroups/users" \
     --header 'Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u' \
     --header "Content-Type: application/json" \
     --request POST \
     --data '{"query":"loginid:volker"}'
 
 
# Shell access using curl with username and password
curl -Lsu username:password "http://127.0.0.1:9000/api/usersandgroups/users" \
     --header "Content-Type: application/json" \
     --request POST \
     --data '{"query":"loginid:volker"}'
i-net CoWork
This application uses cookies to allow login. By continuing to use this application, you agree to the use of cookies.


Help - /users