Rhombus Systems

Rhombus Systems User Webservice API

The User Webservice API from Rhombus Systems — 12 operation(s) for user webservice.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 12

POST /api/customer/updateCurrentUserNotificationSettings Update notification settings for user #
POST /api/user/assignEmailToUser Assign email to user #
POST /api/user/createUser Create user for organization #
POST /api/user/deleteUser Delete user #
POST /api/user/getPartnerUsersInOrg Get partner users in organization #
POST /api/user/getUsersInOrg Get users in organization #
POST /api/user/updatePartnerUser Update partner user details #
POST /api/user/updatePartnerUserNotificationSettings Update partner user notification settings #
POST /api/user/updateRhombusKeySettingsForUser Update Rhombus key settings for user #
POST /api/user/updateUser Update user details #
POST /api/user/updateUserNotificationSettings Update user notification settings #
POST /api/user/updateUserSelective Update user details selectively #

Documentation

📖
Documentation
https://api-docs.rhombus.community/
📖
APIReference
https://api-docs.rhombus.community/_llms/en/api-reference.md

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-user-webservice-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/rhombus-systems-user-webservice-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

rhombus-systems-user-webservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: developer@rhombussystems.com
  description: 'This API is for use by Rhombus customers and partners.


    ## Authentication


    All requests require two headers:

    - `x-auth-scheme` — The authentication scheme identifier. Use `api-token` for standard API key auth, or `partner-api-token` for partner API auth.

    - `x-auth-apikey` — Your Rhombus API key.


    Example:

    ```

    POST /api/camera/getMinimalCameraStateList

    x-auth-scheme: api-token

    x-auth-apikey: YOUR_API_KEY

    Content-Type: application/json

    ```'
  title: Rhombus User Webservice API
  version: '1.0'
servers:
- description: Production Server
  url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: User Webservice
paths:
  /api/customer/updateCurrentUserNotificationSettings:
    post:
      operationId: updateCurrentUserNotificationSettings
      parameters:
      - description: 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.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_UpdateUserNotificationSettingsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_UpdateUserNotificationSettingsWSResponse'
          description: OK
      summary: Update notification settings for user
      tags:
      - User Webservice
  /api/user/assignEmailToUser:
    post:
      description: Assign a user to an email as long as the user is not currently assigned to one, with validation to prevent duplicate email associations.
      operationId: assignEmailToUser
      parameters:
      - description: 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.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_AssignEmailToUserWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_AssignEmailToUserWSResponse'
          description: OK
      summary: Assign email to user
      tags:
      - User Webservice
  /api/user/createUser:
    post:
      description: Create a user for organization with specified name, email, and role permissions, supporting both client and partner user types with proper validation and audit logging.
      operationId: createUser
      parameters:
      - description: 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.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_CreateUserWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_CreateUserWSResponse'
          description: OK
      summary: Create user for organization
      tags:
      - User Webservice
  /api/user/deleteUser:
    post:
      description: Delete a user from the organization with proper validation to prevent deletion of the last super admin and current user.
      operationId: deleteUser
      parameters:
      - description: 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.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_DeleteUserWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_DeleteUserWSResponse'
          description: OK
      summary: Delete user
      tags:
      - User Webservice
  /api/user/getPartnerUsersInOrg:
    post:
      description: Get list of all partners in organization with partner-specific user details and permissions.
      operationId: getPartnerUsersInOrg
      parameters:
      - description: 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.
        example: partner-api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: partner-api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Partner_GetPartnerUsersInOrgWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Partner_GetPartnerUsersInOrgWSResponse'
          description: OK
      summary: Get partner users in organization
      tags:
      - User Webservice
  /api/user/getUsersInOrg:
    post:
      description: Get list of all users in organization with complete user details, permissions, notification settings, and partner information.
      operationId: getUsersInOrg
      parameters:
      - description: 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.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_GetUsersInOrgWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_GetUsersInOrgWSResponse'
          description: OK
      summary: Get users in organization
      tags:
      - User Webservice
  /api/user/updatePartnerUser:
    post:
      description: Update a partner's details with partner-specific validation and audit logging.
      operationId: updatePartnerUser
      parameters:
      - description: 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.
        example: partner-api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: partner-api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_UpdatePartnerWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_UpdatePartnerWSResponse'
          description: OK
      summary: Update partner user details
      tags:
      - User Webservice
  /api/user/updatePartnerUserNotificationSettings:
    post:
      description: Update notification settings for partner user with partner-specific notification configurations.
      operationId: updatePartnerUserNotificationSettings
      parameters:
      - description: 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.
        example: partner-api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: partner-api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_UpdatePartnerUserNotificationSettingsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_UpdatePartnerUserNotificationSettingsWSResponse'
          description: OK
      summary: Update partner user notification settings
      tags:
      - User Webservice
  /api/user/updateRhombusKeySettingsForUser:
    post:
      description: Update the RhombusKey mobile app settings for the user, including access permissions and app configuration.
      operationId: updateRhombusKeySettingsForUser
      parameters:
      - description: 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.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_UpdateRhombusKeySettingsForUserWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_UpdateRhombusKeySettingsForUserWSResponse'
          description: OK
      summary: Update Rhombus key settings for user
      tags:
      - User Webservice
  /api/user/updateUser:
    post:
      deprecated: true
      description: 'Update a user''s details, DEPRECATED[4/28/2025]: use updateUserSelective for better field-level control.'
      operationId: updateUser
      parameters:
      - description: 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.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_UpdateUserWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_UpdateUserWSResponse'
          description: OK
      summary: Update user details
      tags:
      - User Webservice
  /api/user/updateUserNotificationSettings:
    post:
      description: Update notification settings for user with various notification channels and preferences.
      operationId: updateUserNotificationSettings
      parameters:
      - description: 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.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_UpdateUserNotificationSettingsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_UpdateUserNotificationSettingsWSResponse'
          description: OK
      summary: Update user notification settings
      tags:
      - User Webservice
  /api/user/updateUserSelective:
    post:
      description: Selectively updates a user's details. Omitted fields are ignored but fields with null will unset a value, providing granular control over user updates.
      operationId: updateUserSelective
      parameters:
      - description: 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.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_UpdateUserSelectiveWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_UpdateUserSelectiveWSResponse'
          description: OK
      summary: Update user details selectively
      tags:
      - User Webservice
