User Webservice

Get users in organization

Get list of all users in organization with complete user details, permissions, notification settings, and partner information.

post/api/user/getUsersInOrg

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/user/getUsersInOrg
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

UserGetUsersInOrgWSRequest required

Request object for getting all users in the organization.

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "notificationSettings": [
    {
      "notificationIntervalsV2": [
        {
          "deviceFilterSet": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "locationFilterSet": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "locationOnlyFilterSet": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ]
        }
      ],
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "notificationSettingsV2": [
    {
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "timeFrames": [
        {
          "rows": [
            {
              "devices": [
                "AAAAAAAAAAAAAAAAAAAAAA.v0"
              ],
              "locationOnly": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ],
              "locations": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ],
              "promptUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ]
            }
          ]
        }
      ],
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "partners": [
    {
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "rhombusKeyAppConfigs": [
    {
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "preferences": {
        "favoriteAccessControlledDoorUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "favoriteAccessControlledElevatorUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "rhombusOrgUserUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "snoozeSettings": [
    {
      "snoozedForAllNotificationsIntervals": [
        {
          "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "userPermissions": [
    {
      "groupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "users": [
    {
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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