Get virtual key by ID

GET

https://localhost:8080/api/v1/virtual-keys/:id

GET

/api/v1/virtual-keys/:id

1 curl https:https://localhost:8080/api/v1/virtual-keys/id \
2      -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampletoken1234567890" \
3      -H "X-Workspace-Id: d290f1ee-6c54-4b01-90e6-d701748f0851" \
4      -H "Content-Type: application/json"

1 {
2   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "name": "Main Entrance Virtual Key",
4   "ownerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
5   "createdAt": "2024-05-20T10:15:30Z",
6   "lastUsedAt": "2024-06-10T08:45:00Z",
7   "status": "active",
8   "permissions": {
9     "owner": [
10       "read",
11       "write",
12       "admin"
13     ],
14     "admin": [
15       "read",
16       "write"
17     ],
18     "viewer": [
19       "read"
20     ],
21     "member": [
22       "read"
23     ]
24   },
25   "metadata": {
26     "location": "Headquarters - Front Door",
27     "deviceType": "mobile",
28     "platform": "iOS"
29   }
30 }

Get virtual key details. Owner, admin, viewer, or member (self only).

Path parameters

idstringRequired

Virtual key UUID

Response

data: virtualKey detail

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Path parameters

Headers

Response

Errors