Rhombus Systems Org Webservice API
The Org Webservice API from Rhombus Systems — 47 operation(s) for org webservice.
The Org Webservice API from Rhombus Systems — 47 operation(s) for org webservice.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/rhombus-systems-org-webservice-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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 Org Webservice API
version: '1.0'
servers:
- description: Production Server
url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: Org Webservice
paths:
/api/org/claimActivationToken:
post:
description: Claim activation token for organization
operationId: claimActivationToken
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/Org_ClaimActivationTokenWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_ClaimActivationTokenWSResponse'
description: OK
summary: Claim activation token
tags:
- Org Webservice
/api/org/claimShipmentRegistrationToken:
post:
description: Claim shipment registration token for an organization
operationId: claimShipmentRegistrationToken
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/Org_ClaimShipmentRegistrationTokenWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_ClaimShipmentRegistrationTokenWSResponse'
description: OK
summary: Claim shipment registration token
tags:
- Org Webservice
/api/org/createOrUpdateHealthNotificationRule:
post:
description: Create or update a time/size-based health notification rule. Omit ruleUuid to create a new rule
operationId: createOrUpdateHealthNotificationRule
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/Org_CreateOrUpdateHealthNotificationRuleWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_CreateOrUpdateHealthNotificationRuleWSResponse'
description: OK
summary: Create or update health notification rule
tags:
- Org Webservice
/api/org/createPendingRegistration:
post:
description: Create a pending registration. Registration will be completed when the hardware establishes connectivity
operationId: createPendingRegistration
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/Org_CreatePendingRegistrationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_CreatePendingRegistrationResponse'
description: OK
summary: Create pending registration
tags:
- Org Webservice
/api/org/deleteCloudArchivingConfig:
post:
description: Delete scoped cloud archiving config. Note that the priority of scoping is Org > Location > Device
operationId: deleteCloudArchivingConfig
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/Org_DeleteCloudArchivingConfigWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_DeleteCloudArchivingConfigWSResponse'
description: OK
summary: Delete cloud archiving config
tags:
- Org Webservice
/api/org/deleteHealthNotificationRule:
post:
description: Delete a time/size-based health notification rule
operationId: deleteHealthNotificationRule
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/Org_DeleteHealthNotificationRuleWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_DeleteHealthNotificationRuleWSResponse'
description: OK
summary: Delete health notification rule
tags:
- Org Webservice
/api/org/deleteKeypadLogo:
post:
description: Delete keypad logo.
operationId: deleteKeypadLogo
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/Org_DeleteKeypadLogoWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_DeleteKeypadLogoWSResponse'
description: OK
summary: Delete keypad logo
tags:
- Org Webservice
/api/org/deleteRhombusKeyLogo:
post:
description: Delete rhombus key logo.
operationId: deleteRhombusKeyLogo
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/Org_DeleteRhombusKeyLogoWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_DeleteRhombusKeyLogoWSResponse'
description: OK
summary: Delete rhombus key logo
tags:
- Org Webservice
/api/org/findAllHardwareWithPendingRegistration:
post:
description: Find all hardware for which a pending registrations exists
operationId: findAllHardwareWithPendingRegistration
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/Org_FindAllHardwareWithPendingRegistrationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_FindAllHardwareWithPendingRegistrationResponse'
description: OK
summary: Find all hardware with pending registration
tags:
- Org Webservice
/api/org/findHardwareAvailableForPendingRegistration:
post:
description: Find hardware for which pending registrations can be created
operationId: findHardwareAvailableForPendingRegistration
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/Org_FindHardwareAvailableForPendingRegistrationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_FindHardwareAvailableForPendingRegistrationResponse'
description: OK
summary: Find hardware available for pending registration
tags:
- Org Webservice
/api/org/findIfTeamNameAvailable:
post:
description: Get organization team name if it is available
operationId: findIfTeamNameAvailable
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/Org_FindIfTeamNameAvailableRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_FindIfTeamNameAvailableResponse'
description: OK
summary: Find if team name available
tags:
- Org Webservice
/api/org/findSCIMSettingsForOrg:
post:
description: Get SCIM configuration for organization
operationId: findSCIMSettingsForOrg
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/Org_FindSCIMSettingsForOrgWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_FindSCIMSettingsForOrgWSResponse'
description: OK
summary: Find SCIM settings for organization
tags:
- Org Webservice
/api/org/generateFederatedSessionToken:
post:
description: Generate a federated session token login for organization
operationId: generateFederatedSessionToken
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/Org_GenerateFederatedSessionTokenRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GenerateFederatedSessionTokenResponse'
description: OK
summary: Generate federated session token
tags:
- Org Webservice
/api/org/getClientOrg:
post:
description: Get details about the client organization
operationId: getClientOrg
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/Org_GetClientOrgWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetClientOrgWSResponse'
description: OK
summary: Get client organization details
tags:
- Org Webservice
/api/org/getCloudArchivingConfigs:
post:
description: Get scoped cloud archiving configs. Note that the priority of scoping is Org > Location > Device
operationId: getCloudArchivingConfigs
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/Org_GetCloudArchivingConfigsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetCloudArchivingConfigsWSResponse'
description: OK
summary: Get cloud archiving configs
tags:
- Org Webservice
/api/org/getFeatures:
post:
description: Get organization wide features
operationId: getFeatures
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/Org_GetFeaturesWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetFeaturesWSResponse'
description: OK
summary: Get organization features
tags:
- Org Webservice
/api/org/getHealthNotificationRules:
post:
description: Get all time/size-based health notification rules for the organization
operationId: getHealthNotificationRules
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/Org_GetHealthNotificationRulesWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetHealthNotificationRulesWSResponse'
description: OK
summary: Get health notification rules
tags:
- Org Webservice
/api/org/getOrg:
post:
deprecated: true
description: Get details about organization
operationId: getOrg
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/Org_GetOrgWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetOrgWSResponse'
description: OK
summary: Get organization details
tags:
- Org Webservice
/api/org/getOrgIntegrations:
post:
deprecated: true
description: Use endpoints in Integrations Webservice instead
operationId: DEPRECATED_getOrgIntegrations
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/Org_GetOrgIntegrationsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetOrgIntegrationsWSResponse'
description: OK
summary: Get organization integrations
tags:
- Org Webservice
/api/org/getOrgNotificationTemplate:
post:
deprecated: true
description: This endpoint is no longer in use. Please use getOrgNotificationTemplateV2 instead.
operationId: getOrgNotificationTemplate
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/Org_GetOrgNotificationTemplateWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetOrgNotificationTemplateWSResponse'
description: OK
summary: Get organization notification template
tags:
- Org Webservice
/api/org/getOrgNotificationTemplateV2:
post:
description: Get organization's default notification schedule template
operationId: getOrgNotificationTemplateV2
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/Org_GetOrgNotificationTemplateWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetOrgNotificationTemplateV2WSResponse'
description: OK
summary: Get organization notification template V2
tags:
- Org Webservice
/api/org/getOrgV2:
post:
description: Get details about organization
operationId: getOrgV2
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/Org_GetOrgV2WSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetOrgV2WSResponse'
description: OK
summary: Get organization details V2
tags:
- Org Webservice
/api/org/getSAMLSettings:
post:
deprecated: true
description: Deprecated. Use getSAMLSettingsV2
operationId: getSAMLSettings
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/Org_GetSAMLSettingsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetSAMLSettingsWSResponse'
description: OK
summary: Get SAML settings
tags:
- Org Webservice
/api/org/getSAMLSettingsV2:
post:
description: Get details about organization
operationId: getSAMLSettingsV2
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/Org_GetSAMLSettingsV2WSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetSAMLSettingsV2WSResponse'
description: OK
summary: Get SAML settings V2
tags:
- Org Webservice
/api/org/getScimDisplayInfo:
post:
description: Get SCIM display info for organization
operationId: getScimDisplayInfo
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
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_GetScimDisplayInfoResponse'
description: OK
summary: Get SCIM display info
tags:
- Org Webservice
/api/org/getTemporaryOrgToken:
post:
description: Generate a temporary org token for use in OAuth flows
operationId: getTemporaryOrgToken
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/Org_GetTemporaryOrgTokenWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTemporaryOrgTokenResponse'
description: OK
summary: Get temporary org token
tags:
- Org Webservice
/api/org/peekShipmentRegistrationToken:
post:
description: Peek at a shipping registration token for an organization
operationId: peekShipmentRegistrationToken
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/Org_PeekShipmentRegistrationTokenWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_PeekShipmentRegistrationTokenWSResponse'
description: OK
summary: Peek shipment registration token
tags:
- Org Webservice
/api/org/removePendingRegistration:
post:
description: Remove a pending registration
operationId: removePendingRegistration
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/Org_RemovePendingRegistrationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_RemovePendingRegistrationResponse'
description: OK
summary: Remove pending registration
tags:
- Org Webservice
/api/org/revokeSCIMAc
# --- truncated at 32 KB (195 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-org-webservice-api-openapi.yml