CommandRe-claim hub

Re-claim hub

Re-claims a hub to a different Organization and Site

curl -X POST "https://api.spkey.co/hubs/example_string/ReClaimHub" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "hubId": "example_string",
  "newOrgId": "example_string",
  "newSiteId": "example_string",
  "reason": "example_string",
  "userId": "example_string"
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}
POST
/hubs/{id}/ReClaimHub
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
newOrgIdstring
Required

New Organization ID

reasonstring
Required

Reason for re-claiming

Min length: 1
userIdstring
Required

User ID performing re-claim

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
newOrgIdstring
Required

New Organization ID

reasonstring
Required

Reason for re-claiming

userIdstring
Required

User ID performing re-claim

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required