Actor API

Actions in the actor namespace of the Nexigon Hub API.

`actor_GetActor`

POST /api/v1/actions/invoke/actor_GetActor

Get the actor.

This action is used to get the actor that is used to invoke the action.

Request GetActorAction

No fields.

Response GetActorOutput

Fields (JSON object)

actor required
The actor.
Actor
Cases internally — tag field actor
- Anonymous
  An anonymous, unauthenticated actor.
  
  { "actor": "Anonymous", ...<payload fields> } — or "content" for non-object payloads
  
  AnonymousActor
  
  No fields.
- System
  The system itself, typically used for internal actions.
  
  { "actor": "System", ...<payload fields> } — or "content" for non-object payloads
  
  SystemActor
  
  No fields.
- Device
  A device authenticated via a specific deployment token.
  
  { "actor": "Device", ...<payload fields> } — or "content" for non-object payloads
  
  DeviceActor
  
  Fields (JSON object)
  deviceId (from device_id) required
  ID of the device.
  
  DeviceId string
  
  tokenId (from token_id) required
  ID of the deployment token used for authentication.
  
  DeploymentTokenId string
- User
  A user typically authenticated via a user session.
  
  { "actor": "User", ...<payload fields> } — or "content" for non-object payloads
  
  UserActor
  
  Fields (JSON object)
  userId (from user_id) required
  ID of the user.
  
  UserId string
- UserToken
  A user authenticated via a specific token.
  
  { "actor": "UserToken", ...<payload fields> } — or "content" for non-object payloads
  
  UserTokenActor
  
  Fields (JSON object)
  userId (from user_id) required
  ID of the user.
  
  UserId string
  
  tokenId (from token_id) required
  ID of the user token used for authentication.
  
  UserTokenId string
- ClusterNode
  A cluster node.
  
  { "actor": "ClusterNode", ...<payload fields> } — or "content" for non-object payloads
  
  ClusterNodeActor
  
  Fields (JSON object)
  nodeId (from node_id) required
  ID of the cluster node.
  
  ClusterNodeId string
- OrganizationApiToken
  An organization API token.
  
  { "actor": "OrganizationApiToken", ...<payload fields> } — or "content" for non-object payloads
  
  OrganizationApiTokenActor
  
  Fields (JSON object)
  organizationId (from organization_id) required
  ID of the organization.
  
  OrganizationId string
  
  tokenId (from token_id) required
  ID of the API token.
  
  OrganizationApiTokenId string