> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Get organization integrations

> Get details of all third-party integrations for organization

```http
POST https://api2.rhombussystems.com/api/integrations/org/getOrgIntegrations
```

EU organizations send the same request to `https://api2.eu.rhombussystems.com`.

## Authentication and parameters

- `x-auth-apikey` (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).
- `Authorization` (header): instead of an API key, an OAuth access token (`Bearer <token>`) with the `read` scope.
- `x-auth-scheme` (header, string, default: `api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`.
- `x-auth-org` (header, string<RUUID>): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`.

## Request body

Content type: `application/json`. Request object for retrieving organization integrations.

No fields: send `{}`.

## Response 200

OK. Content type: `application/json`

- `error` (boolean | null)
- `errorCode` (string | null): Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
- `errorMsg` (string | null)
- `orgIntegrations` (object): Organization integrations configuration and settings
- `warningMsg` (string | null)

## Errors

Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors

## OpenAPI

````yaml
openapi: 3.0.1
info:
  title: Rhombus API
  version: "1.0"
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/integrations/org/getOrgIntegrations:
    post:
      description: Get details of all third-party integrations for organization
      operationId: getOrgIntegrations
      parameters:
        - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters."
          example: api-token
          in: header
          name: x-auth-scheme
          required: false
          schema:
            default: api-token
            enum:
              - api-token
              - api
              - api-oauth-token
              - federated-token
              - partner-api-token
              - partner-api
              - partner-api-oauth-token
            type: string
        - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`."
          in: header
          name: x-auth-org
          required: false
          schema:
            format: RUUID
            maxLength: 22
            minLength: 22
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Integration_GetOrgIntegrationsWSRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Integration_GetOrgIntegrationsWSResponse"
          description: OK
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "503":
          $ref: "#/components/responses/ServiceUnavailable"
      security:
        - ApiKeyAuth: []
        - oauth2:
            - read
      summary: Get organization integrations
      tags:
        - Org Integrations Webservice
components:
  schemas:
    Integration_GetOrgIntegrationsWSRequest:
      description: Request object for retrieving organization integrations.
      type: object
    Integration_GetOrgIntegrationsWSResponse:
      description: Response object containing organization integrations configuration.
      properties:
        error:
          nullable: true
          type: boolean
        errorCode:
          description: Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
          nullable: true
          type: string
        errorMsg:
          nullable: true
          type: string
        orgIntegrations:
          $ref: "#/components/schemas/OrgIntegrationsType"
        warningMsg:
          nullable: true
          type: string
      type: object
    OrgIntegrationsType:
      description: Organization integrations configuration and settings
      properties:
        amtSettings:
          $ref: "#/components/schemas/AmtSettings"
        awsSettings:
          $ref: "#/components/schemas/AwsSettings"
        backblazeSettings:
          $ref: "#/components/schemas/BackblazeSettings"
        boxSettings:
          $ref: "#/components/schemas/BoxSettings"
        brivoSettings:
          $ref: "#/components/schemas/BrivoSettings"
        butterflymxSettings:
          $ref: "#/components/schemas/ButterflyMXSettings"
        diceSettings:
          $ref: "#/components/schemas/DiceSettings"
        dropboxSettingsV2:
          $ref: "#/components/schemas/DropboxSettingsV2"
        emailSettings:
          $ref: "#/components/schemas/EmailSettings"
        envoySettings:
          $ref: "#/components/schemas/EnvoySettings"
        geneaSettings:
          $ref: "#/components/schemas/GeneaSettings"
        googleSettings:
          $ref: "#/components/schemas/GoogleSettings"
        googleSettingsV2:
          $ref: "#/components/schemas/GoogleSettingsV2"
        haloSettings:
          $ref: "#/components/schemas/HaloSettings"
        immixSettings:
          $ref: "#/components/schemas/ImmixSettings"
        intuifaceSettings:
          $ref: "#/components/schemas/IntuifaceSettings"
        kisiSettings:
          $ref: "#/components/schemas/KisiSettings"
        lumeoSettings:
          $ref: "#/components/schemas/LumeoSettings"
        mattermostSettings:
          $ref: "#/components/schemas/MattermostSettings"
        microsoftTeamsSettings:
          $ref: "#/components/schemas/MicrosoftTeamsSettings"
        noonlightSettings:
          $ref: "#/components/schemas/NoonlightSettings"
        office365Settings:
          $ref: "#/components/schemas/Office365Settings"
        openpathSettings:
          $ref: "#/components/schemas/OpenpathSettings"
        opentechAllianceSettings:
          $ref: "#/components/schemas/OpentechAllianceSettings"
        orgUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        pagerDutySettings:
          $ref: "#/components/schemas/PagerDutySettings"
        placeOsSettings:
          $ref: "#/components/schemas/PlaceOsSettings"
        proDataKeySettings:
          $ref: "#/components/schemas/ProDataKeySettings"
        saltoSettings:
          $ref: "#/components/schemas/SaltoSettings"
        serviceNowSettings:
          $ref: "#/components/schemas/ServiceNowSettings"
        slackSettings:
          $ref: "#/components/schemas/SlackSettings"
        slackSettingsV2:
          $ref: "#/components/schemas/SlackSettingsV2"
        squareSettings:
          $ref: "#/components/schemas/SquareSettings"
        toastSettings:
          $ref: "#/components/schemas/ToastSettings"
        tpLinkSettings:
          $ref: "#/components/schemas/TPLinkSettings"
        tritonSettings:
          $ref: "#/components/schemas/TritonSettings"
        twilioSettings:
          $ref: "#/components/schemas/TwilioSettings"
        webhookSettings:
          $ref: "#/components/schemas/WebhookSettings"
      type: object
    AmtSettings:
      properties:
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        createSeekPoints:
          nullable: true
          type: boolean
        doorInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/BadgeIntegrationDoorInfoType"
          nullable: true
          type: object
        email:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        password:
          nullable: true
          type: string
        rhombusToken:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
        webhookId:
          format: int32
          nullable: true
          type: integer
        webhookSignatureSecret:
          nullable: true
          type: string
      type: object
    BadgeIntegrationDoorInfoType:
      nullable: true
      properties:
        assignedCameraList:
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
        clipDuration:
          format: int32
          nullable: true
          type: integer
        doorName:
          nullable: true
          type: string
        leadingSeconds:
          format: int32
          nullable: true
          type: integer
        locationUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        remoteUnlock:
          nullable: true
          type: boolean
        subLocationsHierarchyKey:
          description: |
            A sequence of one or more base 64 (url-safe) uuid substrings.
            These substrings are separated by dots (.).
          example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
          format: SubLocationsHierarchyKey
          nullable: true
          pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
          type: string
      type: object
    AwsSettings:
      properties:
        accessKey:
          nullable: true
          type: string
        bucketName:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        secretKey:
          nullable: true
          type: string
      type: object
    BackblazeSettings:
      properties:
        applicationKey:
          nullable: true
          type: string
        applicationKeyId:
          nullable: true
          type: string
        bucketName:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
      type: object
    BoxSettings:
      description: Box file storage integration settings to update
      properties:
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        enterpriseId:
          nullable: true
          type: string
        folderId:
          nullable: true
          type: string
      type: object
    BrivoSettings:
      properties:
        accessToken:
          nullable: true
          type: string
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        clientId:
          nullable: true
          type: string
        clientSecret:
          nullable: true
          type: string
        createSeekPoints:
          nullable: true
          type: boolean
        doorInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/BadgeIntegrationDoorInfoType"
          nullable: true
          type: object
        doorToCameraMap:
          additionalProperties:
            items:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
            nullable: true
            type: array
          nullable: true
          type: object
          writeOnly: true
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        migrated:
          nullable: true
          type: boolean
        password:
          nullable: true
          type: string
        refreshToken:
          nullable: true
          type: string
        rhombusToken:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
        username:
          nullable: true
          type: string
        webhookId:
          format: int32
          nullable: true
          type: integer
      type: object
    ButterflyMXSettings:
      properties:
        buildingWebhookIdMap:
          additionalProperties:
            description: "A HashMap of <ButterflyMx Building Id, Webhook Id>. "
            nullable: true
            type: string
          description: "A HashMap of <ButterflyMx Building Id, Webhook Id>. "
          nullable: true
          type: object
        createSeekPoints:
          nullable: true
          type: boolean
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        indexFaces:
          nullable: true
          type: boolean
        migrated:
          nullable: true
          type: boolean
        panelInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/ButterflymxPanelInfoType"
          description: A HashMap of <Panel Id, ButterflymxPanelInfoType>.
          nullable: true
          type: object
        refreshToken:
          nullable: true
          type: string
        rhombusToken:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
      type: object
    ButterflymxPanelInfoType:
      description: A HashMap of <Panel Id, ButterflymxPanelInfoType>.
      nullable: true
      properties:
        assignedCameraList:
          description: The list of Rhombus Camera RUUIDs.
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
        buildingId:
          description: The ButterflyMx Building Id.
          format: int32
          nullable: true
          type: integer
        locationUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        panelName:
          description: The ButterflyMx Panel Name.
          nullable: true
          type: string
        subLocationsHierarchyKey:
          description: |
            A sequence of one or more base 64 (url-safe) uuid substrings.
            These substrings are separated by dots (.).
          example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
          format: SubLocationsHierarchyKey
          nullable: true
          pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
          type: string
      type: object
    DiceSettings:
      properties:
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    DropboxSettingsV2:
      description: Dropbox integration settings to update
      properties:
        accessToken:
          nullable: true
          type: string
        accountEmail:
          nullable: true
          type: string
        accountName:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    EmailSettings:
      properties:
        emailAddresses:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    EnvoySettings:
      description: Envoy visitor management integration settings to update
      properties:
        createSeekPoints:
          nullable: true
          type: boolean
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        envoyIntegrationInstalled:
          nullable: true
          type: boolean
        indexFaces:
          nullable: true
          type: boolean
        locationInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/EnvoyLocationInfoType"
          nullable: true
          type: object
        migrated:
          nullable: true
          type: boolean
        refreshToken:
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
      type: object
    EnvoyLocationInfoType:
      nullable: true
      properties:
        assignedCameraList:
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
        locationName:
          nullable: true
          type: string
      type: object
    GeneaSettings:
      properties:
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        apiToken:
          nullable: true
          type: string
        createSeekPoints:
          nullable: true
          type: boolean
        doorInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/BadgeIntegrationDoorInfoType"
          nullable: true
          type: object
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        migrated:
          nullable: true
          type: boolean
        rhombusToken:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
        webhookSignatureSecret:
          nullable: true
          type: string
        webhookUuid:
          nullable: true
          type: string
      type: object
    GoogleSettings:
      description: Google integration settings to update
      properties:
        accountUser:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        folderId:
          nullable: true
          type: string
        teamDriveId:
          nullable: true
          type: string
      type: object
    GoogleSettingsV2:
      properties:
        defaultAlertFolderId:
          nullable: true
          type: string
        defaultAlertFolderName:
          nullable: true
          type: string
        defaultFolderId:
          nullable: true
          type: string
        defaultFolderName:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        refreshToken:
          nullable: true
          type: string
        saveAllAlerts:
          nullable: true
          type: boolean
        saveClips:
          nullable: true
          type: boolean
      type: object
    HaloSettings:
      properties:
        alertAgression:
          nullable: true
          type: boolean
        alertCO:
          nullable: true
          type: boolean
        alertCO2:
          nullable: true
          type: boolean
        alertGunshot:
          nullable: true
          type: boolean
        alertHelp:
          nullable: true
          type: boolean
        alertMasking:
          nullable: true
          type: boolean
        alertTHC:
          nullable: true
          type: boolean
        alertTamper:
          nullable: true
          type: boolean
        alertTemp:
          nullable: true
          type: boolean
        alertVOC:
          nullable: true
          type: boolean
        alertVape:
          nullable: true
          type: boolean
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
        savedClipDurationMs:
          format: int32
          nullable: true
          type: integer
        sensorName:
          nullable: true
          type: string
        sensorToCamerasMap:
          additionalProperties:
            items:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
            nullable: true
            type: array
          nullable: true
          type: object
        triggerNotification:
          nullable: true
          type: boolean
        url:
          nullable: true
          type: string
      type: object
    ImmixSettings:
      properties:
        deviceList:
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
        enabled:
          nullable: true
          type: boolean
        serverUrl:
          nullable: true
          type: string
      type: object
    IntuifaceSettings:
      properties:
        deviceToTriggerMap:
          additionalProperties:
            $ref: "#/components/schemas/TriggerContent"
          nullable: true
          type: object
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    TriggerContent:
      properties:
        apiKey:
          nullable: true
          type: string
        experienceIds:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        experienceNames:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        message:
          nullable: true
          type: string
        parameter1:
          nullable: true
          type: string
        parameter2:
          nullable: true
          type: string
        parameter3:
          nullable: true
          type: string
        playerDeviceNames:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        playerIds:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        playerTags:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
      type: object
    KisiSettings:
      properties:
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        apiSecretKey:
          nullable: true
          type: string
        createSeekPoints:
          nullable: true
          type: boolean
        defaultOptions:
          $ref: "#/components/schemas/BadgeIntegrationDefaultOptions"
        doorInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/BadgeIntegrationDoorInfoType"
          nullable: true
          type: object
        doorToCameraMap:
          additionalProperties:
            items:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
            nullable: true
            type: array
          nullable: true
          type: object
        doorsValidated:
          nullable: true
          type: boolean
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        migrated:
          nullable: true
          type: boolean
        placeId:
          format: int32
          nullable: true
          type: integer
        placeToSettingsMap:
          additionalProperties:
            $ref: "#/components/schemas/BadgeIntegrationSettings"
          nullable: true
          type: object
        rhombusToken:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
        webhookId:
          format: int32
          nullable: true
          type: integer
      type: object
    BadgeIntegrationDefaultOptions:
      nullable: true
      properties:
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        badgeAuthDisablesAlarmMonitoring:
          nullable: true
          type: boolean
        createSeekPoints:
          nullable: true
          type: boolean
        defaultOptionsEnabled:
          nullable: true
          type: boolean
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        saveClips:
          nullable: true
          type: boolean
      type: object
    BadgeIntegrationSettings:
      nullable: true
      properties:
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        badgeAuthDisablesAlarmMonitoring:
          nullable: true
          type: boolean
        createSeekPoints:
          nullable: true
          type: boolean
        doorInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/BadgeIntegrationDoorInfoType"
          nullable: true
          type: object
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        misconfiguredDoors:
          items:
            format: int32
            nullable: true
            type: integer
          nullable: true
          type: array
        placeId:
          format: int32
          nullable: true
          type: integer
        placeName:
          nullable: true
          type: string
        rhombusToken:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
        webhookId:
          format: int32
          nullable: true
          type: integer
      type: object
    LumeoSettings:
      properties:
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    MattermostSettings:
      properties:
        channel:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        webhookUrl:
          nullable: true
          type: string
      type: object
    MicrosoftTeamsSettings:
      properties:
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        webhookUrl:
          nullable: true
          type: string
      type: object
    NoonlightSettings:
      properties:
        acceptedTermsOfService:
          nullable: true
          type: boolean
        defaultContactsByLocationMap:
          additionalProperties:
            $ref: "#/components/schemas/EmergencyContact"
          nullable: true
          type: object
        defaultDelayByLocationsMap:
          additionalProperties:
            format: int32
            nullable: true
            type: integer
          nullable: true
          type: object
        defaultPromptByLocationsMap:
          additionalProperties:
            $ref: "#/components/schemas/NoonlightPromptThemeEnum"
          nullable: true
          type: object
        emergencyContactsByLocationsMap:
          additionalProperties:
            items:
              $ref: "#/components/schemas/EmergencyResponseContactsIntervalType"
            nullable: true
            type: array
          nullable: true
          type: object
        enabled:
          nullable: true
          type: boolean
        escalationSettingsByLocationsMap:
          additionalProperties:
            items:
              $ref: "#/components/schemas/AlertMonitoringSubmissionDelayIntervalType"
            nullable: true
            type: array
          nullable: true
          type: object
        locationEntryInstructionsMap:
          additionalProperties:
            nullable: true
            type: string
          nullable: true
          type: object
        pinsByLocationMap:
          additionalProperties:
            items:
              $ref: "#/components/schemas/AlertMonitoringPinType"
            nullable: true
            type: array
            uniqueItems: true
          nullable: true
          type: object
        verificationPrompt:
          nullable: true
          type: string
      type: object
    EmergencyContact:
      properties:
        name:
          description: The name of the emergency contact.
          nullable: true
          type: string
        phoneNumber:
          description: The phone number for this emergency contact.
          nullable: true
          type: string
      required:
        - name
        - phoneNumber
      type: object
    NoonlightPromptThemeEnum:
      enum:
        - THREAT
        - HUMAN
      type: string
    EmergencyResponseContactsIntervalType:
      properties:
        emergencyContactList:
          items:
            $ref: "#/components/schemas/EmergencyContact"
          nullable: true
          type: array
        minuteOfWeekStart:
          format: int32
          nullable: true
          type: integer
        minuteOfWeekStop:
          format: int32
          nullable: true
          type: integer
      type: object
    AlertMonitoringSubmissionDelayIntervalType:
      properties:
        escalationDelayMinutes:
          format: int32
          nullable: true
          type: integer
        minuteOfWeekStart:
          format: int32
          nullable: true
          type: integer
        minuteOfWeekStop:
          format: int32
          nullable: true
          type: integer
        promptTheme:
          $ref: "#/components/schemas/NoonlightPromptThemeEnum"
      type: object
    AlertMonitoringPinType:
      properties:
        description:
          nullable: true
          type: string
        name:
          nullable: true
          type: string
        pin:
          nullable: true
          type: string
      type: object
    Office365Settings:
      description: Office 365 integration settings to update
      properties:
        driveId:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        tenantId:
          nullable: true
          type: string
      type: object
    OpenpathSettings:
      properties:
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        createSeekPoints:
          nullable: true
          type: boolean
        doorInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/BadgeIntegrationDoorInfoType"
          nullable: true
          type: object
        doorToCameraMap:
          additionalProperties:
            items:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
            nullable: true
            type: array
          nullable: true
          type: object
        email:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        eventToWebhookIdMap:
          additionalProperties:
            format: int32
            nullable: true
            type: integer
          nullable: true
          type: object
        eventToWebhookMap:
          additionalProperties:
            $ref: "#/components/schemas/WebhookMapEntry"
          nullable: true
          type: object
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        migrated:
          nullable: true
          type: boolean
        password:
          nullable: true
          type: string
        rhombusToken:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
        webhookId:
          format: int32
          nullable: true
          type: integer
      type: object
    WebhookMapEntry:
      nullable: true
      properties:
        orgId:
          format: int32
          nullable: true
          type: integer
        webhookId:
          format: int32
          nullable: true
          type: integer
      type: object
    OpentechAllianceSettings:
      properties:
        apiKey:
          nullable: true
          type: string
        apiSecret:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        facilityToSettingsMap:
          additionalProperties:
            $ref: "#/components/schemas/OpentechAllianceFacilitySettings"
          nullable: true
          type: object
        migrated:
          nullable: true
          type: boolean
      type: object
    OpentechAllianceFacilitySettings:
      nullable: true
      properties:
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        createSeekPoints:
          nullable: true
          type: boolean
        doorInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/OpentechAllianceDoorInfoType"
          nullable: true
          type: object
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        saveClips:
          nullable: true
          type: boolean
      type: object
    OpentechAllianceDoorInfoType:
      nullable: true
      properties:
        actionGroupId:
          nullable: true
          type: string
        assignedCameraList:
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
        clipDuration:
          format: int32
          nullable: true
          type: integer
        doorName:
          nullable: true
          type: string
        leadingSeconds:
          format: int32
          nullable: true
          type: integer
        locationUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        remoteUnlock:
          nullable: true
          type: boolean
        subLocationsHierarchyKey:
          description: |
            A sequence of one or more base 64 (url-safe) uuid substrings.
            These substrings are separated by dots (.).
          example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
          format: SubLocationsHierarchyKey
          nullable: true
          pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
          type: string
      type: object
    PagerDutySettings:
      properties:
        allLocationIntegrationKeys:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        integrationKey:
          nullable: true
          type: string
        locationToIntegrationKeysMap:
          additionalProperties:
            items:
              nullable: true
              type: string
            nullable: true
            type: array
          nullable: true
          type: object
      type: object
    PlaceOsSettings:
      properties:
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        apiUrl:
          nullable: true
          type: string
        createSeekPoints:
          nullable: true
          type: boolean
        doorInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/BadgeIntegrationDoorInfoType"
          nullable: true
          type: object
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        migrated:
          nullable: true
          type: boolean
        rhombusToken:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
        webhookSignatureSecret:
          nullable: true
          type: string
      type: object
    ProDataKeySettings:
      properties:
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        badgeAuthDisablesAlarmMonitoring:
          nullable: true
          type: boolean
        createSeekPoints:
          nullable: true
          type: boolean
        doorInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/BadgeIntegrationDoorInfoType"
          nullable: true
          type: object
        doorsValidated:
          nullable: true
          type: boolean
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        misconfiguredDoors:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        ouId:
          nullable: true
          type: string
        rhombusToken:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
        webhookId:
          nullable: true
          type: string
        webhookSignatureSecret:
          nullable: true
          type: string
      type: object
    SaltoSettings:
      properties:
        alertUnauthorizedFaces:
          nullable: true
          type: boolean
        createSeekPoints:
          nullable: true
          type: boolean
        enabled:
          nullable: true
          type: boolean
        identifyFacesFromBadge:
          nullable: true
          type: boolean
        saveClips:
          nullable: true
          type: boolean
        tokenToCamerasMap:
          additionalProperties:
            items:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
            nullable: true
            type: array
          nullable: true
          type: object
      type: object
    ServiceNowSettings:
      properties:
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        instanceUrl:
          nullable: true
          type: string
        password:
          nullable: true
          type: string
        username:
          nullable: true
          type: string
      type: object
    SlackSettings:
      properties:
        accessToken:
          nullable: true
          type: string
        channel:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        webhookUrl:
          nullable: true
          type: string
      type: object
    SlackSettingsV2:
      properties:
        channelId:
          nullable: true
          type: string
        channelName:
          nullable: true
          type: string
        code:
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        orgAccessToken:
          nullable: true
          type: string
        sendChannelNotifications:
          nullable: true
          type: boolean
        sendUserNotifications:
          nullable: true
          type: boolean
        userMap:
          additionalProperties:
            $ref: "#/components/schemas/UserInfo"
          description: "A HashMap of <RhombusOrgUser uuid : Slack user uuid, user access token>. This stores the information for each Slack user."
          nullable: true
          type: object
        webhookUrl:
          nullable: true
          type: string
      type: object
    UserInfo:
      description: "A HashMap of <RhombusOrgUser uuid : Slack user uuid, user access token>. This stores the information for each Slack user."
      properties:
        userAccessToken:
          description: Slack user access token
          nullable: true
          type: string
        userId:
          description: Slack user uuid
          nullable: true
          type: string
      type: object
    SquareSettings:
      properties:
        enabled:
          nullable: true
          type: boolean
        locationIdToDeviceUuidsMap:
          additionalProperties:
            items:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
            nullable: true
            type: array
          nullable: true
          type: object
      type: object
    ToastSettings:
      description: Toast POS integration settings to update
      properties:
        currentToastRestaurantGuid:
          description: The current restaurant guid you want to use
          nullable: true
          type: string
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        migrated:
          nullable: true
          type: boolean
        posInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/PosIntegrationInfoType"
          description: A HashMap of <Service Area Guid, PosIntegrationInfoType>. This stores the Pos Information and assigned cameras.
          nullable: true
          type: object
        toastRestaurantInfoMap:
          additionalProperties:
            $ref: "#/components/schemas/ToastRestaurantInfo"
          description: A HashMap of <Restaurant Guid, ToastRestaurantInfo>. This stores the information for each restaurant.
          nullable: true
          type: object
      type: object
    PosIntegrationInfoType:
      description: A HashMap of <Service Area Guid, PosIntegrationInfoType>. This stores the Pos Information and assigned cameras.
      properties:
        assignedCameraList:
          description: A list of camera guids from Rhombus that are assigned to the Pos device.
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
        posName:
          description: The name of the Pos device.
          nullable: true
          type: string
      type: object
    ToastRestaurantInfo:
      description: A HashMap of <Restaurant Guid, ToastRestaurantInfo>. This stores the information for each restaurant.
      properties:
        locationName:
          description: The location name of the restaurant from Toast
          nullable: true
          type: string
        restaurantName:
          description: The name of the restaurant from Toast. e.g., COFFEE CAN
          nullable: true
          type: string
      type: object
    TPLinkSettings:
      properties:
        cameraToSwitchMap:
          additionalProperties:
            nullable: true
            type: string
          nullable: true
          type: object
        enabled:
          nullable: true
          type: boolean
        password:
          nullable: true
          type: string
        targetState:
          format: int32
          nullable: true
          type: integer
        url:
          nullable: true
          type: string
        username:
          nullable: true
          type: string
      type: object
    TritonSettings:
      properties:
        alertAggression:
          nullable: true
          type: boolean
        alertCO:
          nullable: true
          type: boolean
        alertCO2:
          nullable: true
          type: boolean
        alertGunshot:
          nullable: true
          type: boolean
        alertHelp:
          nullable: true
          type: boolean
        alertMasking:
          nullable: true
          type: boolean
        alertTHC:
          nullable: true
          type: boolean
        alertTamper:
          nullable: true
          type: boolean
        alertVOC:
          nullable: true
          type: boolean
        alertVape:
          nullable: true
          type: boolean
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        saveClips:
          nullable: true
          type: boolean
        savedClipDurationMs:
          format: int32
          nullable: true
          type: integer
        sensorToCamerasMap:
          additionalProperties:
            items:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
            nullable: true
            type: array
          nullable: true
          type: object
        triggerNotification:
          nullable: true
          type: boolean
        url:
          nullable: true
          type: string
      type: object
    TwilioSettings:
      properties:
        enabled:
          nullable: true
          type: boolean
        phoneNumbers:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
      type: object
    WebhookSettings:
      description: Webhook integration settings to update
      properties:
        enabled:
          nullable: true
          type: boolean
        enabledTimestampMs:
          format: int64
          nullable: true
          type: integer
        enablingUser:
          nullable: true
          type: string
        enablingUserUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        webhookSecret:
          nullable: true
          type: string
        webhookUrl:
          nullable: true
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey
    oauth2:
      description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer <token>`. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.'
      flows:
        authorizationCode:
          authorizationUrl: https://console.rhombus.com/oauth/authorize
          refreshUrl: https://auth-web.rhombussystems.com/oauth/token
          scopes:
            physical: Unlock doors and elevators, lockdown, alarms, speakers and robots
            read: View cameras, footage and settings
            write: Change settings and data
          tokenUrl: https://auth-web.rhombussystems.com/oauth/token
      type: oauth2
````