accessmanagement - users

Lists all available users.

This endpoint lists all available users, enabling administrators to quickly view and manage user access across the system.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive data retrieval: Returns a comprehensive list of all users, providing a complete and accurate overview for seamless management and analysis.</br>- Controlled data limits: The pageSize parameter allows users to define the maximum number of users to display per page, optimizing data retrieval for specific use cases.</br>- Customizable pagination: The pageNumber parameter allows users to specify the page of results they wish to retrieve, ensuring targeted access to data.

get/accessmanagement/users

Request

Query parameters

pageSizeinteger

The maximum number of users to return per page. Defaults to 25 if not specified.

pageNumberinteger

The page of results to return. Defaults to 0 if not specified.

Response

Users listed successfully.

totalinteger
countinteger
perPageinteger
currentPageinteger
totalPagesinteger

Example response

{
  "data": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john@doe.com",
      "username": "johndoe",
      "oneloginUserId": "randomIdString",
      "created_ts": "2024-12-18T14:06:21.111477+02:00",
      "modified_ts": "2024-12-18T14:06:21.111477+02:00",
      "status": true,
      "roles": [
        {
          "id": 3,
          "name": "Admin",
          "description": "Administrator role with full permissions"
        }
      ],
      "resourceGroups": [
        {
          "id": 2,
          "name": "Default",
          "description": "Default resource group",
          "isDefault": true
        }
      ],
      "userGroups": [
        {
          "id": 1,
          "name": "Default",
          "description": "Default user group",
          "isDefault": true
        }
      ]
    }
  ],
  "total": 25,
  "count": 10,
  "perPage": 10,
  "totalPages": 3
}

Changes

No recorded changes to this operation across all 1 revision of this API.