components:
  schemas:
    User_CreateUserWSResponse:
      type: object
      description: Response object for creating a user.
      properties:
        error:
          type:
          - boolean
          - 'null'
        errorMsg:
          type:
          - string
          - 'null'
        responseStatus:
          $ref: '#/components/schemas/WebResponseStatusEnum'
        userUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        warningMsg:
          type:
          - string
          - 'null'
    RhombusDayOfWeekEnum:
      type: string
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
    NotificationIntervalV2Type:
      type: object
      properties:
        activityTriggerMap:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/NotificationEnumType'
            uniqueItems: true
        deviceFilterSet:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
            format: RUUID
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
          uniqueItems: true
        diagnosticTriggerMap:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/NotificationEnumType'
            uniqueItems: true
        locationActivityTriggerMap:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/NotificationEnumType'
            uniqueItems: true
        locationDiagnosticTriggerMap:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/NotificationEnumType'
            uniqueItems: true
        locationFilterSet:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
            format: RUUID
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
          uniqueItems: true
        locationOnlyFilterSet:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
            format: RUUID
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
          uniqueItems: true
        minuteOfWeekStart:
          type:
          - integer
          - 'null'
          format: int32
        minuteOfWeekStop:
          type:
          - integer
          - 'null'
          format: int32
    ScheduledIntervalType:
      type: object
      description: Map of location UUIDs to snooze intervals
      properties:
        durationSecs:
          type:
          - integer
          - 'null'
          format: int64
        timestampSec:
          type:
          - integer
          - 'null'
          format: int64
        uuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
    PartnerNotificationClientSectionRow:
      type: object
      properties:
        activities:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ActivityEnum'
          uniqueItems: true
        days:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RhombusDayOfWeekEnum'
          uniqueItems: true
        diagnostics:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DiagnosticActivityEnum'
          uniqueItems: true
        interval:
          $ref: '#/components/schemas/MinuteOfDayIntervalType'
        mediums:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NotificationEnumType'
          uniqueItems: true
    NotificationEnumType:
      type: string
      enum:
      - SMS
      - EMAIL
      - APP
      - SLACK
      - MICROSOFT_TEAMS
      - BROWSER
      - UNKNOWN
    DiagnosticActivityEnum:
      type: string
      enum:
      - CAMERA_CONNECTED
      - CAMERA_DISCONNECTED
      - STARTUP
      - GATEWAY_CONNECTED
      - GATEWAY_DISCONNECTED
      - UPDATE_STARTED
      - UPDATE_FIRMWARE_DOWNLOADED
      - UPDATE_FIRMWARE_APPLIED
      - UPDATE_STARTING_REBOOT
      - UPDATE_FAILED_MD5_MISMATCH
      - UPDATE_FAILED_ACCESS_DENIED
      - UPDATE_FAILED_MITM
      - UPDATE_FAILED_CONNNECTION_REFUSED
      - UPDATE_FAILED_CONNNECTION_TIMEOUT
      - UPDATE_FAILED_CONNECTION_REFUSED
      - UPDATE_FAILED_CONNECTION_TIMEOUT
      - UPDATE_FAILED_DNS_FAILURE
      - UPDATE_RUNNING
      - UPDATE_HALTED_FOR_INVESTIGATION
      - UPDATE_HALT_CLEARED
      - UPDATE_HALT_STATE_ACTIVE
      - UPDATE_REFUSED_HALTED
      - BLE_CONNECTED
      - BLE_CONNECTION_FAILED
      - BLE_DISCONNECTED
      - BLE_OP_SUCCESS
      - BLE_OP_FAILURE
      - UPLOAD_CLIP_SUCCESS
      - UPLOAD_CLIP_FAILURE
      - NOTIFICATION_FAILURE
      - USB_FAILURE_REBOOT
      - PERSISTENT_STORAGE_FAILURE
      - PING
      - FORCED_REBOOT
      - AUTO_REBOOT
      - AUDIO_HARDWARE_NOT_DETECTED
      - ENCRYPTED_CONTAINER_FAILURE_CREATE
      - ENCRYPTED_CONTAINER_FAILURE_OPEN
      - ENCRYPTED_CONTAINER_FAILURE_MOUNT
      - VIDEO_HARDWARE_FAILURE
      - WIFI_NETWORK_CHANGED
      - AI_ENGINE_DOWNLOADED
      - AI_ENGINE_DOWNLOAD_FAILED_MD5_MISMATCH
      - AI_ENGINE_CONFIGURED
      - AI_ENGINE_CONFIGURATION_FAILED
      - MITM_FAILURE
      - SERVER_RECONNECT
      - AP_CHANGED
      - WATCHDOG_KILLED_AGENT
      - WATCHDOG_DID_RESET
      - CLIMATE_OFFLINE
      - CLIMATE_ONLINE
      - CLIMATE_LOW_BATTERY
      - CLIMATE_PROBE_CONNECTED
      - CLIMATE_PROBE_DISCONNECTED
      - DOOR_OFFLINE
      - DOOR_ONLINE
      - DOOR_LOW_BATTERY
      - OCCUPANCY_SENSOR_ONLINE
      - OCCUPANCY_SENSOR_OFFLINE
      - OCCUPANCY_SENSOR_LOW_BATTERY
      - BUTTON_OFFLINE
      - BUTTON_ONLINE
      - BUTTON_LOW_BATTERY
      - PROXIMITY_LOW_BATTERY
      - ROBOT_LOW_BATTERY
      - DOOR_CONTROLLER_CONNECTED
      - DOOR_CONTROLLER_DISCONNECTED
      - APERIO_LOW_BATTERY
      - APERIO_FLAT_BATTERY
      - APERIO_OK_BATTERY
      - APERIO_GW_CONNECTED
      - APERIO_GW_DISCONNECTED
      - BADGE_READER_CONNECTED
      - BADGE_READER_DISCONNECTED
      - REBOOT
      - NETWORK_INTERRUPTION
      - OPENPATH_WEBHOOK_FAILURE
      - TOAST_WEBHOOK_FAILURE
      - KISI_WEBHOOK_FAILURE
      - BRIVO_WEBHOOK_FAILURE
      - HALO_WEBHOOK_FAILURE
      - SALTO_WEBHOOK_FAILURE
      - SQUARE_WEBHOOK_FAILURE
      - BUTTERFLYMX_WEBHOOK_FAILURE
      - ENVOY_WEBHOOK_FAILURE
      - GENEA_WEBHOOK_FAILURE
      - PRODATAKEY_WEBHOOK_FAILURE
      - AMT_WEBHOOK_FAILURE
      - PLACEOS_WEBHOOK_FAILURE
      - OMNIALERT_WEBHOOK_FAILURE
      - FLIC_WEBHOOK_FAILURE
      - SHELLY_WEBHOOK_FAILURE
      - PIMLOC_WEBHOOK_FAILURE
      - NINEONEONECELLULAR_WEBHOOK_FAILURE
      - HONEYWELL_ELEMENTS_WEBHOOK_FAILURE
      - HONEYWELL_ONGUARD_WEBHOOK_FAILURE
      - TRITON_WEBHOOK_FAILURE
      - EXTERNAL_WEBHOOK_FAILURE
      - CV_FAILURE
      - NFC_HW_FAILURE
      - CONFIG_ERROR
      - HW_FAILURE
      - KEYPAD_ONLINE
      - KEYPAD_OFFLINE
      - ALM_OVERAGE_APPROACHING
      - ALM_OVERAGE_REACHED
      - ALM_OVERAGE_EXCEEDED
      - ALM_EXCESSIVE_VERIFICATIONS
      - KIOSK_OFFLINE
      - KIOSK_ONLINE
      - TUNNELED_DEVICE_CONNECTED
      - TUNNELED_DEVICE_DISCONNECTED
      - SD_CARD_CHANGED
      - SD_CARD_NOT_FOUND
      - SUPERVISION_CUT_DETECTED
      - SUPERVISION_SHORT_DETECTED
      - SUPERVISION_INVALID_SETUP
      - THIRD_PARTY_DEVICE_CONNECTED
      - THIRD_PARTY_DEVICE_DISCONNECTED
      - NVR_STREAMING_STATUS
      - STORAGE_SM
      - DEVICE_OFFLINE_EXTENDED
      - DEVICE_OFFLINE_RECOVERED
      - DEVICES_OFFLINE_THRESHOLD
      - CLOUD_ARCHIVE_LAGGING
      - CLOUD_ARCHIVE_RECOVERED
      - LOCAL_RECORDING_INTERRUPTED
      - LOCAL_RECORDING_RECOVERED
      - UNKNOWN
    User_UpdateUserWSRequest:
      type: object
      description: Request object for updating user information and settings.
      properties:
        bypassSaml:
          type:
          - boolean
          - 'null'
          description: Whether SAML bypass is enabled for the user
          example: false
        mfaEnabled:
          type:
          - boolean
          - 'null'
          description: Whether MFA is enabled for the user
          example: true
        name:
          type:
          - string
          - 'null'
          description: Name of the user
          example: John Doe
        notificationIntervalsV2:
          type:
          - array
          - 'null'
          description: List of notification intervals (V2) for the user
          items:
            $ref: '#/components/schemas/NotificationIntervalV2Type'
        permissionGroupUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        restrictToAllowedLoginIps:
          type:
          - boolean
          - 'null'
          description: When true the user's web console sessions are restricted to the org-wide login IP allowlist.
          example: true
        smsPhoneNumbers:
          type:
          - array
          - 'null'
          description: List of SMS phone numbers for the user
          items:
            type:
            - string
            - 'null'
            description: List of SMS phone numbers for the user
        summaryEmailEnabled:
          type:
          - boolean
          - 'null'
          description: Whether summary emails are enabled for the user
          example: true
        userUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
    User_GetUsersInOrgWSRequest:
      type: object
      description: Request object for getting all users in the organization.
    Partner_GetPartnerUsersInOrgWSResponse:
      type: object
      description: Response object containing partner users in organization with notification settings and permissions.
      properties:
        error:
          type:
          - boolean
          - 'null'
        errorMsg:
          type:
          - string
          - 'null'
        notificationSettingsV2:
          type:
          - array
          - 'null'
          description: List of partner notification settings V2
          items:
            $ref: '#/components/schemas/PartnerNotificationSettingsV2'
        partnerPermissions:
          type:
          - array
          - 'null'
          description: List of partner permissions
          items:
            $ref: '#/components/schemas/PartnerPermissionType'
        partnerUsers:
          type:
          - array
          - 'null'
          description: List of partner users in the organization
          items:
            $ref: '#/components/schemas/WrappedRhombusOrgUserType'
        warningMsg:
          type:
          - string
          - 'null'
    RhombusSecureMobileCredentialProvisioningRulesType:
      type: object
      properties:
        endDateProvisioner:
          $ref: '#/components/schemas/EpochSecondsProvisioner'
        maxMobileCredsAllowed:
          type:
          - integer
          - 'null'
          format: int32
        startDateProvisioner:
          $ref: '#/components/schemas/EpochSecondsProvisioner'
    MfaTokenTypeEnum:
      type: string
      enum:
      - EMAIL
      - SMS
      - VIRTUAL_MFA
      - FIDO
    NotificationTimeFrame:
      type: object
      properties:
        days:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RhombusDayOfWeekEnum'
          uniqueItems: true
        interval:
          $ref: '#/components/schemas/MinuteOfDayIntervalType'
        mediums:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NotificationEnumType'
          uniqueItems: true
        rows:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NotificationTimeFrameRow'
    User_GetUsersInOrgWSResponse:
      type: object
      description: Response object containing all users in the organization with their settings and permissions.
      properties:
        error:
          type:
          - boolean
          - 'null'
        errorMsg:
          type:
          - string
          - 'null'
        notificationSettings:
          type:
          - array
          - 'null'
          description: List of user notification settings (V3)
          items:
            $ref: '#/components/schemas/UserNotificationSettingsV3Type'
        notificationSettingsV2:
          type:
          - array
          - 'null'
          description: List of user notification settings (V4)
          items:
            $ref: '#/components/schemas/UserNotificationSettingsV4Type'
        partners:
          type:
          - array
          - 'null'
          description: List of partner users in the organization
          items:
            $ref: '#/components/schemas/WrappedRhombusOrgUserType'
        rhombusKeyAppConfigs:
          type:
          - array
          - 'null'
          description: List of Rhombus Key app configurations
          items:
            $ref: '#/components/schemas/RhombusKeyAppConfigType'
        snoozeSettings:
          type:
          - array
          - 'null'
          description: List of user snooze notification settings
          items:
            $ref: '#/components/schemas/User_UserSnoozeNotificationSettingsType'
        userPermissions:
          type:
          - array
          - 'null'
          description: List of user permissions
          items:
            $ref: '#/components/schemas/UserPermissionType'
        users:
          type:
          - array
          - 'null'
          description: List of users in the organization
          items:
            $ref: '#/components/schemas/WrappedRhombusOrgUserType'
        warningMsg:
          type:
          - string
          - 'null'
    User_CreateUserWSRequest:
      type: object
      description: CreateUserWSRequest
      properties:
        accessibleRhombusApps:
          type:
          - array
          - 'null'
          description: The set of accessible Rhombus apps
          items:
            $ref: '#/components/schemas/RhombusAppEnum'
          uniqueItems: true
        email:
          type:
          - string
          - 'null'
          description: The email of the user
        name:
          type:
          - string
          - 'null'
          description: The name of the user
        permissionGroupUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        rhombusKeySettings:
          $ref: '#/components/schemas/RhombusKeyAppSettingsType'
        suppressRhombusKeyWelcomeEmail:
          type:
          - boolean
          - 'null'
          description: Suppress the welcome email for the Rhombus Key mobile app if the user is provided access
        suppressWelcomeEmail:
          type:
          - boolean
          - 'null'
          description: Suppress the welcome email
    UserNotificationSettingsV4Type:
      type: object
      description: List of user notification settings (V4)
      properties:
        orgUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        receiveHealthNotifications:
          type:
          - boolean
          - 'null'
        smsNotificationIncludesLinks:
          type:
          - boolean
          - 'null'
        smsPhoneNumbers:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        summaryEmailEnabled:
          type:
          - boolean
          - 'null'
        timeFrames:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NotificationTimeFrame'
        userUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
    EpochSecondsProvisioner:
      type: object
      discriminator:
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/StaticEpochSecondsProvisioner'
      properties:
        type:
          type: string
      required:
      - type
    WebResponseStatusEnum:
      type: string
      description: Status of the unregister operation
      enum:
      - BA

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-user-webservice-api-openapi.yml