CameraRoleCreate camera role

Create camera role

Creates a role in 3dEye and persists the creation event.

curl -X POST "https://api.spkey.co/camera-roles/example_string/CreateCameraRole" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "roleId": "example_string",
  "name": "John Doe",
  "description": "example_string",
  "orgId": "example_string"
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}
POST
/camera-roles/{id}/CreateCameraRole
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

Camera Role ID

Content-Typestring
Required

The media type of the request body

Options: application/json
roleIdstring
Required

Camera Role ID

namestring
Required

Role name

Min length: 1
descriptionstring
Required

Role description

Min length: 1
orgIdstring
Required

Organization ID — opaque string, conventionally but not always a UUID

Min length: 1
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

Camera Role ID

Body

application/json
roleIdstring
Required

Camera Role ID

orgIdstring
Required

Organization ID — opaque string, conventionally but not always a UUID

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required