RtspCameraGrant a user access to a RTSP camera

Grant a user access to a RTSP camera

curl -X POST "https://api.spkey.co/rtsp-cameras/example_string/GrantAccess" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "userId": "example_string",
  "role": "viewer",
  "grantedBy": "example_string"
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}
POST
/rtsp-cameras/{id}/GrantAccess
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.
path
idstring
Required

RTSP camera UUID (aggregate id)

Content-Typestring
Required

The media type of the request body

Options: application/json
userIdstring
Required

User to grant access to

Min length: 1
rolestring
Required

Role to grant

Options: viewer, manager
grantedBystring

Actor who issued the grant

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

idstring
Required

RTSP camera UUID (aggregate id)

Body

application/json
userIdstring
Required

User to grant access to

rolestring
Required

Role to grant

Allowed values:viewermanager
grantedBystring

Actor who issued the grant

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required