Get partner users in organization

Get list of all partners in organization with partner-specific user details and permissions.

POST /api/user/getPartnerUsersInOrg

Get partner users in organization

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/user/getPartnerUsersInOrg \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'

200

{
  "error": true,
  "errorMsg": "<string>",
  "notificationSettings": [
    {
      "allClientsSelected": true,
      "clientNotificationIntervalsMap": {},
      "notificationIntervalsForAllClients": [
        {
          "activityTriggerMap": {},
          "deviceFilterSet": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "diagnosticTriggerMap": {},
          "locationActivityTriggerMap": {},
          "locationDiagnosticTriggerMap": {},
          "locationFilterSet": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "locationOnlyFilterSet": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "minuteOfWeekStart": 123,
          "minuteOfWeekStop": 123
        }
      ],
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "smsPhoneNumbers": [
        "<string>"
      ],
      "summaryEmailEnabled": true,
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "notificationSettingsV2": [
    {
      "allClientsSelected": true,
      "clientNotificationIntervalsMap": {},
      "notificationIntervalsForAllClients": [
        {
          "clientUuids": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "rows": [
            {
              "activities": [],
              "days": [],
              "diagnostics": [],
              "interval": {
                "dayOfWeek": 123,
                "minuteOfDayStartInclusive": 123,
                "minuteOfDayStopExclusive": 123
              },
              "mediums": []
            }
          ]
        }
      ],
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "smsPhoneNumbers": [
        "<string>"
      ],
      "summaryEmailEnabled": true,
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "partnerPermissions": [
    {
      "groupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "partnerUsers": [
    {
      "accessibleRhombusApps": [],
      "accountOwner": true,
      "bypassSaml": true,
      "changePasswordOnLogin": true,
      "createdAtMillis": 123,
      "deleted": true,
      "email": "<string>",
      "emailCaseSensitive": "<string>",
      "emailVerified": true,
      "firstName": "<string>",
      "lastName": "<string>",
      "mfaEnabled": true,
      "name": "<string>",
      "orgUserCustomizationFlags": {},
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "passwordSet": true,
      "rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "updatedAtMillis": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: partner-api-token · 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.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting partner users in organization.

Response

200 - application/json

OK

Response object containing partner users in organization with notification settings and permissions.

error · boolean | null

errorMsg · string | null

notificationSettings · object[] | null

List of partner notification settings

Show child attributes

notificationSettingsV2 · object[] | null

List of partner notification settings V2

Show child attributes

partnerPermissions · object[] | null

List of partner permissions

Show child attributes

partnerUsers · object[] | null

List of partner users in the organization

Show child attributes

warningMsg · string | null