Actor

actor

AnonymousActor

Bases: BaseModel

Anonymous actor, typically used for unauthenticated actions.

SystemActor

Bases: BaseModel

System actor, typically used for internal actions.

DeviceActor

Bases: BaseModel

Device authenticated via a specific deployment token.

device_id class-attribute instance-attribute

device_id = Field(
    description="ID of the device.",
    validation_alias="deviceId",
    serialization_alias="deviceId",
)

token_id class-attribute instance-attribute

token_id = Field(
    description="ID of the deployment token used for authentication.",
    validation_alias="tokenId",
    serialization_alias="tokenId",
)

UserActor

Bases: BaseModel

User authenticated via a user session.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

UserTokenActor

Bases: BaseModel

User authenticated via a specific token.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

token_id class-attribute instance-attribute

token_id = Field(
    description="ID of the user token used for authentication.",
    validation_alias="tokenId",
    serialization_alias="tokenId",
)

ClusterNodeActor

Bases: BaseModel

Cluster node.

node_id class-attribute instance-attribute

node_id = Field(
    description="ID of the cluster node.",
    validation_alias="nodeId",
    serialization_alias="nodeId",
)

OrganizationApiTokenActor

Bases: BaseModel

Organization API token actor.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

token_id class-attribute instance-attribute

token_id = Field(
    description="ID of the API token.",
    validation_alias="tokenId",
    serialization_alias="tokenId",
)

GetActorAction

Bases: BaseModel

Get the actor.

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

GetActorOutput

Bases: BaseModel

Output of getting the actor.

actor class-attribute instance-attribute

actor = Field(description='The actor.')

Actor_Anonymous

Bases: AnonymousActor

actor class-attribute instance-attribute

actor = 'Anonymous'

Actor_System

Bases: SystemActor

actor class-attribute instance-attribute

actor = 'System'

Actor_Device

Bases: DeviceActor

actor class-attribute instance-attribute

actor = 'Device'

Actor_User

Bases: UserActor

actor class-attribute instance-attribute

actor = 'User'

Actor_UserToken

Bases: UserTokenActor

actor class-attribute instance-attribute

actor = 'UserToken'

Actor_ClusterNode

Bases: ClusterNodeActor

actor class-attribute instance-attribute

actor = 'ClusterNode'

Actor_OrganizationApiToken

Bases: OrganizationApiTokenActor

actor class-attribute instance-attribute

actor = 'OrganizationApiToken'

Actor

Actor = Annotated[
    Actor_Anonymous
    | Actor_System
    | Actor_Device
    | Actor_User
    | Actor_UserToken
    | Actor_ClusterNode
    | Actor_OrganizationApiToken,
    Discriminator("actor"),
]