> ## Documentation index > Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt > Use it to discover all available pages before exploring further. # Assign controlled, unregistered hardware to a managed client > MSP only. Pre-registers hardware under the MSP's PARTNER control that is not registered anywhere (shelf stock, or units unregistered from a previous client) to a managed client org, so each unit lands in that client when it comes online. A registered unit is refused (HARDWARE_NOT_AVAILABLE; move it with /hardware/moveToClient); a unit already pending to another client is refused (CONFLICT); one already pending to this client is reported as assigned without a second pending registration. Per-serial results; one failing serial never aborts the others. Errors: 400 VALIDATION_FAILED (missing toClientOrgUuid, 0 or more than 50 serials); 403 NOT_VERIFIED_MSP, NOT_MANAGED_CLIENT; LOCATION_NOT_FOUND when locationUuid is not in the client org. ```http POST https://api2.rhombussystems.com/api/partner/hardware/assignToClient ``` 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 `) with the `write` scope. - `x-auth-scheme` (header, string, default: `partner-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 ` 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): 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`. Pre-register controlled, unregistered hardware to a managed client. - `locationUuid` (string | null): base 64 (url-safe) uuid string - `serials` (array | null, required): Serial numbers of controlled, unregistered hardware units (1 to 50). Trimmed and de-duplicated. - `toClientOrgUuid` (string | null, required): base 64 (url-safe) uuid string ## Response 200 OK. Content type: `application/json` - `assigned` (array | null): Serials now pending registration to the client (including units that were already pending to it). - `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) - `failed` (array | null): Serials that could not be assigned, each with a code and message. - `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/partner/hardware/assignToClient: post: description: "MSP only. Pre-registers hardware under the MSP's PARTNER control that is not registered anywhere (shelf stock, or units unregistered from a previous client) to a managed client org, so each unit lands in that client when it comes online. A registered unit is refused (HARDWARE_NOT_AVAILABLE; move it with /hardware/moveToClient); a unit already pending to another client is refused (CONFLICT); one already pending to this client is reported as assigned without a second pending registration. Per-serial results; one failing serial never aborts the others. Errors: 400 VALIDATION_FAILED (missing toClientOrgUuid, 0 or more than 50 serials); 403 NOT_VERIFIED_MSP, NOT_MANAGED_CLIENT; LOCATION_NOT_FOUND when locationUuid is not in the client org." operationId: assignHardwareToClient 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 ` 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: partner-api-token in: header name: x-auth-scheme required: false schema: default: partner-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/Partner_msp_AssignHardwareToClientWSRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Partner_msp_AssignHardwareToClientWSResponse" 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: - write summary: Assign controlled, unregistered hardware to a managed client tags: - Partner Webservice components: schemas: Partner_msp_AssignHardwareToClientWSRequest: description: Pre-register controlled, unregistered hardware to a managed client. properties: locationUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string serials: description: Serial numbers of controlled, unregistered hardware units (1 to 50). Trimmed and de-duplicated. items: description: Serial numbers of controlled, unregistered hardware units (1 to 50). Trimmed and de-duplicated. nullable: true type: string nullable: true type: array toClientOrgUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string required: - serials - toClientOrgUuid type: object Partner_msp_AssignHardwareToClientWSResponse: description: Per-serial outcome of a hardware assignment. properties: assigned: description: Serials now pending registration to the client (including units that were already pending to it). items: description: Serials now pending registration to the client (including units that were already pending to it). nullable: true type: string nullable: true type: array 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 failed: description: Serials that could not be assigned, each with a code and message. items: $ref: "#/components/schemas/Partner_msp_HardwareAssignFailureWSType" nullable: true type: array warningMsg: nullable: true type: string type: object Partner_msp_HardwareAssignFailureWSType: description: A hardware unit that could not be assigned to the client and why. properties: code: description: Stable, machine-readable reason (one of the ApiErrorCode catalog, e.g. HARDWARE_NOT_AVAILABLE, CONFLICT). Branch on this, not on message. nullable: true type: string message: description: Client-facing explanation of the failure. nullable: true type: string serial: 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 `. 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 ````