Skip to content

Model Definitions

Role Definition

Attribute Type Required Description
id int For Updates Record's primary ID.
organizationId int Yes ID of the organization that the role belongs to. Must be greater than zero.
name string Yes Name of the role. Must be 50 or fewer characters in length.
description string No User defined description of the role. Must be 200 or fewer characters in length.

MachineAccessResponse Definition

Attribute Type Description
roleName string Always null; a role name is never populated on this response.
roleId int The ID of the role. Only populated for machines whose organization uses role restrictions; otherwise 0.
prose string The PROSE of the machine. Will be null if a machine ID (rather than PROSE) was specified.
machineId int The ID of the machine. Always present.
canAccess bool Indicates whether the role has access to the machine.
Attribute Type Description
roleId int The role's ID.
machineId int The machine's ID.
createdAt DateTime? The DateTime the RoleToMachineLink was created at.