UserGrant lock access to user

Grant lock access to user

Grants a user access to a lock with specified access level (OWNER, ADMIN, USER, GUEST).

curl -X POST "https://api.spkey.co/users/example_string/AddAccessibleLock" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "lockId": "example_string",
  "lockName": "John Doe",
  "accessLevel": "OWNER",
  "validFrom": "example_string",
  "validUntil": "example_string",
  "grantedBy": "example_string"
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null",
  "lockId": "example_string",
  "accessLevel": "OWNER"
}
POST
/users/{id}/AddAccessibleLock
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
accessLevelstring
Required

Access level

Options: OWNER, ADMIN, USER, GUEST
validFromstring

Valid from date

validUntilstring

Valid until date

grantedBystring
Required

User who granted access

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

Access level

Allowed values:OWNERADMINUSERGUEST
validFromstring

Valid from date

validUntilstring

Valid until date

grantedBystring
Required

User who granted access

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required
lockIdstring
Required
accessLevelstring
Required
Allowed values:OWNERADMINUSERGUEST