CommandClaim hub

Claim hub

Claims a provisioned hub and binds it to Organization and Site

curl -X POST "https://api.spkey.co/hubs/example_string/ClaimHub" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "hubId": "example_string",
  "orgId": "example_string",
  "siteId": "example_string",
  "userId": "example_string"
}'
{
  "success": true,
  "aggregateId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "version": 2
}
POST
/hubs/{id}/ClaimHub
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
Content-Typestring
Required

The media type of the request body

Options: application/json
orgIdstring

Organization ID. Normal keys: bound from the authenticated key — a mismatching value is rejected (403); omit it to claim into your own org. Super keys only: may set any org for a cross-org claim.

userIdstring
Required

User ID claiming the hub

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

Body

application/json
orgIdstring

Organization ID. Normal keys: bound from the authenticated key — a mismatching value is rejected (403); omit it to claim into your own org. Super keys only: may set any org for a cross-org claim.

userIdstring
Required

User ID claiming the hub

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required