Session

class CreateSessionInfo

Parameters needed to create a new session

Canonical

kortex_api.autogen.messages.Session_pb2.CreateSessionInfo

Parameters

• username (str) – User name

• session_inactivity_timeout (int) – Inactivity period (in milliseconds) allowed before the session times out and closes on its own

• password (str) – Password for the user

• connection_inactivity_timeout (int) – Inactivity period (in milliseconds) allowed before the robot stops any movements initiated from this session

class ConnectionList

Array of connections

Canonical

kortex_api.autogen.messages.Session_pb2.ConnectionList

Parameters

• connection (Connection [ ]) – This field is deprecated and will be removed in a future release

• user_connections (Connection [ ]) – List of all established user connections

• plugin_connections (Connection [ ]) – List of all established plugin connections

• internal_connections (Connection [ ]) – List of all established internal connections

• unauthenticated_connections (Connection [ ]) – List of all unauthenticated connections (which did not create a session)

• monitor_connections (Connection [ ]) – List of all established monitor connections

class SessionStatusHandle

Defines a session information sent through a raw frame to all routers

Canonical

kortex_api.autogen.messages.Session_pb2.SessionStatusHandle

Parameters

• session_identifier (int) – Id for the session itself

• user_identifier (int) – Id for the user linked to the session

• roles (UserRole [ ]) – Roles of this session’s user (includes temporary roles)

class PayloadSessionStatusRaw

Defines a status for sessions

Canonical

kortex_api.autogen.messages.Session_pb2.PayloadSessionStatusRaw

Parameters

sessions (SessionStatusHandle [ ]) – List of active/logged-in sessions

class TemporaryRoleRequest

Defines the message to fill when adding a temporary role to a session

Canonical

kortex_api.autogen.messages.Session_pb2.TemporaryRoleRequest

Parameters

• role_identifier (str) – Identifier for the role to add to this session

• password (str) – If the role is Admin, password of admin user. If the role is System, password of system user.

class AccessControlOptions

Defines the value of the Access Control options

Canonical

kortex_api.autogen.messages.Session_pb2.AccessControlOptions

Parameters

• single_source_control (bool) – True if Single Source Control is enabled, false otherwise. This setting is persisted upon rebooting.

• bypass_remote_access (bool) – True if bypassing the remote access check is enabled, false otherwise. This setting is not persisted upon rebooting.