cyphermed.models

Contains all the data models used in inputs/outputs

class AccountGroupAccessList:

List of group access granted to current account

Attributes: group_access (Union[Unset, List['AccountGroupAccessSchema']]): group_ids (Union[Unset, List[str]]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

AccountGroupAccessList( group_access: Optional[List[AccountGroupAccessSchema]] = None, group_ids: Optional[List[str]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class AccountGroupAccessList.

group_access: Optional[List[AccountGroupAccessSchema]]
group_ids: Optional[List[str]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AccountGroupAccessSchema:

Group access schema plus some info about the group

Attributes: is_delete_protected (bool): This must be set false before the access can be deleted created_date (datetime.datetime): Date and time the access was created can_read (bool): If true, the account can read this access can_update (bool): If true, the account can update this access user_permissions (CRUDPermissions): Collection of CRUD permissions device_permissions (CRUDPermissions): Collection of CRUD permissions tags (List[str]): List of tags on this access object group_id (str): ID of the group that has access grantee_id (str): ID of the account that has access is_admin (bool): If true, the account has admin access role_permissions (CRUDPermissions): Collection of CRUD permissions is_active (bool): If false, all group access operations are disabled data_paths (AccountGroupAccessSchemaDataPaths): Dictionary of accessible data paths file_paths (AccountGroupAccessSchemaFilePaths): Dictionary of accessible file paths group_name (str): group_description (str): group_tags (List[str]): last_updated_date (Union[Unset, datetime.datetime]): Date and time the access was last updated created_by (Union[Unset, str]): ID of the account that created this access last_updated_by (Union[Unset, str]): ID of the account that last updated this access

AccountGroupAccessSchema( is_delete_protected: bool, created_date: datetime.datetime, can_read: bool, can_update: bool, user_permissions: CRUDPermissions, device_permissions: CRUDPermissions, tags: List[str], group_id: str, grantee_id: str, is_admin: bool, role_permissions: CRUDPermissions, is_active: bool, data_paths: AccountGroupAccessSchemaDataPaths, file_paths: AccountGroupAccessSchemaFilePaths, group_name: str, group_description: str, group_tags: List[str], last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None)

Method generated by attrs for class AccountGroupAccessSchema.

is_delete_protected: bool
created_date: datetime.datetime
can_read: bool
can_update: bool
user_permissions: CRUDPermissions
device_permissions: CRUDPermissions
tags: List[str]
group_id: str
grantee_id: str
is_admin: bool
role_permissions: CRUDPermissions
is_active: bool
group_name: str
group_description: str
group_tags: List[str]
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
last_updated_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AccountGroupAccessSchemaDataPaths:

Dictionary of accessible data paths

AccountGroupAccessSchemaDataPaths()

Method generated by attrs for class AccountGroupAccessSchemaDataPaths.

additional_properties: Dict[str, WRUDPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AccountGroupAccessSchemaFilePaths:

Dictionary of accessible file paths

AccountGroupAccessSchemaFilePaths()

Method generated by attrs for class AccountGroupAccessSchemaFilePaths.

additional_properties: Dict[str, WRUDPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AccountOrgAccessInfo:

Organization access info

Attributes: org_access (OrgAccessSchema): Access for an organization

AccountOrgAccessInfo(org_access: OrgAccessSchema)

Method generated by attrs for class AccountOrgAccessInfo.

org_access: OrgAccessSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AccountProjectAccessList:

List of project access granted to current account

Attributes: project_access (Union[Unset, List['AccountProjectAccessSchema']]): project_ids (Union[Unset, List[str]]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

AccountProjectAccessList( project_access: Optional[List[AccountProjectAccessSchema]] = None, project_ids: Optional[List[str]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class AccountProjectAccessList.

project_access: Optional[List[AccountProjectAccessSchema]]
project_ids: Optional[List[str]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AccountProjectAccessSchema:

Project access schema plus some info about the project

Attributes: is_delete_protected (bool): This must be set false before the access can be deleted created_date (datetime.datetime): Date and time the access was created can_read (bool): If true, the account can read this access can_update (bool): If true, the account can update this access user_permissions (CRUDPermissions): Collection of CRUD permissions device_permissions (CRUDPermissions): Collection of CRUD permissions tags (List[str]): List of tags on this access object project_id (str): ID of the project grantee_id (str): ID of the account that has access to the project is_admin (bool): If true, the account has admin access to the project group_permissions (CRUDPermissions): Collection of CRUD permissions role_permissions (CRUDPermissions): Collection of CRUD permissions is_active (bool): If false, all project operations are disabled project_name (str): project_description (str): project_tags (List[str]): last_updated_date (Union[Unset, datetime.datetime]): Date and time the access was last updated created_by (Union[Unset, str]): ID of the account that created this access last_updated_by (Union[Unset, str]): ID of the account that last updated this access

AccountProjectAccessSchema( is_delete_protected: bool, created_date: datetime.datetime, can_read: bool, can_update: bool, user_permissions: CRUDPermissions, device_permissions: CRUDPermissions, tags: List[str], project_id: str, grantee_id: str, is_admin: bool, group_permissions: CRUDPermissions, role_permissions: CRUDPermissions, is_active: bool, project_name: str, project_description: str, project_tags: List[str], last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None)

Method generated by attrs for class AccountProjectAccessSchema.

is_delete_protected: bool
created_date: datetime.datetime
can_read: bool
can_update: bool
user_permissions: CRUDPermissions
device_permissions: CRUDPermissions
tags: List[str]
project_id: str
grantee_id: str
is_admin: bool
group_permissions: CRUDPermissions
role_permissions: CRUDPermissions
is_active: bool
project_name: str
project_description: str
project_tags: List[str]
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
last_updated_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminDeviceInfo:

Attributes: device (AdminDeviceSchema): Which Device fields to include in response bodies

AdminDeviceInfo(device: AdminDeviceSchema)

Method generated by attrs for class AdminDeviceInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminDeviceList:

Attributes: devices (Union[Unset, List['AdminDeviceSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

AdminDeviceList( devices: Optional[List[AdminDeviceSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class AdminDeviceList.

devices: Optional[List[AdminDeviceSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminDeviceSchema:

Which Device fields to include in response bodies

Attributes: name (str): locale (str): zoneinfo (str): id (str): ID of the account created_date (datetime.datetime): UTC datetime the account was created tags (List[str]): Tags for this device open_tunnels (List['Tunnel']): List of open tunnels to this device custom_attributes (AdminDeviceSchemaCustomAttributes): Custom attributes for this device restricted_custom_attributes (AdminDeviceSchemaRestrictedCustomAttributes): Custom attributes only admins can update iot_scopes (AdminDeviceSchemaIotScopes): PubSub permissions per IoT scope for this device is_active (bool): Is this account active? is_delete_protected (Union[Unset, bool]): Default: False. manufacturer (Union[Unset, str]): product (Union[Unset, str]): site (Union[Unset, str]): serial_number (Union[Unset, str]): mac_address (Union[Unset, str]): is_org_admin (Union[Unset, bool]): Default: False. picture (Union[Unset, str]): picture_base64 (Union[Unset, str]): picture_content_type (Union[Unset, str]): project_id (Union[Unset, str]): ID of the project this group belongs to, if any is_project_admin (Union[Unset, bool]): Whether this user is a project admin, only visible in project scope is_group_admin (Union[Unset, bool]): Whether this user is a group admin, only visible when filtered by group created_by (Union[Unset, str]): ID of the user who created this account last_updated_by (Union[Unset, str]): ID of the user who last updated this account last_updated_date (Union[Unset, datetime.datetime]): UTC datetime the account was last updated api_key_last_changed (Union[Unset, datetime.datetime]): UTC datetime the API key was last changed mqtt_credentials_last_changed (Union[Unset, datetime.datetime]): UTC datetime the MQTT credentials were last changed last_seen (Union[Unset, datetime.datetime]): UTC datetime the device was last seen owner_id (Union[Unset, str]): ID of the device owner project_ids (Union[Unset, List[str]]): Projects they belong to, individual devices only group_ids (Union[Unset, List[str]]): Groups they belong to, individual devices only role_ids (Union[Unset, List[str]]): Roles they belong to, individual devices only project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access

AdminDeviceSchema( name: str, locale: str, zoneinfo: str, id: str, created_date: datetime.datetime, tags: List[str], open_tunnels: List[Tunnel], custom_attributes: AdminDeviceSchemaCustomAttributes, restricted_custom_attributes: AdminDeviceSchemaRestrictedCustomAttributes, iot_scopes: AdminDeviceSchemaIotScopes, is_active: bool, is_delete_protected: Optional[bool] = False, manufacturer: Optional[str] = None, product: Optional[str] = None, site: Optional[str] = None, serial_number: Optional[str] = None, mac_address: Optional[str] = None, is_org_admin: Optional[bool] = False, picture: Optional[str] = None, picture_base64: Optional[str] = None, picture_content_type: Optional[str] = None, project_id: Optional[str] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, last_updated_date: Optional[datetime.datetime] = None, api_key_last_changed: Optional[datetime.datetime] = None, mqtt_credentials_last_changed: Optional[datetime.datetime] = None, last_seen: Optional[datetime.datetime] = None, owner_id: Optional[str] = None, project_ids: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, role_ids: Optional[List[str]] = None, project_permissions: Optional[ProjectAccessPermissions] = None, org_permissions: Optional[OrgAccessPermissions] = None)

Method generated by attrs for class AdminDeviceSchema.

name: str
locale: str
zoneinfo: str
id: str
created_date: datetime.datetime
tags: List[str]
open_tunnels: List[Tunnel]
restricted_custom_attributes: AdminDeviceSchemaRestrictedCustomAttributes
is_active: bool
is_delete_protected: Optional[bool]
manufacturer: Optional[str]
product: Optional[str]
site: Optional[str]
serial_number: Optional[str]
mac_address: Optional[str]
is_org_admin: Optional[bool]
picture: Optional[str]
picture_base64: Optional[str]
picture_content_type: Optional[str]
project_id: Optional[str]
is_project_admin: Optional[bool]
is_group_admin: Optional[bool]
created_by: Optional[str]
last_updated_by: Optional[str]
last_updated_date: Optional[datetime.datetime]
api_key_last_changed: Optional[datetime.datetime]
mqtt_credentials_last_changed: Optional[datetime.datetime]
last_seen: Optional[datetime.datetime]
owner_id: Optional[str]
project_ids: Optional[List[str]]
group_ids: Optional[List[str]]
role_ids: Optional[List[str]]
project_permissions: Optional[ProjectAccessPermissions]
org_permissions: Optional[OrgAccessPermissions]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminDeviceSchemaCustomAttributes:

Custom attributes for this device

AdminDeviceSchemaCustomAttributes()

Method generated by attrs for class AdminDeviceSchemaCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminDeviceSchemaIotScopes:

PubSub permissions per IoT scope for this device

AdminDeviceSchemaIotScopes()

Method generated by attrs for class AdminDeviceSchemaIotScopes.

additional_properties: Dict[str, PubSubPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminDeviceSchemaRestrictedCustomAttributes:

Custom attributes only admins can update

AdminDeviceSchemaRestrictedCustomAttributes()

Method generated by attrs for class AdminDeviceSchemaRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminGroupAccessInfo:

Access for a group

Attributes: group_access (AdminGroupAccessSchema): Access for a group plus admin-only fields

AdminGroupAccessInfo( group_access: AdminGroupAccessSchema)

Method generated by attrs for class AdminGroupAccessInfo.

group_access: AdminGroupAccessSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminGroupAccessSchema:

Access for a group plus admin-only fields

Attributes: is_delete_protected (bool): This must be set false before the access can be deleted created_date (datetime.datetime): Date and time the access was created can_read (bool): If true, the account can read this access can_update (bool): If true, the account can update this access user_permissions (CRUDPermissions): Collection of CRUD permissions device_permissions (CRUDPermissions): Collection of CRUD permissions tags (List[str]): List of tags on this access object group_id (str): ID of the group that has access grantee_id (str): ID of the account that has access is_admin (bool): If true, the account has admin access role_permissions (CRUDPermissions): Collection of CRUD permissions is_active (bool): If false, all group access operations are disabled data_paths (AdminGroupAccessSchemaDataPaths): Dictionary of accessible data paths file_paths (AdminGroupAccessSchemaFilePaths): Dictionary of accessible file paths last_updated_date (Union[Unset, datetime.datetime]): Date and time the access was last updated created_by (Union[Unset, str]): ID of the account that created this access last_updated_by (Union[Unset, str]): ID of the account that last updated this access

AdminGroupAccessSchema( is_delete_protected: bool, created_date: datetime.datetime, can_read: bool, can_update: bool, user_permissions: CRUDPermissions, device_permissions: CRUDPermissions, tags: List[str], group_id: str, grantee_id: str, is_admin: bool, role_permissions: CRUDPermissions, is_active: bool, data_paths: AdminGroupAccessSchemaDataPaths, file_paths: AdminGroupAccessSchemaFilePaths, last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None)

Method generated by attrs for class AdminGroupAccessSchema.

is_delete_protected: bool
created_date: datetime.datetime
can_read: bool
can_update: bool
user_permissions: CRUDPermissions
device_permissions: CRUDPermissions
tags: List[str]
group_id: str
grantee_id: str
is_admin: bool
role_permissions: CRUDPermissions
is_active: bool
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
last_updated_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminGroupAccessSchemaDataPaths:

Dictionary of accessible data paths

AdminGroupAccessSchemaDataPaths()

Method generated by attrs for class AdminGroupAccessSchemaDataPaths.

additional_properties: Dict[str, WRUDPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminGroupAccessSchemaFilePaths:

Dictionary of accessible file paths

AdminGroupAccessSchemaFilePaths()

Method generated by attrs for class AdminGroupAccessSchemaFilePaths.

additional_properties: Dict[str, WRUDPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminGroupInfo:

Info on one specific group

Attributes: group (AdminGroupSchema): Group schema plus admin-only fields

AdminGroupInfo(group: AdminGroupSchema)

Method generated by attrs for class AdminGroupInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminGroupList:

List of groups

Attributes: groups (Union[Unset, List['AdminGroupSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

AdminGroupList( groups: Optional[List[AdminGroupSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class AdminGroupList.

groups: Optional[List[AdminGroupSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminGroupSchema:

Group schema plus admin-only fields

Attributes: id (str): ID of the group name (str): Name of the group description (str): Description of the group is_delete_protected (bool): This must be set false before the group can be deleted is_active (bool): If false, all group operations are disabled created_date (datetime.datetime): Date and time the group was created last_updated_by (str): ID of the account that last updated the group tags (List[str]): List of tags on this group num_history (int): Number of history entries to keep on rolling list attributes role_delete_protection_on_by_default (bool): If true, new roles attached to this group will have delete protection enabled if not specified at creation require_delete_permission_to_put_data (bool): If true, require delete permission to put data project_id (Union[Unset, str]): ID of the project this group belongs to, if any last_updated_date (Union[Unset, datetime.datetime]): Date and time the group was last updated created_by (Union[Unset, str]): ID of the account that created the group

AdminGroupSchema( id: str, name: str, description: str, is_delete_protected: bool, is_active: bool, created_date: datetime.datetime, last_updated_by: str, tags: List[str], num_history: int, role_delete_protection_on_by_default: bool, require_delete_permission_to_put_data: bool, project_id: Optional[str] = None, last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None)

Method generated by attrs for class AdminGroupSchema.

id: str
name: str
description: str
is_delete_protected: bool
is_active: bool
created_date: datetime.datetime
last_updated_by: str
tags: List[str]
num_history: int
role_delete_protection_on_by_default: bool
require_delete_permission_to_put_data: bool
project_id: Optional[str]
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminProjectAccessInfo:

Info on one specific project access plus admin-only fields

Attributes: project_access (AdminProjectAccessSchema): Project access schema plus admin-only fields

AdminProjectAccessInfo( project_access: AdminProjectAccessSchema)

Method generated by attrs for class AdminProjectAccessInfo.

project_access: AdminProjectAccessSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminProjectAccessSchema:

Project access schema plus admin-only fields

Attributes: is_delete_protected (bool): This must be set false before the access can be deleted created_date (datetime.datetime): Date and time the access was created can_read (bool): If true, the account can read this access can_update (bool): If true, the account can update this access user_permissions (CRUDPermissions): Collection of CRUD permissions device_permissions (CRUDPermissions): Collection of CRUD permissions tags (List[str]): List of tags on this access object project_id (str): ID of the project grantee_id (str): ID of the account that has access to the project is_admin (bool): If true, the account has admin access to the project group_permissions (CRUDPermissions): Collection of CRUD permissions role_permissions (CRUDPermissions): Collection of CRUD permissions is_active (bool): If false, all project operations are disabled last_updated_date (Union[Unset, datetime.datetime]): Date and time the access was last updated created_by (Union[Unset, str]): ID of the account that created this access last_updated_by (Union[Unset, str]): ID of the account that last updated this access

AdminProjectAccessSchema( is_delete_protected: bool, created_date: datetime.datetime, can_read: bool, can_update: bool, user_permissions: CRUDPermissions, device_permissions: CRUDPermissions, tags: List[str], project_id: str, grantee_id: str, is_admin: bool, group_permissions: CRUDPermissions, role_permissions: CRUDPermissions, is_active: bool, last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None)

Method generated by attrs for class AdminProjectAccessSchema.

is_delete_protected: bool
created_date: datetime.datetime
can_read: bool
can_update: bool
user_permissions: CRUDPermissions
device_permissions: CRUDPermissions
tags: List[str]
project_id: str
grantee_id: str
is_admin: bool
group_permissions: CRUDPermissions
role_permissions: CRUDPermissions
is_active: bool
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
last_updated_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminProjectInfo:

Info on one specific project plus admin-only fields

Attributes: project (AdminProjectSchema): Project schema plus admin-only fields

AdminProjectInfo(project: AdminProjectSchema)

Method generated by attrs for class AdminProjectInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminProjectList:

List of projects plus admin-only fields

Attributes: projects (Union[Unset, List['AdminProjectSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

AdminProjectList( projects: Optional[List[AdminProjectSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class AdminProjectList.

projects: Optional[List[AdminProjectSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminProjectSchema:

Project schema plus admin-only fields

Attributes: name (str): is_active (bool): If false, all project operations are disabled created_date (datetime.datetime): id (str): ID of the project tags (List[str]): List of tags on this project ui_config (InterfaceConfig): Configuration for the user interface alias (Union[Unset, str]): description (Union[Unset, str]): Default: ''. allowed_login_fields (Union[Unset, AdminProjectSchemaAllowedLoginFields]): custom_settings (Union[Unset, AdminProjectSchemaCustomSettings]): device_owners_have_admin_access (Union[Unset, bool]): Default: False. device_owners_can_tunnel (Union[Unset, bool]): Default: False. device_creators_are_owners_by_default (Union[Unset, bool]): Default: False. group_delete_protection_on_by_default (Union[Unset, bool]): Default: False. role_delete_protection_on_by_default (Union[Unset, bool]): Default: False. is_delete_protected (Union[Unset, bool]): Default: False. last_updated_date (Union[Unset, datetime.datetime]): default_locale (Union[Unset, str]): default_from_address (Union[Unset, str]): reset_token_expire_hours (Union[Unset, int]): Default: 24. access_token_expire_hours (Union[Unset, int]): Default: 1. refresh_token_expire_hours (Union[Unset, int]): Default: 24. session_expire_mins (Union[Unset, int]): Default: 5. pii_admin_only (Union[Unset, bool]): Default: False. use_legacy_data_and_files_permissions (Union[Unset, bool]): Default: False. groups_require_delete_permission_to_put_data_by_default (Union[Unset, bool]): Default: False.

AdminProjectSchema( name: str, is_active: bool, created_date: datetime.datetime, id: str, tags: List[str], ui_config: InterfaceConfig, alias: Optional[str] = None, description: Optional[str] = '', allowed_login_fields: Optional[AdminProjectSchemaAllowedLoginFields] = None, custom_settings: Optional[AdminProjectSchemaCustomSettings] = None, device_owners_have_admin_access: Optional[bool] = False, device_owners_can_tunnel: Optional[bool] = False, device_creators_are_owners_by_default: Optional[bool] = False, group_delete_protection_on_by_default: Optional[bool] = False, role_delete_protection_on_by_default: Optional[bool] = False, is_delete_protected: Optional[bool] = False, last_updated_date: Optional[datetime.datetime] = None, default_locale: Optional[str] = None, default_from_address: Optional[str] = None, reset_token_expire_hours: Optional[int] = 24, access_token_expire_hours: Optional[int] = 1, refresh_token_expire_hours: Optional[int] = 24, session_expire_mins: Optional[int] = 5, pii_admin_only: Optional[bool] = False, use_legacy_data_and_files_permissions: Optional[bool] = False, groups_require_delete_permission_to_put_data_by_default: Optional[bool] = False)

Method generated by attrs for class AdminProjectSchema.

name: str
is_active: bool
created_date: datetime.datetime
id: str
tags: List[str]
ui_config: InterfaceConfig
alias: Optional[str]
description: Optional[str]
allowed_login_fields: Optional[AdminProjectSchemaAllowedLoginFields]
custom_settings: Optional[AdminProjectSchemaCustomSettings]
device_owners_have_admin_access: Optional[bool]
device_owners_can_tunnel: Optional[bool]
device_creators_are_owners_by_default: Optional[bool]
group_delete_protection_on_by_default: Optional[bool]
role_delete_protection_on_by_default: Optional[bool]
is_delete_protected: Optional[bool]
last_updated_date: Optional[datetime.datetime]
default_locale: Optional[str]
default_from_address: Optional[str]
reset_token_expire_hours: Optional[int]
access_token_expire_hours: Optional[int]
refresh_token_expire_hours: Optional[int]
session_expire_mins: Optional[int]
pii_admin_only: Optional[bool]
use_legacy_data_and_files_permissions: Optional[bool]
groups_require_delete_permission_to_put_data_by_default: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminProjectSchemaAllowedLoginFields:
AdminProjectSchemaAllowedLoginFields()

Method generated by attrs for class AdminProjectSchemaAllowedLoginFields.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminProjectSchemaCustomSettings:
AdminProjectSchemaCustomSettings()

Method generated by attrs for class AdminProjectSchemaCustomSettings.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminRoleAccessInfo:

Info on one specific role access

Attributes: role_access (AdminRoleAccessSchema): Role access schema

AdminRoleAccessInfo( role_access: AdminRoleAccessSchema)

Method generated by attrs for class AdminRoleAccessInfo.

role_access: AdminRoleAccessSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminRoleAccessSchema:

Role access schema

Attributes: is_delete_protected (bool): This must be set false before the access can be deleted created_date (datetime.datetime): Date and time the access was created can_read (bool): If true, the account can read this access can_update (bool): If true, the account can update this access user_permissions (CRUDPermissions): Collection of CRUD permissions device_permissions (CRUDPermissions): Collection of CRUD permissions tags (List[str]): List of tags on this access object role_id (str): ID of the role that has access account_id (str): ID of the account that has access to the role is_active (bool): If false, all role operations are disabled last_updated_date (Union[Unset, datetime.datetime]): Date and time the access was last updated created_by (Union[Unset, str]): ID of the account that created this access last_updated_by (Union[Unset, str]): ID of the account that last updated this access

AdminRoleAccessSchema( is_delete_protected: bool, created_date: datetime.datetime, can_read: bool, can_update: bool, user_permissions: CRUDPermissions, device_permissions: CRUDPermissions, tags: List[str], role_id: str, account_id: str, is_active: bool, last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None)

Method generated by attrs for class AdminRoleAccessSchema.

is_delete_protected: bool
created_date: datetime.datetime
can_read: bool
can_update: bool
user_permissions: CRUDPermissions
device_permissions: CRUDPermissions
tags: List[str]
role_id: str
account_id: str
is_active: bool
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
last_updated_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminRoleInfo:

Info on one specific role

Attributes: role (AdminRoleSchema): Which Role fields to include in response bodies for admins

AdminRoleInfo(role: AdminRoleSchema)

Method generated by attrs for class AdminRoleInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminRoleList:

List of roles

Attributes: roles (Union[Unset, List['AdminRoleSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

AdminRoleList( roles: Optional[List[AdminRoleSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class AdminRoleList.

roles: Optional[List[AdminRoleSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminRoleSchema:

Which Role fields to include in response bodies for admins

Attributes: id (str): ID of the role name (str): Name of the role description (str): Description of the role is_delete_protected (bool): This must be set false before the role can be deleted is_org_admin (bool): Whether this user is an org admin tags (List[str]): Tags for this role created_date (datetime.datetime): UTC datetime the account was created restricted_custom_attributes (AdminRoleSchemaRestrictedCustomAttributes): Custom attributes only admins can update is_active (bool): If false, all role operations are disabled created_by (Union[Unset, str]): ID of the user who created this account last_updated_by (Union[Unset, str]): ID of the user who last updated this account last_updated_date (Union[Unset, datetime.datetime]): UTC datetime the account was last updated project_id (Union[Unset, str]): ID of the project this group belongs to, if any is_project_admin (Union[Unset, bool]): Whether this user is a project admin, only visible in project scope is_group_admin (Union[Unset, bool]): Whether this user is a group admin, only visible when filtered by group custom_attributes (Union[Unset, AdminRoleSchemaCustomAttributes]): Custom attributes for this user project_ids (Union[Unset, List[str]]): Projects they belong to, individual roles only group_ids (Union[Unset, List[str]]): Groups they belong to, individual roles only project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access

AdminRoleSchema( id: str, name: str, description: str, is_delete_protected: bool, is_org_admin: bool, tags: List[str], created_date: datetime.datetime, restricted_custom_attributes: AdminRoleSchemaRestrictedCustomAttributes, is_active: bool, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, last_updated_date: Optional[datetime.datetime] = None, project_id: Optional[str] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None, custom_attributes: Optional[AdminRoleSchemaCustomAttributes] = None, project_ids: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, project_permissions: Optional[ProjectAccessPermissions] = None, org_permissions: Optional[OrgAccessPermissions] = None)

Method generated by attrs for class AdminRoleSchema.

id: str
name: str
description: str
is_delete_protected: bool
is_org_admin: bool
tags: List[str]
created_date: datetime.datetime
restricted_custom_attributes: AdminRoleSchemaRestrictedCustomAttributes
is_active: bool
created_by: Optional[str]
last_updated_by: Optional[str]
last_updated_date: Optional[datetime.datetime]
project_id: Optional[str]
is_project_admin: Optional[bool]
is_group_admin: Optional[bool]
custom_attributes: Optional[AdminRoleSchemaCustomAttributes]
project_ids: Optional[List[str]]
group_ids: Optional[List[str]]
project_permissions: Optional[ProjectAccessPermissions]
org_permissions: Optional[OrgAccessPermissions]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminRoleSchemaCustomAttributes:

Custom attributes for this user

AdminRoleSchemaCustomAttributes()

Method generated by attrs for class AdminRoleSchemaCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminRoleSchemaRestrictedCustomAttributes:

Custom attributes only admins can update

AdminRoleSchemaRestrictedCustomAttributes()

Method generated by attrs for class AdminRoleSchemaRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminUserInfo:

Attributes: user (AdminUserSchema): Which User fields to include in response bodies

AdminUserInfo(user: AdminUserSchema)

Method generated by attrs for class AdminUserInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminUserList:

Attributes: users (Union[Unset, List['AdminUserSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

AdminUserList( users: Optional[List[AdminUserSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class AdminUserList.

users: Optional[List[AdminUserSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminUserSchema:

Which User fields to include in response bodies

Attributes: locale (str): zoneinfo (str): username (str): email (str): new_password_required (bool): State of user not having permanent password has_temporary_password (bool): Whether this user has a temporary password id (str): ID of the account created_date (datetime.datetime): UTC datetime the account was created tags (List[str]): Tags for this user custom_attributes (AdminUserSchemaCustomAttributes): Custom attributes for this user restricted_custom_attributes (AdminUserSchemaRestrictedCustomAttributes): Custom attributes only admins can update mfa_enabled (bool): Whether MFA is enabled for this user sms_mfa_enabled (bool): Whether SMS MFA is enabled for this user software_mfa_enabled (bool): Whether software MFA is enabled for this user is_active (bool): Whether this user is active is_delete_protected (Union[Unset, bool]): Default: False. picture (Union[Unset, str]): picture_base64 (Union[Unset, str]): picture_content_type (Union[Unset, str]): password_last_changed (Union[Unset, datetime.datetime]): UTC datetime the user last changed password phone_number (Union[Unset, str]): phone_number_verified (Union[Unset, bool]): Default: False. nickname (Union[Unset, str]): first_name (Union[Unset, str]): middle_name (Union[Unset, str]): last_name (Union[Unset, str]): is_org_admin (Union[Unset, bool]): Default: False. created_by (Union[Unset, str]): ID of the user who created this account last_updated_by (Union[Unset, str]): ID of the user who last updated this account last_updated_date (Union[Unset, datetime.datetime]): UTC datetime the account was last updated last_seen (Union[Unset, datetime.datetime]): UTC datetime the user was last seen preferred_mfa (Union[Unset, str]): Preferred MFA method for this user is_project_admin (Union[Unset, bool]): Whether this user is a project admin, only visible when filtered by project is_group_admin (Union[Unset, bool]): Whether this user is a group admin, only visible when filtered by group project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access project_ids (Union[Unset, List[str]]): Projects they belong to, individual users only group_ids (Union[Unset, List[str]]): Groups they belong to, individual users only role_ids (Union[Unset, List[str]]): Roles they belong to, individual users only

AdminUserSchema( locale: str, zoneinfo: str, username: str, email: str, new_password_required: bool, has_temporary_password: bool, id: str, created_date: datetime.datetime, tags: List[str], custom_attributes: AdminUserSchemaCustomAttributes, restricted_custom_attributes: AdminUserSchemaRestrictedCustomAttributes, mfa_enabled: bool, sms_mfa_enabled: bool, software_mfa_enabled: bool, is_active: bool, is_delete_protected: Optional[bool] = False, picture: Optional[str] = None, picture_base64: Optional[str] = None, picture_content_type: Optional[str] = None, password_last_changed: Optional[datetime.datetime] = None, phone_number: Optional[str] = None, phone_number_verified: Optional[bool] = False, nickname: Optional[str] = None, first_name: Optional[str] = None, middle_name: Optional[str] = None, last_name: Optional[str] = None, is_org_admin: Optional[bool] = False, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, last_updated_date: Optional[datetime.datetime] = None, last_seen: Optional[datetime.datetime] = None, preferred_mfa: Optional[str] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None, project_permissions: Optional[ProjectAccessPermissions] = None, org_permissions: Optional[OrgAccessPermissions] = None, project_ids: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, role_ids: Optional[List[str]] = None)

Method generated by attrs for class AdminUserSchema.

locale: str
zoneinfo: str
username: str
email: str
new_password_required: bool
has_temporary_password: bool
id: str
created_date: datetime.datetime
tags: List[str]
custom_attributes: AdminUserSchemaCustomAttributes
restricted_custom_attributes: AdminUserSchemaRestrictedCustomAttributes
mfa_enabled: bool
sms_mfa_enabled: bool
software_mfa_enabled: bool
is_active: bool
is_delete_protected: Optional[bool]
picture: Optional[str]
picture_base64: Optional[str]
picture_content_type: Optional[str]
password_last_changed: Optional[datetime.datetime]
phone_number: Optional[str]
phone_number_verified: Optional[bool]
nickname: Optional[str]
first_name: Optional[str]
middle_name: Optional[str]
last_name: Optional[str]
is_org_admin: Optional[bool]
created_by: Optional[str]
last_updated_by: Optional[str]
last_updated_date: Optional[datetime.datetime]
last_seen: Optional[datetime.datetime]
preferred_mfa: Optional[str]
is_project_admin: Optional[bool]
is_group_admin: Optional[bool]
project_permissions: Optional[ProjectAccessPermissions]
org_permissions: Optional[OrgAccessPermissions]
project_ids: Optional[List[str]]
group_ids: Optional[List[str]]
role_ids: Optional[List[str]]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminUserSchemaCustomAttributes:

Custom attributes for this user

AdminUserSchemaCustomAttributes()

Method generated by attrs for class AdminUserSchemaCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AdminUserSchemaRestrictedCustomAttributes:

Custom attributes only admins can update

AdminUserSchemaRestrictedCustomAttributes()

Method generated by attrs for class AdminUserSchemaRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AnonAccountSchema:

Anonymous account base schema

Attributes: username (str): created_date (datetime.datetime): id (str): ID of the account is_delete_protected (Union[Unset, bool]): Default: False. last_updated_date (Union[Unset, datetime.datetime]):

AnonAccountSchema( username: str, created_date: datetime.datetime, id: str, is_delete_protected: Optional[bool] = False, last_updated_date: Optional[datetime.datetime] = None)

Method generated by attrs for class AnonAccountSchema.

username: str
created_date: datetime.datetime
id: str
is_delete_protected: Optional[bool]
last_updated_date: Optional[datetime.datetime]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AnonDeviceInfo:

Info on one specific device

Attributes: device (AnonAccountSchema): Anonymous account base schema

AnonDeviceInfo(device: AnonAccountSchema)

Method generated by attrs for class AnonDeviceInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AnonDeviceList:

List of devices

Attributes: devices (Union[Unset, List['AnonAccountSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

AnonDeviceList( devices: Optional[List[AnonAccountSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class AnonDeviceList.

devices: Optional[List[AnonAccountSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AnonUserInfo:

Info on one specific user

Attributes: user (AnonAccountSchema): Anonymous account base schema

AnonUserInfo(user: AnonAccountSchema)

Method generated by attrs for class AnonUserInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class AnonUserList:

List of users

Attributes: users (Union[Unset, List['AnonAccountSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

AnonUserList( users: Optional[List[AnonAccountSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class AnonUserList.

users: Optional[List[AnonAccountSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class BulkDataBody:

Bulk request body

Attributes: method (str): Method to use for bulk request jobs (List[Union['DeleteDataJob', 'GetDataJob', 'PatchDataJob', 'UploadDataJob']]): Jobs to perform, grouped by group ID, all of the same method

BulkDataBody( method: str, jobs: List[Union[DeleteDataJob, GetDataJob, PatchDataJob, UploadDataJob]])

Method generated by attrs for class BulkDataBody.

method: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class Challenge:

Challenge response schema

Attributes: challenge (str): Challenge code, a unique identifier for the type of challenge message (str): Message to display to the user session (str): Session token to use in the challenge response

Challenge(challenge: str, message: str, session: str)

Method generated by attrs for class Challenge.

challenge: str
message: str
session: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class ClientInterfaceInfo:

Interface configuration for a given client ID

Attributes: allowed_login_fields (List[str]): List of allowed login fields client_id (str): Client ID ui_config (InterfaceConfig): Configuration for the user interface

ClientInterfaceInfo( allowed_login_fields: List[str], client_id: str, ui_config: InterfaceConfig)

Method generated by attrs for class ClientInterfaceInfo.

allowed_login_fields: List[str]
client_id: str
ui_config: InterfaceConfig
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateDeviceBody:

Create a new device

Attributes: name (str): Name of the device is_active (Union[Unset, bool]): (Admin only) Whether this account is active is_delete_protected (Union[Unset, bool]): Whether this account is delete protected locale (Union[Unset, str]): Locale of the account zoneinfo (Union[Unset, str]): Timezone of the account picture (Union[Unset, str]): URL of the account's picture tags (Union[Unset, List[str]]): List of tags on this account project_id (Union[Unset, str]): ID of project to create them in (org admins only) project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access custom_attributes (Union[Unset, CreateDeviceBodyCustomAttributes]): Custom attributes for this user restricted_custom_attributes (Union[Unset, CreateDeviceBodyRestrictedCustomAttributes]): Custom attributes only admins can update owner_id (Union[Unset, str]): ID of the device owner manufacturer (Union[Unset, str]): Device manufacturer product (Union[Unset, str]): Product name site (Union[Unset, str]): Location of this device serial_number (Union[Unset, str]): Device serial number mac_address (Union[Unset, str]): MAC address of this device iot_scopes (Union[Unset, CreateDeviceBodyIotScopes]): PubSub permissions per IoT scope for this device

CreateDeviceBody( name: str, is_active: Optional[bool] = None, is_delete_protected: Optional[bool] = None, locale: Optional[str] = None, zoneinfo: Optional[str] = None, picture: Optional[str] = None, tags: Optional[List[str]] = None, project_id: Optional[str] = None, project_permissions: Optional[ProjectAccessPermissions] = None, org_permissions: Optional[OrgAccessPermissions] = None, custom_attributes: Optional[CreateDeviceBodyCustomAttributes] = None, restricted_custom_attributes: Optional[CreateDeviceBodyRestrictedCustomAttributes] = None, owner_id: Optional[str] = None, manufacturer: Optional[str] = None, product: Optional[str] = None, site: Optional[str] = None, serial_number: Optional[str] = None, mac_address: Optional[str] = None, iot_scopes: Optional[CreateDeviceBodyIotScopes] = None)

Method generated by attrs for class CreateDeviceBody.

name: str
is_active: Optional[bool]
is_delete_protected: Optional[bool]
locale: Optional[str]
zoneinfo: Optional[str]
picture: Optional[str]
tags: Optional[List[str]]
project_id: Optional[str]
project_permissions: Optional[ProjectAccessPermissions]
org_permissions: Optional[OrgAccessPermissions]
custom_attributes: Optional[CreateDeviceBodyCustomAttributes]
restricted_custom_attributes: Optional[CreateDeviceBodyRestrictedCustomAttributes]
owner_id: Optional[str]
manufacturer: Optional[str]
product: Optional[str]
site: Optional[str]
serial_number: Optional[str]
mac_address: Optional[str]
iot_scopes: Optional[CreateDeviceBodyIotScopes]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateDeviceBodyCustomAttributes:

Custom attributes for this user

CreateDeviceBodyCustomAttributes()

Method generated by attrs for class CreateDeviceBodyCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateDeviceBodyIotScopes:

PubSub permissions per IoT scope for this device

CreateDeviceBodyIotScopes()

Method generated by attrs for class CreateDeviceBodyIotScopes.

additional_properties: Dict[str, PubSubPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateDeviceBodyRestrictedCustomAttributes:

Custom attributes only admins can update

CreateDeviceBodyRestrictedCustomAttributes()

Method generated by attrs for class CreateDeviceBodyRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateEmailTemplateBody:

Which Template fields to include in request bodies

Attributes: name (str): Name of the template subject (str): Subject of the template body_txt (str): Plain text body of the template body_html (str): HTML body of the template from_address (Union[Unset, str]): From email address to use with this template description (Union[Unset, str]): Description of the template project_id (Union[Unset, str]): ID of the project this template belongs to, if any is_delete_protected (Union[Unset, bool]): This must be set false before the template can be deleted tags (Union[Unset, List[str]]): List of tags on this template custom_args (Union[Unset, List[str]]): List of custom arguments on this template for_account_recovery (Union[Unset, bool]): If true, the template is used for forgot password emails for_new_users (Union[Unset, bool]): If true, the template is used for new user emails locale (Union[Unset, str]): Locale for the template, defaults to project or org locale

CreateEmailTemplateBody( name: str, subject: str, body_txt: str, body_html: str, from_address: Optional[str] = None, description: Optional[str] = None, project_id: Optional[str] = None, is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, custom_args: Optional[List[str]] = None, for_account_recovery: Optional[bool] = None, for_new_users: Optional[bool] = None, locale: Optional[str] = None)

Method generated by attrs for class CreateEmailTemplateBody.

name: str
subject: str
body_txt: str
body_html: str
from_address: Optional[str]
description: Optional[str]
project_id: Optional[str]
is_delete_protected: Optional[bool]
tags: Optional[List[str]]
custom_args: Optional[List[str]]
for_account_recovery: Optional[bool]
for_new_users: Optional[bool]
locale: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateGroupAccessBody:

Which GroupAccess fields to include in POST request bodies

Attributes: is_delete_protected (Union[Unset, bool]): This must be set false before the access can be deleted tags (Union[Unset, List[str]]): List of tags on this access object user_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions device_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions can_read (Union[Unset, bool]): If true, the grantee can read the target resource can_update (Union[Unset, bool]): If true, the grantee can update the target resource role_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions is_admin (Union[Unset, bool]): If true, the grantee has admin access to the group data_paths (Union[Unset, CreateGroupAccessBodyDataPaths]): Dictionary of accessible data paths and their CRUD permissions file_paths (Union[Unset, CreateGroupAccessBodyFilePaths]): Dictionary of accessible file paths and their CRUD permissions

CreateGroupAccessBody( is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, user_permissions: Optional[CRUDPermissions] = None, device_permissions: Optional[CRUDPermissions] = None, can_read: Optional[bool] = None, can_update: Optional[bool] = None, role_permissions: Optional[CRUDPermissions] = None, is_admin: Optional[bool] = None, data_paths: Optional[CreateGroupAccessBodyDataPaths] = None, file_paths: Optional[CreateGroupAccessBodyFilePaths] = None)

Method generated by attrs for class CreateGroupAccessBody.

is_delete_protected: Optional[bool]
tags: Optional[List[str]]
user_permissions: Optional[CRUDPermissions]
device_permissions: Optional[CRUDPermissions]
can_read: Optional[bool]
can_update: Optional[bool]
role_permissions: Optional[CRUDPermissions]
is_admin: Optional[bool]
data_paths: Optional[CreateGroupAccessBodyDataPaths]
file_paths: Optional[CreateGroupAccessBodyFilePaths]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateGroupAccessBodyDataPaths:

Dictionary of accessible data paths and their CRUD permissions

CreateGroupAccessBodyDataPaths()

Method generated by attrs for class CreateGroupAccessBodyDataPaths.

additional_properties: Dict[str, WRUDPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateGroupAccessBodyFilePaths:

Dictionary of accessible file paths and their CRUD permissions

CreateGroupAccessBodyFilePaths()

Method generated by attrs for class CreateGroupAccessBodyFilePaths.

additional_properties: Dict[str, WRUDPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateGroupBody:

Which Group fields to include in request bodies

Attributes: name (str): Name of the group description (Union[Unset, str]): Description of the group is_delete_protected (Union[Unset, bool]): This must be set false before the group can be deleted tags (Union[Unset, List[str]]): List of tags on this group require_delete_permission_to_put_data (Union[Unset, bool]): (Admin only) If true, require delete permission to put data project_id (Union[Unset, str]): ID of the project this group belongs to, if any create_own_access (Union[Unset, bool]): If true, full access to the group is automatically created for the requester Default: True.

CreateGroupBody( name: str, description: Optional[str] = None, is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, require_delete_permission_to_put_data: Optional[bool] = None, project_id: Optional[str] = None, create_own_access: Optional[bool] = True)

Method generated by attrs for class CreateGroupBody.

name: str
description: Optional[str]
is_delete_protected: Optional[bool]
tags: Optional[List[str]]
require_delete_permission_to_put_data: Optional[bool]
project_id: Optional[str]
create_own_access: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateProjectAccessBody:

Which ProjectAccess fields to include in PATCH request bodies

Attributes: is_delete_protected (Union[Unset, bool]): This must be set false before the access can be deleted tags (Union[Unset, List[str]]): List of tags on this access object user_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions device_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions can_read (Union[Unset, bool]): If true, the grantee can read the target resource can_update (Union[Unset, bool]): If true, the grantee can update the target resource group_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions role_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions is_admin (Union[Unset, bool]): If true, the grantee has admin access to the project

CreateProjectAccessBody( is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, user_permissions: Optional[CRUDPermissions] = None, device_permissions: Optional[CRUDPermissions] = None, can_read: Optional[bool] = None, can_update: Optional[bool] = None, group_permissions: Optional[CRUDPermissions] = None, role_permissions: Optional[CRUDPermissions] = None, is_admin: Optional[bool] = None)

Method generated by attrs for class CreateProjectAccessBody.

is_delete_protected: Optional[bool]
tags: Optional[List[str]]
user_permissions: Optional[CRUDPermissions]
device_permissions: Optional[CRUDPermissions]
can_read: Optional[bool]
can_update: Optional[bool]
group_permissions: Optional[CRUDPermissions]
role_permissions: Optional[CRUDPermissions]
is_admin: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateProjectBody:

Create project body

Attributes: name (str): Name of the project alias (Union[Unset, str]): Unique alias for the project description (Union[Unset, str]): Description of the project is_delete_protected (Union[Unset, bool]): Must be false before the project can be deleted tags (Union[Unset, List[str]]): List of tags on this project reset_token_expire_hours (Union[Unset, int]): Number of hours reset tokens are valid (1-168) group_delete_protection_on_by_default (Union[Unset, bool]): If true, groups are delete-protected by default role_delete_protection_on_by_default (Union[Unset, bool]): If true, roles are delete-protected by default access_token_expire_hours (Union[Unset, int]): Number of hours access tokens are valid (1-24) refresh_token_expire_hours (Union[Unset, int]): Number of hours refresh tokens are valid (1-8760) session_expire_mins (Union[Unset, int]): Number of mins sessions are valid (3-15) ui_config (Union[Unset, InterfaceConfig]): Configuration for the user interface use_legacy_data_and_files_permissions (Union[Unset, bool]): If true, use legacy data and files permissions groups_require_delete_permission_to_put_data_by_default (Union[Unset, bool]): If true, groups require delete permission to delete data by default allowed_login_fields (Union[Unset, List[str]]): Allowed login fields default_locale (Union[Unset, str]): Default locale for the organization Default: 'en-US'. default_from_address (Union[Unset, str]): Default from address Default: 'noreply@cyphermed.cloud'. create_own_access (Union[Unset, bool]): If true, full access to the project is automatically created for the requester Default: True.

CreateProjectBody( name: str, alias: Optional[str] = None, description: Optional[str] = None, is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, reset_token_expire_hours: Optional[int] = None, group_delete_protection_on_by_default: Optional[bool] = None, role_delete_protection_on_by_default: Optional[bool] = None, access_token_expire_hours: Optional[int] = None, refresh_token_expire_hours: Optional[int] = None, session_expire_mins: Optional[int] = None, ui_config: Optional[InterfaceConfig] = None, use_legacy_data_and_files_permissions: Optional[bool] = None, groups_require_delete_permission_to_put_data_by_default: Optional[bool] = None, allowed_login_fields: Optional[List[str]] = None, default_locale: Optional[str] = 'en-US', default_from_address: Optional[str] = 'noreply@cyphermed.cloud', create_own_access: Optional[bool] = True)

Method generated by attrs for class CreateProjectBody.

name: str
alias: Optional[str]
description: Optional[str]
is_delete_protected: Optional[bool]
tags: Optional[List[str]]
reset_token_expire_hours: Optional[int]
group_delete_protection_on_by_default: Optional[bool]
role_delete_protection_on_by_default: Optional[bool]
access_token_expire_hours: Optional[int]
refresh_token_expire_hours: Optional[int]
session_expire_mins: Optional[int]
ui_config: Optional[InterfaceConfig]
use_legacy_data_and_files_permissions: Optional[bool]
groups_require_delete_permission_to_put_data_by_default: Optional[bool]
allowed_login_fields: Optional[List[str]]
default_locale: Optional[str]
default_from_address: Optional[str]
create_own_access: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateRoleAccessBody:

Body for POST /roles/{id}/access

Attributes: is_delete_protected (Union[Unset, bool]): This must be set false before the access can be deleted tags (Union[Unset, List[str]]): List of tags on this access object user_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions device_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions can_read (Union[Unset, bool]): If true, the grantee can read the target resource can_update (Union[Unset, bool]): If true, the grantee can update the target resource

CreateRoleAccessBody( is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, user_permissions: Optional[CRUDPermissions] = None, device_permissions: Optional[CRUDPermissions] = None, can_read: Optional[bool] = None, can_update: Optional[bool] = None)

Method generated by attrs for class CreateRoleAccessBody.

is_delete_protected: Optional[bool]
tags: Optional[List[str]]
user_permissions: Optional[CRUDPermissions]
device_permissions: Optional[CRUDPermissions]
can_read: Optional[bool]
can_update: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateRoleBody:

Which Role fields to include in request bodies

Attributes: name (str): Name of the role description (Union[Unset, str]): Description of the role is_delete_protected (Union[Unset, bool]): This must be set false before the role can be deleted tags (Union[Unset, List[str]]): List of tags on this role org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access custom_attributes (Union[Unset, CreateRoleBodyCustomAttributes]): Custom attributes for this user restricted_custom_attributes (Union[Unset, CreateRoleBodyRestrictedCustomAttributes]): Custom attributes only admins can update project_id (Union[Unset, str]): ID of the project the role is linked with, if any create_own_access (Union[Unset, bool]): If true, full access to the role is automatically created for the requester Default: False.

CreateRoleBody( name: str, description: Optional[str] = None, is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, org_permissions: Optional[OrgAccessPermissions] = None, project_permissions: Optional[ProjectAccessPermissions] = None, custom_attributes: Optional[CreateRoleBodyCustomAttributes] = None, restricted_custom_attributes: Optional[CreateRoleBodyRestrictedCustomAttributes] = None, project_id: Optional[str] = None, create_own_access: Optional[bool] = False)

Method generated by attrs for class CreateRoleBody.

name: str
description: Optional[str]
is_delete_protected: Optional[bool]
tags: Optional[List[str]]
org_permissions: Optional[OrgAccessPermissions]
project_permissions: Optional[ProjectAccessPermissions]
custom_attributes: Optional[CreateRoleBodyCustomAttributes]
restricted_custom_attributes: Optional[CreateRoleBodyRestrictedCustomAttributes]
project_id: Optional[str]
create_own_access: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateRoleBodyCustomAttributes:

Custom attributes for this user

CreateRoleBodyCustomAttributes()

Method generated by attrs for class CreateRoleBodyCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateRoleBodyRestrictedCustomAttributes:

Custom attributes only admins can update

CreateRoleBodyRestrictedCustomAttributes()

Method generated by attrs for class CreateRoleBodyRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateTunnelBody:

Create a new tunnel

Attributes: services (List[str]): List of services to expose timeout (Union[Unset, int]): Tunnel timeout in minutes, default 1 hour, max 12 hours Default: 60. sendto_user_id (Union[Unset, str]): User who's email will receive tunnel info

CreateTunnelBody( services: List[str], timeout: Optional[int] = 60, sendto_user_id: Optional[str] = None)

Method generated by attrs for class CreateTunnelBody.

services: List[str]
timeout: Optional[int]
sendto_user_id: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateUserBody:

Request payload for POST /users

Attributes: email (str): Email of the user is_active (Union[Unset, bool]): (Admin only) Whether this account is active is_delete_protected (Union[Unset, bool]): Whether this account is delete protected locale (Union[Unset, str]): Locale of the account zoneinfo (Union[Unset, str]): Timezone of the account picture (Union[Unset, str]): URL of the account's picture tags (Union[Unset, List[str]]): List of tags on this account project_id (Union[Unset, str]): ID of project to create them in (org admins only) project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access custom_attributes (Union[Unset, CreateUserBodyCustomAttributes]): Custom attributes for this user restricted_custom_attributes (Union[Unset, CreateUserBodyRestrictedCustomAttributes]): Custom attributes only admins can update username (Union[Unset, str]): Username of the user phone_number (Union[Unset, str]): Phone number of the user password (Union[Unset, str]): Password of the user temp_password (Union[Unset, str]): Temporary password nickname (Union[Unset, str]): Nickname of the user first_name (Union[Unset, str]): First (or given) name of the user middle_name (Union[Unset, str]): Middle name of the user last_name (Union[Unset, str]): Last (or family) name of the user

CreateUserBody( email: str, is_active: Optional[bool] = None, is_delete_protected: Optional[bool] = None, locale: Optional[str] = None, zoneinfo: Optional[str] = None, picture: Optional[str] = None, tags: Optional[List[str]] = None, project_id: Optional[str] = None, project_permissions: Optional[ProjectAccessPermissions] = None, org_permissions: Optional[OrgAccessPermissions] = None, custom_attributes: Optional[CreateUserBodyCustomAttributes] = None, restricted_custom_attributes: Optional[CreateUserBodyRestrictedCustomAttributes] = None, username: Optional[str] = None, phone_number: Optional[str] = None, password: Optional[str] = None, temp_password: Optional[str] = None, nickname: Optional[str] = None, first_name: Optional[str] = None, middle_name: Optional[str] = None, last_name: Optional[str] = None)

Method generated by attrs for class CreateUserBody.

email: str
is_active: Optional[bool]
is_delete_protected: Optional[bool]
locale: Optional[str]
zoneinfo: Optional[str]
picture: Optional[str]
tags: Optional[List[str]]
project_id: Optional[str]
project_permissions: Optional[ProjectAccessPermissions]
org_permissions: Optional[OrgAccessPermissions]
custom_attributes: Optional[CreateUserBodyCustomAttributes]
restricted_custom_attributes: Optional[CreateUserBodyRestrictedCustomAttributes]
username: Optional[str]
phone_number: Optional[str]
password: Optional[str]
temp_password: Optional[str]
nickname: Optional[str]
first_name: Optional[str]
middle_name: Optional[str]
last_name: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateUserBodyCustomAttributes:

Custom attributes for this user

CreateUserBodyCustomAttributes()

Method generated by attrs for class CreateUserBodyCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CreateUserBodyRestrictedCustomAttributes:

Custom attributes only admins can update

CreateUserBodyRestrictedCustomAttributes()

Method generated by attrs for class CreateUserBodyRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CRUDPermissions:

Collection of CRUD permissions

Attributes: can_create (Union[Unset, bool]): Default: False. can_read (Union[Unset, bool]): Default: False. can_update (Union[Unset, bool]): Default: False. can_delete (Union[Unset, bool]): Default: False.

CRUDPermissions( can_create: Optional[bool] = False, can_read: Optional[bool] = False, can_update: Optional[bool] = False, can_delete: Optional[bool] = False)

Method generated by attrs for class CRUDPermissions.

can_create: Optional[bool]
can_read: Optional[bool]
can_update: Optional[bool]
can_delete: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class CurrentSessionAccessInfo:

Current session access info

Attributes: org_permissions (OrgAccessPermissions): Collection of permissions for org access project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access

CurrentSessionAccessInfo( org_permissions: OrgAccessPermissions, project_permissions: Optional[ProjectAccessPermissions] = None)

Method generated by attrs for class CurrentSessionAccessInfo.

org_permissions: OrgAccessPermissions
project_permissions: Optional[ProjectAccessPermissions]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class SetAccountPictureFileParams:

Attributes: file (File):

SetAccountPictureFileParams(file: cyphermed.types.File)

Method generated by attrs for class SetAccountPictureFileParams.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
def to_multipart(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DisableSmsMfaFormParams:

Attributes: client_id (Union[Unset, str]): Client ID username (Union[Unset, str]): Username email (Union[Unset, str]): Email phone_number (Union[Unset, str]): Phone number recovery_code (Union[Unset, str]): SMS MFA recovery code

DisableSmsMfaFormParams( client_id: Optional[str] = None, username: Optional[str] = None, email: Optional[str] = None, phone_number: Optional[str] = None, recovery_code: Optional[str] = None)

Method generated by attrs for class DisableSmsMfaFormParams.

client_id: Optional[str]
username: Optional[str]
email: Optional[str]
phone_number: Optional[str]
recovery_code: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DisableSoftwareMfaFormParams:

Attributes: client_id (Union[Unset, str]): Client ID username (Union[Unset, str]): Username email (Union[Unset, str]): Email phone_number (Union[Unset, str]): Phone number recovery_code (Union[Unset, str]): Software MFA recovery code

DisableSoftwareMfaFormParams( client_id: Optional[str] = None, username: Optional[str] = None, email: Optional[str] = None, phone_number: Optional[str] = None, recovery_code: Optional[str] = None)

Method generated by attrs for class DisableSoftwareMfaFormParams.

client_id: Optional[str]
username: Optional[str]
email: Optional[str]
phone_number: Optional[str]
recovery_code: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class EnableSmsMfaFormParams:

Attributes: phone_number (str): Phone number client_id (Union[Unset, str]): Client ID username (Union[Unset, str]): Username email (Union[Unset, str]): Email set_preferred (Union[Unset, bool]): Set as preferred MFA device recovery_code (Union[Unset, str]): MFA recovery code

EnableSmsMfaFormParams( phone_number: str, client_id: Optional[str] = None, username: Optional[str] = None, email: Optional[str] = None, set_preferred: Optional[bool] = None, recovery_code: Optional[str] = None)

Method generated by attrs for class EnableSmsMfaFormParams.

phone_number: str
client_id: Optional[str]
username: Optional[str]
email: Optional[str]
set_preferred: Optional[bool]
recovery_code: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class EnableSoftwareMfaFormParams:

Attributes: client_id (str): Client ID mfa_code (str): MFA code generated using the secret code username (Union[Unset, str]): Username email (Union[Unset, str]): Email phone_number (Union[Unset, str]): Phone number set_preferred (Union[Unset, bool]): Set as preferred MFA device

EnableSoftwareMfaFormParams( client_id: str, mfa_code: str, username: Optional[str] = None, email: Optional[str] = None, phone_number: Optional[str] = None, set_preferred: Optional[bool] = None)

Method generated by attrs for class EnableSoftwareMfaFormParams.

client_id: str
mfa_code: str
username: Optional[str]
email: Optional[str]
phone_number: Optional[str]
set_preferred: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class ForgotPasswordFormParams:

Attributes: client_id (str): Client ID username (Union[Unset, str]): Username email (Union[Unset, str]): Email phone_number (Union[Unset, str]): Phone number

ForgotPasswordFormParams( client_id: str, username: Optional[str] = None, email: Optional[str] = None, phone_number: Optional[str] = None)

Method generated by attrs for class ForgotPasswordFormParams.

client_id: str
username: Optional[str]
email: Optional[str]
phone_number: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class LoginFormParams:

Attributes: grant_type (str): Grant type client_id (Union[Unset, str]): Client ID username (Union[Unset, str]): Username email (Union[Unset, str]): Email phone_number (Union[Unset, str]): Phone number refresh_token (Union[Unset, str]): Refresh token scope (Union[Unset, str]): Scope password (Union[Unset, str]): Password mfa_code (Union[Unset, str]): Software MFA code

LoginFormParams( grant_type: str, client_id: Optional[str] = None, username: Optional[str] = None, email: Optional[str] = None, phone_number: Optional[str] = None, refresh_token: Optional[str] = None, scope: Optional[str] = None, password: Optional[str] = None, mfa_code: Optional[str] = None)

Method generated by attrs for class LoginFormParams.

grant_type: str
client_id: Optional[str]
username: Optional[str]
email: Optional[str]
phone_number: Optional[str]
refresh_token: Optional[str]
scope: Optional[str]
password: Optional[str]
mfa_code: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class LogoutFormParams:

Attributes: refresh_token (Union[Unset, str]): Refresh token

LogoutFormParams(refresh_token: Optional[str] = None)

Method generated by attrs for class LogoutFormParams.

refresh_token: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchMfaSettingsFormParams:

Attributes: preferred_mfa (str): Preferred MFA device

PatchMfaSettingsFormParams(preferred_mfa: str)

Method generated by attrs for class PatchMfaSettingsFormParams.

preferred_mfa: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RespondToChallengeFormParams:

Attributes: client_id (str): Client ID challenge (str): Challenge username (Union[Unset, str]): Username email (Union[Unset, str]): Email phone_number (Union[Unset, str]): Phone number scope (Union[Unset, str]): (Staff Only) Scope mfa_choice (Union[Unset, str]): MFA choice: software or sms mfa_code (Union[Unset, str]): MFA code new_password (Union[Unset, str]): New password

RespondToChallengeFormParams( client_id: str, challenge: str, username: Optional[str] = None, email: Optional[str] = None, phone_number: Optional[str] = None, scope: Optional[str] = None, mfa_choice: Optional[str] = None, mfa_code: Optional[str] = None, new_password: Optional[str] = None)

Method generated by attrs for class RespondToChallengeFormParams.

client_id: str
challenge: str
username: Optional[str]
email: Optional[str]
phone_number: Optional[str]
scope: Optional[str]
mfa_choice: Optional[str]
mfa_code: Optional[str]
new_password: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class SetPasswordFormParams:

Attributes: new_password (str): New password old_password (Union[Unset, str]): Old password

SetPasswordFormParams(new_password: str, old_password: Optional[str] = None)

Method generated by attrs for class SetPasswordFormParams.

new_password: str
old_password: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class GetJsonDataLastEvaluatedKeyType0:
GetJsonDataLastEvaluatedKeyType0()

Method generated by attrs for class GetJsonDataLastEvaluatedKeyType0.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class GetFilesDataLastEvaluatedKeyType0:
GetFilesDataLastEvaluatedKeyType0()

Method generated by attrs for class GetFilesDataLastEvaluatedKeyType0.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DashboardConfig:

Configuration for the dashboard homepage

Attributes: widgets (List['WidgetInfo']): List of widgets to display on the dashboard

DashboardConfig(widgets: List[WidgetInfo])

Method generated by attrs for class DashboardConfig.

widgets: List[WidgetInfo]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DataAtPath:

List of group data

Attributes: paths (Union[Unset, List[str]]): object_count (Union[Unset, int]): last_evaluated_key (Union[Unset, DataAtPathLastEvaluatedKey]): data (Union['DataSchema', List['DataSchema'], Unset]):

DataAtPath( paths: Optional[List[str]] = None, object_count: Optional[int] = None, last_evaluated_key: Optional[DataAtPathLastEvaluatedKey] = None, data: Union[DataSchema, List[DataSchema], NoneType] = None)

Method generated by attrs for class DataAtPath.

paths: Optional[List[str]]
object_count: Optional[int]
last_evaluated_key: Optional[DataAtPathLastEvaluatedKey]
data: Union[DataSchema, List[DataSchema], NoneType]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DataAtPathLastEvaluatedKey:
DataAtPathLastEvaluatedKey()

Method generated by attrs for class DataAtPathLastEvaluatedKey.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DataByPath:

List of group data

Attributes: data_by_path (DataByPathDataByPath):

DataByPath( data_by_path: DataByPathDataByPath)

Method generated by attrs for class DataByPath.

data_by_path: DataByPathDataByPath
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DataByPathDataByPath:
DataByPathDataByPath()

Method generated by attrs for class DataByPathDataByPath.

additional_properties: Dict[str, Union[DataInfo, DataSchema, List[DataSchema]]]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DataInfo:

List of group data

Attributes: paths (Union[Unset, List[str]]): object_count (Union[Unset, int]): last_evaluated_key (Union[Unset, DataInfoLastEvaluatedKey]):

DataInfo( paths: Optional[List[str]] = None, object_count: Optional[int] = None, last_evaluated_key: Optional[DataInfoLastEvaluatedKey] = None)

Method generated by attrs for class DataInfo.

paths: Optional[List[str]]
object_count: Optional[int]
last_evaluated_key: Optional[DataInfoLastEvaluatedKey]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DataInfoLastEvaluatedKey:
DataInfoLastEvaluatedKey()

Method generated by attrs for class DataInfoLastEvaluatedKey.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DataSchema:

Group data

Attributes: path (str): Path this data entry is stored at value (DataSchemaValue): Data stored at this path created_by (str): ID of the account that created this data created_date (datetime.datetime): Date this data was created updated_by_list (List[str]): List of account IDs for most recent editors updated_date_list (List[datetime.datetime]): List of dates for most recent edits verified (bool): Whether the signature on this entry was verified on retrieval revision (int): Revison number of the data entry unicode_1 (Union[Unset, str]): Custom unicode index 1 unicode_2 (Union[Unset, str]): Custom unicode index 2 unicode_3 (Union[Unset, str]): Custom unicode index 3 unicode_4 (Union[Unset, str]): Custom unicode index 4 unicode_5 (Union[Unset, str]): Custom unicode index 5 unicode_6 (Union[Unset, str]): Custom unicode index 6 unicode_7 (Union[Unset, str]): Custom unicode index 7 unicode_8 (Union[Unset, str]): Custom unicode index 8 unicode_9 (Union[Unset, str]): Custom unicode index 9 unicode_10 (Union[Unset, str]): Custom unicode index 10 number_1 (Union[Unset, float, int]): Custom number index 1 number_2 (Union[Unset, float, int]): Custom number index 2

DataSchema( path: str, value: DataSchemaValue, created_by: str, created_date: datetime.datetime, updated_by_list: List[str], updated_date_list: List[datetime.datetime], verified: bool, revision: int, unicode_1: Optional[str] = None, unicode_2: Optional[str] = None, unicode_3: Optional[str] = None, unicode_4: Optional[str] = None, unicode_5: Optional[str] = None, unicode_6: Optional[str] = None, unicode_7: Optional[str] = None, unicode_8: Optional[str] = None, unicode_9: Optional[str] = None, unicode_10: Optional[str] = None, number_1: Union[NoneType, float, int] = None, number_2: Union[NoneType, float, int] = None)

Method generated by attrs for class DataSchema.

path: str
created_by: str
created_date: datetime.datetime
updated_by_list: List[str]
updated_date_list: List[datetime.datetime]
verified: bool
revision: int
unicode_1: Optional[str]
unicode_2: Optional[str]
unicode_3: Optional[str]
unicode_4: Optional[str]
unicode_5: Optional[str]
unicode_6: Optional[str]
unicode_7: Optional[str]
unicode_8: Optional[str]
unicode_9: Optional[str]
unicode_10: Optional[str]
number_1: Union[NoneType, float, int]
number_2: Union[NoneType, float, int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DataSchemaValue:

Data stored at this path

DataSchemaValue()

Method generated by attrs for class DataSchemaValue.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DeleteDataJob:

Represents a single DELETE in a bulk request

Attributes: paths (List[str]): Paths to delete cascade (Union[Unset, bool]): Whether to delete all child paths

DeleteDataJob(paths: List[str], cascade: Optional[bool] = None)

Method generated by attrs for class DeleteDataJob.

paths: List[str]
cascade: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DeviceInfo:

Info on one specific device

Attributes: device (DeviceSchema): Which Device fields to include in response bodies

DeviceInfo(device: DeviceSchema)

Method generated by attrs for class DeviceInfo.

device: DeviceSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DeviceList:

List of devices

Attributes: devices (Union[Unset, List['DeviceSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

DeviceList( devices: Optional[List[DeviceSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class DeviceList.

devices: Optional[List[DeviceSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DeviceSchema:

Which Device fields to include in response bodies

Attributes: name (str): locale (str): zoneinfo (str): id (str): ID of the account created_date (datetime.datetime): UTC datetime the account was created tags (List[str]): Tags for this device open_tunnels (List['Tunnel']): List of open tunnels to this device custom_attributes (DeviceSchemaCustomAttributes): Custom attributes for this device restricted_custom_attributes (DeviceSchemaRestrictedCustomAttributes): Custom attributes only admins can update iot_scopes (DeviceSchemaIotScopes): PubSub permissions per IoT scope for this device is_delete_protected (Union[Unset, bool]): Default: False. manufacturer (Union[Unset, str]): product (Union[Unset, str]): site (Union[Unset, str]): serial_number (Union[Unset, str]): mac_address (Union[Unset, str]): is_org_admin (Union[Unset, bool]): Default: False. picture (Union[Unset, str]): picture_base64 (Union[Unset, str]): picture_content_type (Union[Unset, str]): project_id (Union[Unset, str]): ID of the project this group belongs to, if any is_project_admin (Union[Unset, bool]): Whether this user is a project admin, only visible in project scope is_group_admin (Union[Unset, bool]): Whether this user is a group admin, only visible when filtered by group created_by (Union[Unset, str]): ID of the user who created this account last_updated_by (Union[Unset, str]): ID of the user who last updated this account last_updated_date (Union[Unset, datetime.datetime]): UTC datetime the account was last updated api_key_last_changed (Union[Unset, datetime.datetime]): UTC datetime the API key was last changed mqtt_credentials_last_changed (Union[Unset, datetime.datetime]): UTC datetime the MQTT credentials were last changed last_seen (Union[Unset, datetime.datetime]): UTC datetime the device was last seen owner_id (Union[Unset, str]): ID of the device owner project_ids (Union[Unset, List[str]]): Projects they belong to, individual devices only group_ids (Union[Unset, List[str]]): Groups they belong to, individual devices only role_ids (Union[Unset, List[str]]): Roles they belong to, individual devices only project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access

DeviceSchema( name: str, locale: str, zoneinfo: str, id: str, created_date: datetime.datetime, tags: List[str], open_tunnels: List[Tunnel], custom_attributes: DeviceSchemaCustomAttributes, restricted_custom_attributes: DeviceSchemaRestrictedCustomAttributes, iot_scopes: DeviceSchemaIotScopes, is_delete_protected: Optional[bool] = False, manufacturer: Optional[str] = None, product: Optional[str] = None, site: Optional[str] = None, serial_number: Optional[str] = None, mac_address: Optional[str] = None, is_org_admin: Optional[bool] = False, picture: Optional[str] = None, picture_base64: Optional[str] = None, picture_content_type: Optional[str] = None, project_id: Optional[str] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, last_updated_date: Optional[datetime.datetime] = None, api_key_last_changed: Optional[datetime.datetime] = None, mqtt_credentials_last_changed: Optional[datetime.datetime] = None, last_seen: Optional[datetime.datetime] = None, owner_id: Optional[str] = None, project_ids: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, role_ids: Optional[List[str]] = None, project_permissions: Optional[ProjectAccessPermissions] = None, org_permissions: Optional[OrgAccessPermissions] = None)

Method generated by attrs for class DeviceSchema.

name: str
locale: str
zoneinfo: str
id: str
created_date: datetime.datetime
tags: List[str]
open_tunnels: List[Tunnel]
custom_attributes: DeviceSchemaCustomAttributes
restricted_custom_attributes: DeviceSchemaRestrictedCustomAttributes
iot_scopes: DeviceSchemaIotScopes
is_delete_protected: Optional[bool]
manufacturer: Optional[str]
product: Optional[str]
site: Optional[str]
serial_number: Optional[str]
mac_address: Optional[str]
is_org_admin: Optional[bool]
picture: Optional[str]
picture_base64: Optional[str]
picture_content_type: Optional[str]
project_id: Optional[str]
is_project_admin: Optional[bool]
is_group_admin: Optional[bool]
created_by: Optional[str]
last_updated_by: Optional[str]
last_updated_date: Optional[datetime.datetime]
api_key_last_changed: Optional[datetime.datetime]
mqtt_credentials_last_changed: Optional[datetime.datetime]
last_seen: Optional[datetime.datetime]
owner_id: Optional[str]
project_ids: Optional[List[str]]
group_ids: Optional[List[str]]
role_ids: Optional[List[str]]
project_permissions: Optional[ProjectAccessPermissions]
org_permissions: Optional[OrgAccessPermissions]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DeviceSchemaCustomAttributes:

Custom attributes for this device

DeviceSchemaCustomAttributes()

Method generated by attrs for class DeviceSchemaCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DeviceSchemaIotScopes:

PubSub permissions per IoT scope for this device

DeviceSchemaIotScopes()

Method generated by attrs for class DeviceSchemaIotScopes.

additional_properties: Dict[str, PubSubPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class DeviceSchemaRestrictedCustomAttributes:

Custom attributes only admins can update

DeviceSchemaRestrictedCustomAttributes()

Method generated by attrs for class DeviceSchemaRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class EmailTemplateInfo:

Info on one specific email template

Attributes: template (EmailTemplateSchema): Which Template fields to include in response bodies

EmailTemplateInfo(template: EmailTemplateSchema)

Method generated by attrs for class EmailTemplateInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class EmailTemplateList:

List of email templates

Attributes: templates (Union[Unset, List['EmailTemplateSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

EmailTemplateList( templates: Optional[List[EmailTemplateSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class EmailTemplateList.

templates: Optional[List[EmailTemplateSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class EmailTemplateSchema:

Which Template fields to include in response bodies

Attributes: id (str): ID of the template is_delete_protected (bool): This must be set false before the template can be deleted is_active (bool): If false, all template operations are disabled created_date (datetime.datetime): Date and time the template was created created_by (str): ID of the user who created the template tags (List[str]): List of tags on this template name (str): Name of the template subject (str): Subject of the template body_txt (str): Plain text body of the template body_html (str): HTML body of the template locale (str): Locale for the template custom_args (List[str]): List of custom arguments on this template for_account_recovery (bool): If true, the template is used for forgot password emails for_new_users (bool): If true, the template is used for new user emails last_updated_by (Union[Unset, str]): ID of the user who last updated the template last_updated_date (Union[Unset, datetime.datetime]): Date and time the template was last updated from_address (Union[Unset, str]): From email address to use with this template description (Union[Unset, str]): Description of the template project_id (Union[Unset, str]): ID of the project this template belongs to, if any

EmailTemplateSchema( id: str, is_delete_protected: bool, is_active: bool, created_date: datetime.datetime, created_by: str, tags: List[str], name: str, subject: str, body_txt: str, body_html: str, locale: str, custom_args: List[str], for_account_recovery: bool, for_new_users: bool, last_updated_by: Optional[str] = None, last_updated_date: Optional[datetime.datetime] = None, from_address: Optional[str] = None, description: Optional[str] = None, project_id: Optional[str] = None)

Method generated by attrs for class EmailTemplateSchema.

id: str
is_delete_protected: bool
is_active: bool
created_date: datetime.datetime
created_by: str
tags: List[str]
name: str
subject: str
body_txt: str
body_html: str
locale: str
custom_args: List[str]
for_account_recovery: bool
for_new_users: bool
last_updated_by: Optional[str]
last_updated_date: Optional[datetime.datetime]
from_address: Optional[str]
description: Optional[str]
project_id: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class FilesAtPath:

List of file info

Attributes: url (Union[Unset, str]): Pre-signed S3 URL urls (Union[Unset, List[str]]): List of pre-signed S3 URLs paths (Union[Unset, List[str]]): object_count (Union[Unset, int]): last_evaluated_key (Union[Unset, FilesAtPathLastEvaluatedKey]): file (Union[Unset, FileSchema]): File info fields to include in the response bodies files (Union[Unset, List['FileSchema']]): List of file info

FilesAtPath( url: Optional[str] = None, urls: Optional[List[str]] = None, paths: Optional[List[str]] = None, object_count: Optional[int] = None, last_evaluated_key: Optional[FilesAtPathLastEvaluatedKey] = None, file: Optional[FileSchema] = None, files: Optional[List[FileSchema]] = None)

Method generated by attrs for class FilesAtPath.

url: Optional[str]
urls: Optional[List[str]]
paths: Optional[List[str]]
object_count: Optional[int]
last_evaluated_key: Optional[FilesAtPathLastEvaluatedKey]
file: Optional[FileSchema]
files: Optional[List[FileSchema]]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class FilesAtPathLastEvaluatedKey:
FilesAtPathLastEvaluatedKey()

Method generated by attrs for class FilesAtPathLastEvaluatedKey.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class FileSchema:

File info fields to include in the response bodies

Attributes: path (str): Path this file is stored at filename (str): Filename of file created_by (str): ID of the user who created the file created_date (datetime.datetime): Date and time the file was created revision (int): Revison number of the data entry unicode_1 (Union[Unset, str]): Custom unicode index 1 unicode_2 (Union[Unset, str]): Custom unicode index 2 unicode_3 (Union[Unset, str]): Custom unicode index 3 unicode_4 (Union[Unset, str]): Custom unicode index 4 unicode_5 (Union[Unset, str]): Custom unicode index 5 unicode_6 (Union[Unset, str]): Custom unicode index 6 number_1 (Union[Unset, float, int]): Custom number index 1 number_2 (Union[Unset, float, int]): Custom number index 2 expires_in (Union[Unset, int]): Number of seconds before presigned URLs expire Default: 3600. content_type (Union[Unset, str]): Optionally specify the content type of the file you will upload num_parts (Union[Unset, int]): Number of parts to upload completed_upload_id (Union[Unset, str]): ID of completed multipart upload to merge etag_by_part (Union[Unset, FileSchemaEtagByPart]): List of ETags for each part of the multipart upload url (Union[Unset, str]): Pre-signed GET URL size (Union[Unset, int]): Size of file in bytes etag (Union[Unset, str]): ETag of file uploaded_date (Union[Unset, datetime.datetime]): Date and time the file was uploaded updated_by_list (Union[Unset, List[str]]): List of account IDs for most recent editors updated_date_list (Union[Unset, List[datetime.datetime]]): List of dates for most recent edits

FileSchema( path: str, filename: str, created_by: str, created_date: datetime.datetime, revision: int, unicode_1: Optional[str] = None, unicode_2: Optional[str] = None, unicode_3: Optional[str] = None, unicode_4: Optional[str] = None, unicode_5: Optional[str] = None, unicode_6: Optional[str] = None, number_1: Union[NoneType, float, int] = None, number_2: Union[NoneType, float, int] = None, expires_in: Optional[int] = 3600, content_type: Optional[str] = None, num_parts: Optional[int] = None, completed_upload_id: Optional[str] = None, etag_by_part: Optional[FileSchemaEtagByPart] = None, url: Optional[str] = None, size: Optional[int] = None, etag: Optional[str] = None, uploaded_date: Optional[datetime.datetime] = None, updated_by_list: Optional[List[str]] = None, updated_date_list: Optional[List[datetime.datetime]] = None)

Method generated by attrs for class FileSchema.

path: str
filename: str
created_by: str
created_date: datetime.datetime
revision: int
unicode_1: Optional[str]
unicode_2: Optional[str]
unicode_3: Optional[str]
unicode_4: Optional[str]
unicode_5: Optional[str]
unicode_6: Optional[str]
number_1: Union[NoneType, float, int]
number_2: Union[NoneType, float, int]
expires_in: Optional[int]
content_type: Optional[str]
num_parts: Optional[int]
completed_upload_id: Optional[str]
etag_by_part: Optional[FileSchemaEtagByPart]
url: Optional[str]
size: Optional[int]
etag: Optional[str]
uploaded_date: Optional[datetime.datetime]
updated_by_list: Optional[List[str]]
updated_date_list: Optional[List[datetime.datetime]]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class FileSchemaEtagByPart:

List of ETags for each part of the multipart upload

FileSchemaEtagByPart()

Method generated by attrs for class FileSchemaEtagByPart.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class FilesUrlForPath:

File pre-signed GET URL, the format used when url_only is true

Attributes: upload_id (Union[Unset, str]): ID of a multipart upload url (Union[Unset, str]): Pre-signed S3 URL urls (Union[Unset, List[str]]): List of pre-signed S3 URLs

FilesUrlForPath( upload_id: Optional[str] = None, url: Optional[str] = None, urls: Optional[List[str]] = None)

Method generated by attrs for class FilesUrlForPath.

upload_id: Optional[str]
url: Optional[str]
urls: Optional[List[str]]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class GetDataJob:

Represents a single GET in a bulk request

Attributes: paths (List[str]): Paths to get cascade (Union[Unset, bool]): If true, return all paths starting with the specified path paths_only (Union[Unset, bool]): If true, only return list of matching file paths object_count (Union[Unset, bool]): If true, only return the number of objects in the file desc (Union[Unset, bool]): Whether to order results in descending order bust_cache (Union[Unset, bool]): Whether to bypass the cache and get the latest data limit (Union[Unset, int]): Maximum number of results to return Default: 100. order_by (Union[Unset, str]): Field to order results by last_evaluated_key (Union['GetDataJobLastEvaluatedKeyType0', Unset, str]): Key to start results from search (Union[Unset, str]): Search term to filter accounts by search_fields (Union[Unset, str]): Fields to search in path_filter (Union[Unset, str]): Regex pattern to match result paths against created_by (Union[Unset, str]): ID of the user who created the entry last_updated_by (Union[Unset, str]): ID of the user who last updated the entry created_date (Union[Unset, datetime.datetime]): Created date of items to return created_date_gte (Union[Unset, datetime.datetime]): created_date_lte (Union[Unset, datetime.datetime]): last_updated_date (Union[Unset, datetime.datetime]): Last edited date of items to return last_updated_date_gte (Union[Unset, datetime.datetime]): last_updated_date_lte (Union[Unset, datetime.datetime]): unicode_1 (Union[Unset, str]): Custom unicode index 1 unicode_1_sw (Union[Unset, str]): unicode_1_contains (Union[Unset, str]): unicode_1_gte (Union[Unset, str]): unicode_1_lte (Union[Unset, str]): unicode_2 (Union[Unset, str]): Custom unicode index 2 unicode_2_sw (Union[Unset, str]): unicode_2_contains (Union[Unset, str]): unicode_2_gte (Union[Unset, str]): unicode_2_lte (Union[Unset, str]): unicode_3 (Union[Unset, str]): Custom unicode index 3 unicode_3_sw (Union[Unset, str]): unicode_3_contains (Union[Unset, str]): unicode_3_gte (Union[Unset, str]): unicode_3_lte (Union[Unset, str]): unicode_4 (Union[Unset, str]): Custom unicode index 4 unicode_4_sw (Union[Unset, str]): unicode_4_contains (Union[Unset, str]): unicode_4_gte (Union[Unset, str]): unicode_4_lte (Union[Unset, str]): unicode_5 (Union[Unset, str]): Custom unicode index 5 unicode_5_sw (Union[Unset, str]): unicode_5_contains (Union[Unset, str]): unicode_5_gte (Union[Unset, str]): unicode_5_lte (Union[Unset, str]): unicode_6 (Union[Unset, str]): Custom unicode index 6 unicode_6_sw (Union[Unset, str]): unicode_6_contains (Union[Unset, str]): unicode_6_gte (Union[Unset, str]): unicode_6_lte (Union[Unset, str]): number_1 (Union[Unset, float]): Custom number index 1 number_1_gt (Union[Unset, float]): number_1_gte (Union[Unset, float]): number_1_lt (Union[Unset, float]): number_1_lte (Union[Unset, float]): number_2 (Union[Unset, float]): Custom number index 2 number_2_gt (Union[Unset, float]): number_2_gte (Union[Unset, float]): number_2_lt (Union[Unset, float]): number_2_lte (Union[Unset, float]): verify (Union[Unset, bool]): Whether to verify the signature on the item unicode_7 (Union[Unset, str]): Custom unicode index 7 unicode_7_sw (Union[Unset, str]): unicode_7_contains (Union[Unset, str]): unicode_7_gte (Union[Unset, str]): unicode_7_lte (Union[Unset, str]): unicode_8 (Union[Unset, str]): Custom unicode index 8 unicode_8_sw (Union[Unset, str]): unicode_8_contains (Union[Unset, str]): unicode_8_gte (Union[Unset, str]): unicode_8_lte (Union[Unset, str]): unicode_9 (Union[Unset, str]): Custom unicode index 9 unicode_9_sw (Union[Unset, str]): unicode_9_contains (Union[Unset, str]): unicode_9_gte (Union[Unset, str]): unicode_9_lte (Union[Unset, str]): unicode_10 (Union[Unset, str]): Custom unicode index 10 unicode_10_sw (Union[Unset, str]): unicode_10_contains (Union[Unset, str]): unicode_10_gte (Union[Unset, str]): unicode_10_lte (Union[Unset, str]):

GetDataJob( paths: List[str], cascade: Optional[bool] = None, paths_only: Optional[bool] = None, object_count: Optional[bool] = None, desc: Optional[bool] = None, bust_cache: Optional[bool] = None, limit: Optional[int] = 100, order_by: Optional[str] = None, last_evaluated_key: Union[GetDataJobLastEvaluatedKeyType0, NoneType, str] = None, search: Optional[str] = None, search_fields: Optional[str] = None, path_filter: Optional[str] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, created_date: Optional[datetime.datetime] = None, created_date_gte: Optional[datetime.datetime] = None, created_date_lte: Optional[datetime.datetime] = None, last_updated_date: Optional[datetime.datetime] = None, last_updated_date_gte: Optional[datetime.datetime] = None, last_updated_date_lte: Optional[datetime.datetime] = None, unicode_1: Optional[str] = None, unicode_1_sw: Optional[str] = None, unicode_1_contains: Optional[str] = None, unicode_1_gte: Optional[str] = None, unicode_1_lte: Optional[str] = None, unicode_2: Optional[str] = None, unicode_2_sw: Optional[str] = None, unicode_2_contains: Optional[str] = None, unicode_2_gte: Optional[str] = None, unicode_2_lte: Optional[str] = None, unicode_3: Optional[str] = None, unicode_3_sw: Optional[str] = None, unicode_3_contains: Optional[str] = None, unicode_3_gte: Optional[str] = None, unicode_3_lte: Optional[str] = None, unicode_4: Optional[str] = None, unicode_4_sw: Optional[str] = None, unicode_4_contains: Optional[str] = None, unicode_4_gte: Optional[str] = None, unicode_4_lte: Optional[str] = None, unicode_5: Optional[str] = None, unicode_5_sw: Optional[str] = None, unicode_5_contains: Optional[str] = None, unicode_5_gte: Optional[str] = None, unicode_5_lte: Optional[str] = None, unicode_6: Optional[str] = None, unicode_6_sw: Optional[str] = None, unicode_6_contains: Optional[str] = None, unicode_6_gte: Optional[str] = None, unicode_6_lte: Optional[str] = None, number_1: Optional[float] = None, number_1_gt: Optional[float] = None, number_1_gte: Optional[float] = None, number_1_lt: Optional[float] = None, number_1_lte: Optional[float] = None, number_2: Optional[float] = None, number_2_gt: Optional[float] = None, number_2_gte: Optional[float] = None, number_2_lt: Optional[float] = None, number_2_lte: Optional[float] = None, verify: Optional[bool] = None, unicode_7: Optional[str] = None, unicode_7_sw: Optional[str] = None, unicode_7_contains: Optional[str] = None, unicode_7_gte: Optional[str] = None, unicode_7_lte: Optional[str] = None, unicode_8: Optional[str] = None, unicode_8_sw: Optional[str] = None, unicode_8_contains: Optional[str] = None, unicode_8_gte: Optional[str] = None, unicode_8_lte: Optional[str] = None, unicode_9: Optional[str] = None, unicode_9_sw: Optional[str] = None, unicode_9_contains: Optional[str] = None, unicode_9_gte: Optional[str] = None, unicode_9_lte: Optional[str] = None, unicode_10: Optional[str] = None, unicode_10_sw: Optional[str] = None, unicode_10_contains: Optional[str] = None, unicode_10_gte: Optional[str] = None, unicode_10_lte: Optional[str] = None)

Method generated by attrs for class GetDataJob.

paths: List[str]
cascade: Optional[bool]
paths_only: Optional[bool]
object_count: Optional[bool]
desc: Optional[bool]
bust_cache: Optional[bool]
limit: Optional[int]
order_by: Optional[str]
last_evaluated_key: Union[GetDataJobLastEvaluatedKeyType0, NoneType, str]
search: Optional[str]
search_fields: Optional[str]
path_filter: Optional[str]
created_by: Optional[str]
last_updated_by: Optional[str]
created_date: Optional[datetime.datetime]
created_date_gte: Optional[datetime.datetime]
created_date_lte: Optional[datetime.datetime]
last_updated_date: Optional[datetime.datetime]
last_updated_date_gte: Optional[datetime.datetime]
last_updated_date_lte: Optional[datetime.datetime]
unicode_1: Optional[str]
unicode_1_sw: Optional[str]
unicode_1_contains: Optional[str]
unicode_1_gte: Optional[str]
unicode_1_lte: Optional[str]
unicode_2: Optional[str]
unicode_2_sw: Optional[str]
unicode_2_contains: Optional[str]
unicode_2_gte: Optional[str]
unicode_2_lte: Optional[str]
unicode_3: Optional[str]
unicode_3_sw: Optional[str]
unicode_3_contains: Optional[str]
unicode_3_gte: Optional[str]
unicode_3_lte: Optional[str]
unicode_4: Optional[str]
unicode_4_sw: Optional[str]
unicode_4_contains: Optional[str]
unicode_4_gte: Optional[str]
unicode_4_lte: Optional[str]
unicode_5: Optional[str]
unicode_5_sw: Optional[str]
unicode_5_contains: Optional[str]
unicode_5_gte: Optional[str]
unicode_5_lte: Optional[str]
unicode_6: Optional[str]
unicode_6_sw: Optional[str]
unicode_6_contains: Optional[str]
unicode_6_gte: Optional[str]
unicode_6_lte: Optional[str]
number_1: Optional[float]
number_1_gt: Optional[float]
number_1_gte: Optional[float]
number_1_lt: Optional[float]
number_1_lte: Optional[float]
number_2: Optional[float]
number_2_gt: Optional[float]
number_2_gte: Optional[float]
number_2_lt: Optional[float]
number_2_lte: Optional[float]
verify: Optional[bool]
unicode_7: Optional[str]
unicode_7_sw: Optional[str]
unicode_7_contains: Optional[str]
unicode_7_gte: Optional[str]
unicode_7_lte: Optional[str]
unicode_8: Optional[str]
unicode_8_sw: Optional[str]
unicode_8_contains: Optional[str]
unicode_8_gte: Optional[str]
unicode_8_lte: Optional[str]
unicode_9: Optional[str]
unicode_9_sw: Optional[str]
unicode_9_contains: Optional[str]
unicode_9_gte: Optional[str]
unicode_9_lte: Optional[str]
unicode_10: Optional[str]
unicode_10_sw: Optional[str]
unicode_10_contains: Optional[str]
unicode_10_gte: Optional[str]
unicode_10_lte: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class GetDataJobLastEvaluatedKeyType0:
GetDataJobLastEvaluatedKeyType0()

Method generated by attrs for class GetDataJobLastEvaluatedKeyType0.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class GroupAccessInfo:

Access for a group

Attributes: group_access (GroupAccessSchema): Access for a group

GroupAccessInfo(group_access: GroupAccessSchema)

Method generated by attrs for class GroupAccessInfo.

group_access: GroupAccessSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class GroupAccessSchema:

Access for a group

Attributes: is_delete_protected (bool): This must be set false before the access can be deleted created_date (datetime.datetime): Date and time the access was created can_read (bool): If true, the account can read this access can_update (bool): If true, the account can update this access user_permissions (CRUDPermissions): Collection of CRUD permissions device_permissions (CRUDPermissions): Collection of CRUD permissions tags (List[str]): List of tags on this access object group_id (str): ID of the group that has access grantee_id (str): ID of the account that has access is_admin (bool): If true, the account has admin access role_permissions (CRUDPermissions): Collection of CRUD permissions last_updated_date (Union[Unset, datetime.datetime]): Date and time the access was last updated created_by (Union[Unset, str]): ID of the account that created this access last_updated_by (Union[Unset, str]): ID of the account that last updated this access

GroupAccessSchema( is_delete_protected: bool, created_date: datetime.datetime, can_read: bool, can_update: bool, user_permissions: CRUDPermissions, device_permissions: CRUDPermissions, tags: List[str], group_id: str, grantee_id: str, is_admin: bool, role_permissions: CRUDPermissions, last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None)

Method generated by attrs for class GroupAccessSchema.

is_delete_protected: bool
created_date: datetime.datetime
can_read: bool
can_update: bool
user_permissions: CRUDPermissions
device_permissions: CRUDPermissions
tags: List[str]
group_id: str
grantee_id: str
is_admin: bool
role_permissions: CRUDPermissions
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
last_updated_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class GroupInfo:

Info on one specific group

Attributes: group (GroupSchema): Which Group fields to include in response bodies

GroupInfo(group: GroupSchema)

Method generated by attrs for class GroupInfo.

group: GroupSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class GroupList:

List of groups

Attributes: groups (Union[Unset, List['GroupSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

GroupList( groups: Optional[List[GroupSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class GroupList.

groups: Optional[List[GroupSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class GroupSchema:

Which Group fields to include in response bodies

Attributes: id (str): ID of the group name (str): Name of the group description (str): Description of the group is_delete_protected (bool): This must be set false before the group can be deleted is_active (bool): If false, all group operations are disabled created_date (datetime.datetime): Date and time the group was created last_updated_by (str): ID of the account that last updated the group tags (List[str]): List of tags on this group num_history (int): Number of history entries to keep on rolling list attributes role_delete_protection_on_by_default (bool): If true, new roles attached to this group will have delete protection enabled if not specified at creation require_delete_permission_to_put_data (bool): If true, require delete permission to put data project_id (Union[Unset, str]): ID of the project this group belongs to, if any last_updated_date (Union[Unset, datetime.datetime]): Date and time the group was last updated created_by (Union[Unset, str]): ID of the account that created the group

GroupSchema( id: str, name: str, description: str, is_delete_protected: bool, is_active: bool, created_date: datetime.datetime, last_updated_by: str, tags: List[str], num_history: int, role_delete_protection_on_by_default: bool, require_delete_permission_to_put_data: bool, project_id: Optional[str] = None, last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None)

Method generated by attrs for class GroupSchema.

id: str
name: str
description: str
is_delete_protected: bool
is_active: bool
created_date: datetime.datetime
last_updated_by: str
tags: List[str]
num_history: int
role_delete_protection_on_by_default: bool
require_delete_permission_to_put_data: bool
project_id: Optional[str]
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class HealthInfo:

Health status of the system

Attributes: status (str): Status of the system

HealthInfo(status: str)

Method generated by attrs for class HealthInfo.

status: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class InterfaceConfig:

Configuration for the user interface

Attributes: images (Union[Unset, InterfaceImages]): Logos for the user interface primary_color (Union[Unset, str]): Primary color for the dashboard use_dark_mode (Union[Unset, bool]): Use dark mode for the dashboard

InterfaceConfig( images: Optional[InterfaceImages] = None, primary_color: Optional[str] = None, use_dark_mode: Optional[bool] = None)

Method generated by attrs for class InterfaceConfig.

images: Optional[InterfaceImages]
primary_color: Optional[str]
use_dark_mode: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class InterfaceImages:

Logos for the user interface

Attributes: logo_default (Union[Unset, str]): URL of the default logo logo_small (Union[Unset, str]): URL of the small logo login_background (Union[Unset, str]): URL of the login background image favicon (Union[Unset, str]): URL of the favicon

InterfaceImages( logo_default: Optional[str] = None, logo_small: Optional[str] = None, login_background: Optional[str] = None, favicon: Optional[str] = None)

Method generated by attrs for class InterfaceImages.

logo_default: Optional[str]
logo_small: Optional[str]
login_background: Optional[str]
favicon: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class Jwks:

JSON Web Key Set

Attributes: keys (List['JwksKeysItem']): List of JSON Web Keys

Jwks(keys: List[JwksKeysItem])

Method generated by attrs for class Jwks.

keys: List[JwksKeysItem]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class JwksKeysItem:
JwksKeysItem()

Method generated by attrs for class JwksKeysItem.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class MfaSecretCode:

MFA secret code

Attributes: secret_code (str): MFA secret code session (Union[Unset, str]): Session to use for adding software MFA

MfaSecretCode(secret_code: str, session: Optional[str] = None)

Method generated by attrs for class MfaSecretCode.

secret_code: str
session: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewApiKey:

Info on a new API key

Attributes: api_key (str): API key for this device - ONLY SHOWN ONCE, NOT STORED

NewApiKey(api_key: str)

Method generated by attrs for class NewApiKey.

api_key: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewDeviceInfo:

Info on one specific device

Attributes: device (NewDeviceSchema): Which Device fields to include in response bodies

NewDeviceInfo(device: NewDeviceSchema)

Method generated by attrs for class NewDeviceInfo.

device: NewDeviceSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewDeviceSchema:

Which Device fields to include in response bodies

Attributes: id (str): ID of the newly created device api_key (str): API key for this device - ONLY SHOWN ONCE, NOT STORED certificate (str): PEM-encoded certificate for this device root_ca (str): URL for the root CA certificate, which is in PEM format public_key (str): Public key for this device private_key (str): Private key for this device broker (str): Domain of the MQTT broker, does not include protocol or port root_scope (str): Root MQTT scope for topics this device can utilize owner_id (Union[Unset, str]): ID of the device owner

NewDeviceSchema( id: str, api_key: str, certificate: str, root_ca: str, public_key: str, private_key: str, broker: str, root_scope: str, owner_id: Optional[str] = None)

Method generated by attrs for class NewDeviceSchema.

id: str
api_key: str
certificate: str
root_ca: str
public_key: str
private_key: str
broker: str
root_scope: str
owner_id: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewEmailTemplateInfo:

Info on one specific email template

Attributes: template (NewEmailTemplateSchema): Which Template fields to include in response bodies

NewEmailTemplateInfo( template: NewEmailTemplateSchema)

Method generated by attrs for class NewEmailTemplateInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewEmailTemplateSchema:

Which Template fields to include in response bodies

Attributes: id (str): ID of the newly created template

NewEmailTemplateSchema(id: str)

Method generated by attrs for class NewEmailTemplateSchema.

id: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewGroupInfo:

Info on one specific group

Attributes: group (NewGroupSchema): Which Group fields to include in response bodies

NewGroupInfo(group: NewGroupSchema)

Method generated by attrs for class NewGroupInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewGroupSchema:

Which Group fields to include in response bodies

Attributes: id (str): ID of the group

NewGroupSchema(id: str)

Method generated by attrs for class NewGroupSchema.

id: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewMqttCredentials:

"Info on new MQTT credentials

Attributes: certificate (str): PEM-encoded certificate for this device root_ca (str): URL for the root CA certificate, which is in PEM format public_key (str): Public key for this device private_key (str): Private key for this device broker (str): Domain of the MQTT broker, does not include protocol or port root_scope (str): Root MQTT scope for topics this device can utilize

NewMqttCredentials( certificate: str, root_ca: str, public_key: str, private_key: str, broker: str, root_scope: str)

Method generated by attrs for class NewMqttCredentials.

certificate: str
root_ca: str
public_key: str
private_key: str
broker: str
root_scope: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewProjectInfo:

Info on one specific project

Attributes: project (NewProjectSchema): Which Project fields to include in response bodies

NewProjectInfo(project: NewProjectSchema)

Method generated by attrs for class NewProjectInfo.

project: NewProjectSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewProjectSchema:

Which Project fields to include in response bodies

Attributes: id (str): ID of the project

NewProjectSchema(id: str)

Method generated by attrs for class NewProjectSchema.

id: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewRoleInfo:

Info on one specific role

Attributes: role (NewRoleSchema): Which Role fields to include in request bodies

NewRoleInfo(role: NewRoleSchema)

Method generated by attrs for class NewRoleInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewRoleSchema:

Which Role fields to include in request bodies

Attributes: id (str): ID of the role

NewRoleSchema(id: str)

Method generated by attrs for class NewRoleSchema.

id: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewTunnelInfo:

Info on one specific tunnel

Attributes: tunnel (NewTunnelSchema): Info on one specific tunnel

NewTunnelInfo(tunnel: NewTunnelSchema)

Method generated by attrs for class NewTunnelInfo.

tunnel: NewTunnelSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewTunnelSchema:

Info on one specific tunnel

Attributes: uuid (str): timeout (int): client_access_token (str):

NewTunnelSchema(uuid: str, timeout: int, client_access_token: str)

Method generated by attrs for class NewTunnelSchema.

uuid: str
timeout: int
client_access_token: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewUserInfo:

Info on newly created user

Attributes: user (NewUserSchema): New user schema

NewUserInfo(user: NewUserSchema)

Method generated by attrs for class NewUserInfo.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class NewUserSchema:

New user schema

Attributes: id (str): ID of the user

NewUserSchema(id: str)

Method generated by attrs for class NewUserSchema.

id: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class OrgAccessPermissions:

Collection of permissions for org access

Attributes: can_update (Union[Unset, bool]): Default: False. can_read (Union[Unset, bool]): Default: False. user_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions device_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions role_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions is_admin (Union[Unset, bool]): Default: False. group_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions project_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions

OrgAccessPermissions( can_update: Optional[bool] = False, can_read: Optional[bool] = False, user_permissions: Optional[CRUDPermissions] = None, device_permissions: Optional[CRUDPermissions] = None, role_permissions: Optional[CRUDPermissions] = None, is_admin: Optional[bool] = False, group_permissions: Optional[CRUDPermissions] = None, project_permissions: Optional[CRUDPermissions] = None)

Method generated by attrs for class OrgAccessPermissions.

can_update: Optional[bool]
can_read: Optional[bool]
user_permissions: Optional[CRUDPermissions]
device_permissions: Optional[CRUDPermissions]
role_permissions: Optional[CRUDPermissions]
is_admin: Optional[bool]
group_permissions: Optional[CRUDPermissions]
project_permissions: Optional[CRUDPermissions]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class OrgAccessSchema:

Access for an organization

Attributes: is_delete_protected (bool): This must be set false before the access can be deleted created_date (datetime.datetime): Date and time the access was created can_read (bool): If true, the account can read this access can_update (bool): If true, the account can update this access user_permissions (CRUDPermissions): Collection of CRUD permissions device_permissions (CRUDPermissions): Collection of CRUD permissions tags (List[str]): List of tags on this access object org_id (str): ID of the organization that has access grantee_id (str): ID of the account that has access is_admin (bool): If true, the account has admin access role_permissions (CRUDPermissions): Collection of CRUD permissions group_permissions (CRUDPermissions): Collection of CRUD permissions project_permissions (CRUDPermissions): Collection of CRUD permissions last_updated_date (Union[Unset, datetime.datetime]): Date and time the access was last updated created_by (Union[Unset, str]): ID of the account that created this access last_updated_by (Union[Unset, str]): ID of the account that last updated this access

OrgAccessSchema( is_delete_protected: bool, created_date: datetime.datetime, can_read: bool, can_update: bool, user_permissions: CRUDPermissions, device_permissions: CRUDPermissions, tags: List[str], org_id: str, grantee_id: str, is_admin: bool, role_permissions: CRUDPermissions, group_permissions: CRUDPermissions, project_permissions: CRUDPermissions, last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None)

Method generated by attrs for class OrgAccessSchema.

is_delete_protected: bool
created_date: datetime.datetime
can_read: bool
can_update: bool
user_permissions: CRUDPermissions
device_permissions: CRUDPermissions
tags: List[str]
org_id: str
grantee_id: str
is_admin: bool
role_permissions: CRUDPermissions
group_permissions: CRUDPermissions
project_permissions: CRUDPermissions
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
last_updated_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class OrgInfo:

Information about a specific organization

Attributes: org (OrgSchema): Organization model schema

OrgInfo(org: OrgSchema)

Method generated by attrs for class OrgInfo.

org: OrgSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class OrgSchema:

Organization model schema

Attributes: name (str): created_date (datetime.datetime): id (str): ID of the account alias (Union[Unset, str]): description (Union[Unset, str]): Default: ''. allowed_login_fields (Union[Unset, OrgSchemaAllowedLoginFields]): mfa_required (Union[Unset, bool]): Default: False. custom_settings (Union[Unset, OrgSchemaCustomSettings]): device_owners_have_admin_access (Union[Unset, bool]): Default: False. device_owners_can_tunnel (Union[Unset, bool]): Default: False. device_creators_are_owners_by_default (Union[Unset, bool]): Default: False. project_delete_protection_on_by_default (Union[Unset, bool]): Default: False. group_delete_protection_on_by_default (Union[Unset, bool]): Default: False. role_delete_protection_on_by_default (Union[Unset, bool]): Default: False. user_delete_protection_on_by_default (Union[Unset, bool]): Default: False. device_delete_protection_on_by_default (Union[Unset, bool]): Default: False. is_delete_protected (Union[Unset, bool]): Default: False. is_active (Union[Unset, bool]): Default: True. last_updated_date (Union[Unset, datetime.datetime]): default_locale (Union[Unset, str]): Default: 'en-US'. default_from_address (Union[Unset, str]): Default: 'no-reply@cyphermed.cloud'. reset_token_expire_hours (Union[Unset, int]): Default: 24. access_token_expire_hours (Union[Unset, int]): Default: 1. refresh_token_expire_hours (Union[Unset, int]): Default: 24. session_expire_mins (Union[Unset, int]): Default: 5. pii_admin_only (Union[Unset, bool]): Default: False. ui_config (Union[Unset, OrgSchemaUiConfig]): use_legacy_data_and_files_permissions (Union[Unset, bool]): Default: False. groups_require_delete_permission_to_put_data_by_default (Union[Unset, bool]): Default: False.

OrgSchema( name: str, created_date: datetime.datetime, id: str, alias: Optional[str] = None, description: Optional[str] = '', allowed_login_fields: Optional[OrgSchemaAllowedLoginFields] = None, mfa_required: Optional[bool] = False, custom_settings: Optional[OrgSchemaCustomSettings] = None, device_owners_have_admin_access: Optional[bool] = False, device_owners_can_tunnel: Optional[bool] = False, device_creators_are_owners_by_default: Optional[bool] = False, project_delete_protection_on_by_default: Optional[bool] = False, group_delete_protection_on_by_default: Optional[bool] = False, role_delete_protection_on_by_default: Optional[bool] = False, user_delete_protection_on_by_default: Optional[bool] = False, device_delete_protection_on_by_default: Optional[bool] = False, is_delete_protected: Optional[bool] = False, is_active: Optional[bool] = True, last_updated_date: Optional[datetime.datetime] = None, default_locale: Optional[str] = 'en-US', default_from_address: Optional[str] = 'no-reply@cyphermed.cloud', reset_token_expire_hours: Optional[int] = 24, access_token_expire_hours: Optional[int] = 1, refresh_token_expire_hours: Optional[int] = 24, session_expire_mins: Optional[int] = 5, pii_admin_only: Optional[bool] = False, ui_config: Optional[OrgSchemaUiConfig] = None, use_legacy_data_and_files_permissions: Optional[bool] = False, groups_require_delete_permission_to_put_data_by_default: Optional[bool] = False)

Method generated by attrs for class OrgSchema.

name: str
created_date: datetime.datetime
id: str
alias: Optional[str]
description: Optional[str]
allowed_login_fields: Optional[OrgSchemaAllowedLoginFields]
mfa_required: Optional[bool]
custom_settings: Optional[OrgSchemaCustomSettings]
device_owners_have_admin_access: Optional[bool]
device_owners_can_tunnel: Optional[bool]
device_creators_are_owners_by_default: Optional[bool]
project_delete_protection_on_by_default: Optional[bool]
group_delete_protection_on_by_default: Optional[bool]
role_delete_protection_on_by_default: Optional[bool]
user_delete_protection_on_by_default: Optional[bool]
device_delete_protection_on_by_default: Optional[bool]
is_delete_protected: Optional[bool]
is_active: Optional[bool]
last_updated_date: Optional[datetime.datetime]
default_locale: Optional[str]
default_from_address: Optional[str]
reset_token_expire_hours: Optional[int]
access_token_expire_hours: Optional[int]
refresh_token_expire_hours: Optional[int]
session_expire_mins: Optional[int]
pii_admin_only: Optional[bool]
ui_config: Optional[OrgSchemaUiConfig]
use_legacy_data_and_files_permissions: Optional[bool]
groups_require_delete_permission_to_put_data_by_default: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class OrgSchemaAllowedLoginFields:
OrgSchemaAllowedLoginFields()

Method generated by attrs for class OrgSchemaAllowedLoginFields.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class OrgSchemaCustomSettings:
OrgSchemaCustomSettings()

Method generated by attrs for class OrgSchemaCustomSettings.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class OrgSchemaUiConfig:
OrgSchemaUiConfig()

Method generated by attrs for class OrgSchemaUiConfig.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchDataBody:

Update group data

Attributes: unicode_1 (Union[Unset, str]): Custom unicode index 1 unicode_2 (Union[Unset, str]): Custom unicode index 2 unicode_3 (Union[Unset, str]): Custom unicode index 3 unicode_4 (Union[Unset, str]): Custom unicode index 4 unicode_5 (Union[Unset, str]): Custom unicode index 5 unicode_6 (Union[Unset, str]): Custom unicode index 6 unicode_7 (Union[Unset, str]): Custom unicode index 7 unicode_8 (Union[Unset, str]): Custom unicode index 8 unicode_9 (Union[Unset, str]): Custom unicode index 9 unicode_10 (Union[Unset, str]): Custom unicode index 10 number_1 (Union[Unset, float, int]): Custom number index 1 number_2 (Union[Unset, float, int]): Custom number index 2 value (Union['PatchDataBodyValueType0', Unset, str]): Data value to store at this path

PatchDataBody( unicode_1: Optional[str] = None, unicode_2: Optional[str] = None, unicode_3: Optional[str] = None, unicode_4: Optional[str] = None, unicode_5: Optional[str] = None, unicode_6: Optional[str] = None, unicode_7: Optional[str] = None, unicode_8: Optional[str] = None, unicode_9: Optional[str] = None, unicode_10: Optional[str] = None, number_1: Union[NoneType, float, int] = None, number_2: Union[NoneType, float, int] = None, value: Union[PatchDataBodyValueType0, NoneType, str] = None)

Method generated by attrs for class PatchDataBody.

unicode_1: Optional[str]
unicode_2: Optional[str]
unicode_3: Optional[str]
unicode_4: Optional[str]
unicode_5: Optional[str]
unicode_6: Optional[str]
unicode_7: Optional[str]
unicode_8: Optional[str]
unicode_9: Optional[str]
unicode_10: Optional[str]
number_1: Union[NoneType, float, int]
number_2: Union[NoneType, float, int]
value: Union[PatchDataBodyValueType0, NoneType, str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchDataBodyValueType0:
PatchDataBodyValueType0()

Method generated by attrs for class PatchDataBodyValueType0.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchDataJob:

Represents a single PATCH in a bulk request

Attributes: paths (List[str]): Paths to update unicode_1 (Union[Unset, str]): Custom unicode index 1 unicode_2 (Union[Unset, str]): Custom unicode index 2 unicode_3 (Union[Unset, str]): Custom unicode index 3 unicode_4 (Union[Unset, str]): Custom unicode index 4 unicode_5 (Union[Unset, str]): Custom unicode index 5 unicode_6 (Union[Unset, str]): Custom unicode index 6 unicode_7 (Union[Unset, str]): Custom unicode index 7 unicode_8 (Union[Unset, str]): Custom unicode index 8 unicode_9 (Union[Unset, str]): Custom unicode index 9 unicode_10 (Union[Unset, str]): Custom unicode index 10 number_1 (Union[Unset, float, int]): Custom number index 1 number_2 (Union[Unset, float, int]): Custom number index 2 value (Union['PatchDataJobValueType0', Unset, str]): Data value to store at this path

PatchDataJob( paths: List[str], unicode_1: Optional[str] = None, unicode_2: Optional[str] = None, unicode_3: Optional[str] = None, unicode_4: Optional[str] = None, unicode_5: Optional[str] = None, unicode_6: Optional[str] = None, unicode_7: Optional[str] = None, unicode_8: Optional[str] = None, unicode_9: Optional[str] = None, unicode_10: Optional[str] = None, number_1: Union[NoneType, float, int] = None, number_2: Union[NoneType, float, int] = None, value: Union[PatchDataJobValueType0, NoneType, str] = None)

Method generated by attrs for class PatchDataJob.

paths: List[str]
unicode_1: Optional[str]
unicode_2: Optional[str]
unicode_3: Optional[str]
unicode_4: Optional[str]
unicode_5: Optional[str]
unicode_6: Optional[str]
unicode_7: Optional[str]
unicode_8: Optional[str]
unicode_9: Optional[str]
unicode_10: Optional[str]
number_1: Union[NoneType, float, int]
number_2: Union[NoneType, float, int]
value: Union[PatchDataJobValueType0, NoneType, str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchDataJobValueType0:
PatchDataJobValueType0()

Method generated by attrs for class PatchDataJobValueType0.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchDeviceBody:

Update a device

Attributes: owner_id (Union[Unset, str]): ID of the device owner name (Union[Unset, str]): Name of the device manufacturer (Union[Unset, str]): Device manufacturer product (Union[Unset, str]): Product name site (Union[Unset, str]): Location of this device serial_number (Union[Unset, str]): Device serial number mac_address (Union[Unset, str]): MAC address of this device is_active (Union[Unset, bool]): (Admin only) Whether this device is active is_delete_protected (Union[Unset, bool]): Whether this device is delete protected locale (Union[Unset, str]): Locale of the device zoneinfo (Union[Unset, str]): Timezone of the device picture (Union[Unset, str]): URL of the device's picture tags (Union[Unset, List[str]]): List of tags on this account project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access custom_attributes (Union[Unset, PatchDeviceBodyCustomAttributes]): Custom attributes for this user restricted_custom_attributes (Union[Unset, PatchDeviceBodyRestrictedCustomAttributes]): Custom attributes only admins can update iot_scopes (Union[Unset, PatchDeviceBodyIotScopes]): PubSub permissions per IoT scope for this device

PatchDeviceBody( owner_id: Optional[str] = None, name: Optional[str] = None, manufacturer: Optional[str] = None, product: Optional[str] = None, site: Optional[str] = None, serial_number: Optional[str] = None, mac_address: Optional[str] = None, is_active: Optional[bool] = None, is_delete_protected: Optional[bool] = None, locale: Optional[str] = None, zoneinfo: Optional[str] = None, picture: Optional[str] = None, tags: Optional[List[str]] = None, project_permissions: Optional[ProjectAccessPermissions] = None, org_permissions: Optional[OrgAccessPermissions] = None, custom_attributes: Optional[PatchDeviceBodyCustomAttributes] = None, restricted_custom_attributes: Optional[PatchDeviceBodyRestrictedCustomAttributes] = None, iot_scopes: Optional[PatchDeviceBodyIotScopes] = None)

Method generated by attrs for class PatchDeviceBody.

owner_id: Optional[str]
name: Optional[str]
manufacturer: Optional[str]
product: Optional[str]
site: Optional[str]
serial_number: Optional[str]
mac_address: Optional[str]
is_active: Optional[bool]
is_delete_protected: Optional[bool]
locale: Optional[str]
zoneinfo: Optional[str]
picture: Optional[str]
tags: Optional[List[str]]
project_permissions: Optional[ProjectAccessPermissions]
org_permissions: Optional[OrgAccessPermissions]
custom_attributes: Optional[PatchDeviceBodyCustomAttributes]
restricted_custom_attributes: Optional[PatchDeviceBodyRestrictedCustomAttributes]
iot_scopes: Optional[PatchDeviceBodyIotScopes]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchDeviceBodyCustomAttributes:

Custom attributes for this user

PatchDeviceBodyCustomAttributes()

Method generated by attrs for class PatchDeviceBodyCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchDeviceBodyIotScopes:

PubSub permissions per IoT scope for this device

PatchDeviceBodyIotScopes()

Method generated by attrs for class PatchDeviceBodyIotScopes.

additional_properties: Dict[str, PubSubPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchDeviceBodyRestrictedCustomAttributes:

Custom attributes only admins can update

PatchDeviceBodyRestrictedCustomAttributes()

Method generated by attrs for class PatchDeviceBodyRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchEmailTemplateBody:

Which Template fields to include in request bodies

Attributes: from_address (Union[Unset, str]): From email address to use with this template description (Union[Unset, str]): Description of the template project_id (Union[Unset, str]): ID of the project this template belongs to, if any is_delete_protected (Union[Unset, bool]): This must be set false before the template can be deleted tags (Union[Unset, List[str]]): List of tags on this template custom_args (Union[Unset, List[str]]): List of custom arguments on this template for_account_recovery (Union[Unset, bool]): If true, the template is used for forgot password emails for_new_users (Union[Unset, bool]): If true, the template is used for new user emails locale (Union[Unset, str]): Locale for the template, defaults to project or org locale name (Union[Unset, str]): Name of the template subject (Union[Unset, str]): Subject of the template body_txt (Union[Unset, str]): Plain text body of the template body_html (Union[Unset, str]): HTML body of the template is_active (Union[Unset, bool]): If false, all template operations are disabled

PatchEmailTemplateBody( from_address: Optional[str] = None, description: Optional[str] = None, project_id: Optional[str] = None, is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, custom_args: Optional[List[str]] = None, for_account_recovery: Optional[bool] = None, for_new_users: Optional[bool] = None, locale: Optional[str] = None, name: Optional[str] = None, subject: Optional[str] = None, body_txt: Optional[str] = None, body_html: Optional[str] = None, is_active: Optional[bool] = None)

Method generated by attrs for class PatchEmailTemplateBody.

from_address: Optional[str]
description: Optional[str]
project_id: Optional[str]
is_delete_protected: Optional[bool]
tags: Optional[List[str]]
custom_args: Optional[List[str]]
for_account_recovery: Optional[bool]
for_new_users: Optional[bool]
locale: Optional[str]
name: Optional[str]
subject: Optional[str]
body_txt: Optional[str]
body_html: Optional[str]
is_active: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchFilesBody:

Which File fields to include in PATCH request bodies

Attributes: unicode_1 (Union[Unset, str]): Custom unicode index 1 unicode_2 (Union[Unset, str]): Custom unicode index 2 unicode_3 (Union[Unset, str]): Custom unicode index 3 unicode_4 (Union[Unset, str]): Custom unicode index 4 unicode_5 (Union[Unset, str]): Custom unicode index 5 unicode_6 (Union[Unset, str]): Custom unicode index 6 number_1 (Union[Unset, float, int]): Custom number index 1 number_2 (Union[Unset, float, int]): Custom number index 2 size (Union[Unset, int]): Size of file in bytes uploaded_date (Union[Unset, datetime.datetime]): Uploaded date of files to return etag (Union[Unset, str]): ETag of file

PatchFilesBody( unicode_1: Optional[str] = None, unicode_2: Optional[str] = None, unicode_3: Optional[str] = None, unicode_4: Optional[str] = None, unicode_5: Optional[str] = None, unicode_6: Optional[str] = None, number_1: Union[NoneType, float, int] = None, number_2: Union[NoneType, float, int] = None, size: Optional[int] = None, uploaded_date: Optional[datetime.datetime] = None, etag: Optional[str] = None)

Method generated by attrs for class PatchFilesBody.

unicode_1: Optional[str]
unicode_2: Optional[str]
unicode_3: Optional[str]
unicode_4: Optional[str]
unicode_5: Optional[str]
unicode_6: Optional[str]
number_1: Union[NoneType, float, int]
number_2: Union[NoneType, float, int]
size: Optional[int]
uploaded_date: Optional[datetime.datetime]
etag: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchGroupAccessBody:

Which GroupAccess fields to include in PATCH request bodies

Attributes: is_delete_protected (Union[Unset, bool]): This must be set false before the access can be deleted tags (Union[Unset, List[str]]): List of tags on this access object user_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions device_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions can_read (Union[Unset, bool]): If true, the grantee can read the target resource can_update (Union[Unset, bool]): If true, the grantee can update the target resource role_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions is_admin (Union[Unset, bool]): If true, the grantee has admin access to the group data_paths (Union[Unset, PatchGroupAccessBodyDataPaths]): Dictionary of accessible data paths and their CRUD permissions file_paths (Union[Unset, PatchGroupAccessBodyFilePaths]): Dictionary of accessible file paths and their CRUD permissions is_active (Union[Unset, bool]): If false, all group access operations are disabled

PatchGroupAccessBody( is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, user_permissions: Optional[CRUDPermissions] = None, device_permissions: Optional[CRUDPermissions] = None, can_read: Optional[bool] = None, can_update: Optional[bool] = None, role_permissions: Optional[CRUDPermissions] = None, is_admin: Optional[bool] = None, data_paths: Optional[PatchGroupAccessBodyDataPaths] = None, file_paths: Optional[PatchGroupAccessBodyFilePaths] = None, is_active: Optional[bool] = None)

Method generated by attrs for class PatchGroupAccessBody.

is_delete_protected: Optional[bool]
tags: Optional[List[str]]
user_permissions: Optional[CRUDPermissions]
device_permissions: Optional[CRUDPermissions]
can_read: Optional[bool]
can_update: Optional[bool]
role_permissions: Optional[CRUDPermissions]
is_admin: Optional[bool]
data_paths: Optional[PatchGroupAccessBodyDataPaths]
file_paths: Optional[PatchGroupAccessBodyFilePaths]
is_active: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchGroupAccessBodyDataPaths:

Dictionary of accessible data paths and their CRUD permissions

PatchGroupAccessBodyDataPaths()

Method generated by attrs for class PatchGroupAccessBodyDataPaths.

additional_properties: Dict[str, WRUDPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchGroupAccessBodyFilePaths:

Dictionary of accessible file paths and their CRUD permissions

PatchGroupAccessBodyFilePaths()

Method generated by attrs for class PatchGroupAccessBodyFilePaths.

additional_properties: Dict[str, WRUDPermissions]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchGroupBody:

Which Group fields to include in PATCH request bodies

Attributes: description (Union[Unset, str]): Description of the group is_delete_protected (Union[Unset, bool]): This must be set false before the group can be deleted tags (Union[Unset, List[str]]): List of tags on this group require_delete_permission_to_put_data (Union[Unset, bool]): (Admin only) If true, require delete permission to put data name (Union[Unset, str]): Name of the group is_active (Union[Unset, bool]): Whether this group is active

PatchGroupBody( description: Optional[str] = None, is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, require_delete_permission_to_put_data: Optional[bool] = None, name: Optional[str] = None, is_active: Optional[bool] = None)

Method generated by attrs for class PatchGroupBody.

description: Optional[str]
is_delete_protected: Optional[bool]
tags: Optional[List[str]]
require_delete_permission_to_put_data: Optional[bool]
name: Optional[str]
is_active: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchOrgSettingsBody:

Settings admins can update on their org

Attributes: name (Union[Unset, str]): Organization name description (Union[Unset, str]): Organization description device_owners_have_admin_access (Union[Unset, bool]): Device owners have admin access device_owners_can_tunnel (Union[Unset, bool]): Device owners can open tunnels device_creators_are_owners_by_default (Union[Unset, bool]): Device creators are owners by default project_delete_protection_on_by_default (Union[Unset, bool]): (Org admins only) Delete protection is on by default for new projects group_delete_protection_on_by_default (Union[Unset, bool]): Delete protection is on by default for new groups user_delete_protection_on_by_default (Union[Unset, bool]): Delete protection is on by default for new users device_delete_protection_on_by_default (Union[Unset, bool]): Delete protection is on by default for new devices mfa_required (Union[Unset, bool]): MFA is required for all users custom_settings (Union[Unset, PatchOrgSettingsBodyCustomSettings]): Dictionary of custom organization settings default_locale (Union[Unset, str]): Default locale for the organization default_from_address (Union[Unset, str]): Default from address for the organization reset_token_expire_hours (Union[Unset, int]): Number of hours reset tokens are valid (1-168) access_token_expire_hours (Union[Unset, int]): Number of hours access tokens are valid (1-24) refresh_token_expire_hours (Union[Unset, int]): Number of hours refresh tokens are valid (1-8760) session_expire_mins (Union[Unset, int]): Number of mins sessions are valid (3-15) pii_admin_only (Union[Unset, bool]): Only admins can view personally identifiable info is_delete_protected (Union[Unset, bool]): This must be set false before the org/project can be deleted

PatchOrgSettingsBody( name: Optional[str] = None, description: Optional[str] = None, device_owners_have_admin_access: Optional[bool] = None, device_owners_can_tunnel: Optional[bool] = None, device_creators_are_owners_by_default: Optional[bool] = None, project_delete_protection_on_by_default: Optional[bool] = None, group_delete_protection_on_by_default: Optional[bool] = None, user_delete_protection_on_by_default: Optional[bool] = None, device_delete_protection_on_by_default: Optional[bool] = None, mfa_required: Optional[bool] = None, custom_settings: Optional[PatchOrgSettingsBodyCustomSettings] = None, default_locale: Optional[str] = None, default_from_address: Optional[str] = None, reset_token_expire_hours: Optional[int] = None, access_token_expire_hours: Optional[int] = None, refresh_token_expire_hours: Optional[int] = None, session_expire_mins: Optional[int] = None, pii_admin_only: Optional[bool] = None, is_delete_protected: Optional[bool] = None)

Method generated by attrs for class PatchOrgSettingsBody.

name: Optional[str]
description: Optional[str]
device_owners_have_admin_access: Optional[bool]
device_owners_can_tunnel: Optional[bool]
device_creators_are_owners_by_default: Optional[bool]
project_delete_protection_on_by_default: Optional[bool]
group_delete_protection_on_by_default: Optional[bool]
user_delete_protection_on_by_default: Optional[bool]
device_delete_protection_on_by_default: Optional[bool]
mfa_required: Optional[bool]
custom_settings: Optional[PatchOrgSettingsBodyCustomSettings]
default_locale: Optional[str]
default_from_address: Optional[str]
reset_token_expire_hours: Optional[int]
access_token_expire_hours: Optional[int]
refresh_token_expire_hours: Optional[int]
session_expire_mins: Optional[int]
pii_admin_only: Optional[bool]
is_delete_protected: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchOrgSettingsBodyCustomSettings:

Dictionary of custom organization settings

PatchOrgSettingsBodyCustomSettings()

Method generated by attrs for class PatchOrgSettingsBodyCustomSettings.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchProjectAccessBody:

Which ProjectAccess fields to include in POST request bodies

Attributes: is_delete_protected (Union[Unset, bool]): This must be set false before the access can be deleted tags (Union[Unset, List[str]]): List of tags on this access object user_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions device_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions can_read (Union[Unset, bool]): If true, the grantee can read the target resource can_update (Union[Unset, bool]): If true, the grantee can update the target resource group_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions role_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions is_admin (Union[Unset, bool]): If true, the grantee has admin access to the project is_active (Union[Unset, bool]): If false, all project operations are disabled

PatchProjectAccessBody( is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, user_permissions: Optional[CRUDPermissions] = None, device_permissions: Optional[CRUDPermissions] = None, can_read: Optional[bool] = None, can_update: Optional[bool] = None, group_permissions: Optional[CRUDPermissions] = None, role_permissions: Optional[CRUDPermissions] = None, is_admin: Optional[bool] = None, is_active: Optional[bool] = None)

Method generated by attrs for class PatchProjectAccessBody.

is_delete_protected: Optional[bool]
tags: Optional[List[str]]
user_permissions: Optional[CRUDPermissions]
device_permissions: Optional[CRUDPermissions]
can_read: Optional[bool]
can_update: Optional[bool]
group_permissions: Optional[CRUDPermissions]
role_permissions: Optional[CRUDPermissions]
is_admin: Optional[bool]
is_active: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchProjectBody:

Patch project body

Attributes: alias (Union[Unset, str]): Unique alias for the project description (Union[Unset, str]): Description of the project is_delete_protected (Union[Unset, bool]): Must be false before the project can be deleted tags (Union[Unset, List[str]]): List of tags on this project reset_token_expire_hours (Union[Unset, int]): Number of hours reset tokens are valid (1-168) group_delete_protection_on_by_default (Union[Unset, bool]): If true, groups are delete-protected by default role_delete_protection_on_by_default (Union[Unset, bool]): If true, roles are delete-protected by default access_token_expire_hours (Union[Unset, int]): Number of hours access tokens are valid (1-24) refresh_token_expire_hours (Union[Unset, int]): Number of hours refresh tokens are valid (1-8760) session_expire_mins (Union[Unset, int]): Number of mins sessions are valid (3-15) ui_config (Union[Unset, InterfaceConfig]): Configuration for the user interface use_legacy_data_and_files_permissions (Union[Unset, bool]): If true, use legacy data and files permissions groups_require_delete_permission_to_put_data_by_default (Union[Unset, bool]): If true, groups require delete permission to delete data by default name (Union[Unset, str]): Name of the project is_active (Union[Unset, bool]): If false, all project operations are disabled default_locale (Union[Unset, str]): Default locale for the organization default_from_address (Union[Unset, str]): Default from address

PatchProjectBody( alias: Optional[str] = None, description: Optional[str] = None, is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, reset_token_expire_hours: Optional[int] = None, group_delete_protection_on_by_default: Optional[bool] = None, role_delete_protection_on_by_default: Optional[bool] = None, access_token_expire_hours: Optional[int] = None, refresh_token_expire_hours: Optional[int] = None, session_expire_mins: Optional[int] = None, ui_config: Optional[InterfaceConfig] = None, use_legacy_data_and_files_permissions: Optional[bool] = None, groups_require_delete_permission_to_put_data_by_default: Optional[bool] = None, name: Optional[str] = None, is_active: Optional[bool] = None, default_locale: Optional[str] = None, default_from_address: Optional[str] = None)

Method generated by attrs for class PatchProjectBody.

alias: Optional[str]
description: Optional[str]
is_delete_protected: Optional[bool]
tags: Optional[List[str]]
reset_token_expire_hours: Optional[int]
group_delete_protection_on_by_default: Optional[bool]
role_delete_protection_on_by_default: Optional[bool]
access_token_expire_hours: Optional[int]
refresh_token_expire_hours: Optional[int]
session_expire_mins: Optional[int]
ui_config: Optional[InterfaceConfig]
use_legacy_data_and_files_permissions: Optional[bool]
groups_require_delete_permission_to_put_data_by_default: Optional[bool]
name: Optional[str]
is_active: Optional[bool]
default_locale: Optional[str]
default_from_address: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchProjectSettingsBody:

Settings admins can update on their project

Attributes: name (Union[Unset, str]): Organization name description (Union[Unset, str]): Organization description device_owners_have_admin_access (Union[Unset, bool]): Device owners have admin access device_owners_can_tunnel (Union[Unset, bool]): Device owners can open tunnels device_creators_are_owners_by_default (Union[Unset, bool]): Device creators are owners by default group_delete_protection_on_by_default (Union[Unset, bool]): Delete protection is on by default for new groups user_delete_protection_on_by_default (Union[Unset, bool]): Delete protection is on by default for new users device_delete_protection_on_by_default (Union[Unset, bool]): Delete protection is on by default for new devices custom_settings (Union[Unset, PatchProjectSettingsBodyCustomSettings]): Dictionary of custom organization settings default_locale (Union[Unset, str]): Default locale for the organization default_from_address (Union[Unset, str]): Default from address for the organization pii_admin_only (Union[Unset, bool]): Only admins can view personally identifiable info is_delete_protected (Union[Unset, bool]): This must be set false before the org/project can be deleted reset_token_expire_hours (Union[Unset, int]): Number of hours reset tokens are valid (1-168) access_token_expire_hours (Union[Unset, int]): Number of hours access tokens are valid (1-24) refresh_token_expire_hours (Union[Unset, int]): Number of hours refresh tokens are valid (1-8760) session_expire_mins (Union[Unset, int]): Number of mins sessions are valid (3-15)

PatchProjectSettingsBody( name: Optional[str] = None, description: Optional[str] = None, device_owners_have_admin_access: Optional[bool] = None, device_owners_can_tunnel: Optional[bool] = None, device_creators_are_owners_by_default: Optional[bool] = None, group_delete_protection_on_by_default: Optional[bool] = None, user_delete_protection_on_by_default: Optional[bool] = None, device_delete_protection_on_by_default: Optional[bool] = None, custom_settings: Optional[PatchProjectSettingsBodyCustomSettings] = None, default_locale: Optional[str] = None, default_from_address: Optional[str] = None, pii_admin_only: Optional[bool] = None, is_delete_protected: Optional[bool] = None, reset_token_expire_hours: Optional[int] = None, access_token_expire_hours: Optional[int] = None, refresh_token_expire_hours: Optional[int] = None, session_expire_mins: Optional[int] = None)

Method generated by attrs for class PatchProjectSettingsBody.

name: Optional[str]
description: Optional[str]
device_owners_have_admin_access: Optional[bool]
device_owners_can_tunnel: Optional[bool]
device_creators_are_owners_by_default: Optional[bool]
group_delete_protection_on_by_default: Optional[bool]
user_delete_protection_on_by_default: Optional[bool]
device_delete_protection_on_by_default: Optional[bool]
custom_settings: Optional[PatchProjectSettingsBodyCustomSettings]
default_locale: Optional[str]
default_from_address: Optional[str]
pii_admin_only: Optional[bool]
is_delete_protected: Optional[bool]
reset_token_expire_hours: Optional[int]
access_token_expire_hours: Optional[int]
refresh_token_expire_hours: Optional[int]
session_expire_mins: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchProjectSettingsBodyCustomSettings:

Dictionary of custom organization settings

PatchProjectSettingsBodyCustomSettings()

Method generated by attrs for class PatchProjectSettingsBodyCustomSettings.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchRoleAccessBody:

Which RoleAccess fields to include in request bodies

Attributes: is_delete_protected (Union[Unset, bool]): This must be set false before the access can be deleted tags (Union[Unset, List[str]]): List of tags on this access object user_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions device_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions can_read (Union[Unset, bool]): If true, the grantee can read the target resource can_update (Union[Unset, bool]): If true, the grantee can update the target resource is_active (Union[Unset, bool]): If false, all role access operations are disabled

PatchRoleAccessBody( is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, user_permissions: Optional[CRUDPermissions] = None, device_permissions: Optional[CRUDPermissions] = None, can_read: Optional[bool] = None, can_update: Optional[bool] = None, is_active: Optional[bool] = None)

Method generated by attrs for class PatchRoleAccessBody.

is_delete_protected: Optional[bool]
tags: Optional[List[str]]
user_permissions: Optional[CRUDPermissions]
device_permissions: Optional[CRUDPermissions]
can_read: Optional[bool]
can_update: Optional[bool]
is_active: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchRoleBody:

Which Role fields to include in request bodies

Attributes: description (Union[Unset, str]): Description of the role is_delete_protected (Union[Unset, bool]): This must be set false before the role can be deleted tags (Union[Unset, List[str]]): List of tags on this role org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access custom_attributes (Union[Unset, PatchRoleBodyCustomAttributes]): Custom attributes for this user restricted_custom_attributes (Union[Unset, PatchRoleBodyRestrictedCustomAttributes]): Custom attributes only admins can update name (Union[Unset, str]): Name of the role is_active (Union[Unset, bool]): If false, all role operations are disabled

PatchRoleBody( description: Optional[str] = None, is_delete_protected: Optional[bool] = None, tags: Optional[List[str]] = None, org_permissions: Optional[OrgAccessPermissions] = None, project_permissions: Optional[ProjectAccessPermissions] = None, custom_attributes: Optional[PatchRoleBodyCustomAttributes] = None, restricted_custom_attributes: Optional[PatchRoleBodyRestrictedCustomAttributes] = None, name: Optional[str] = None, is_active: Optional[bool] = None)

Method generated by attrs for class PatchRoleBody.

description: Optional[str]
is_delete_protected: Optional[bool]
tags: Optional[List[str]]
org_permissions: Optional[OrgAccessPermissions]
project_permissions: Optional[ProjectAccessPermissions]
custom_attributes: Optional[PatchRoleBodyCustomAttributes]
restricted_custom_attributes: Optional[PatchRoleBodyRestrictedCustomAttributes]
name: Optional[str]
is_active: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchRoleBodyCustomAttributes:

Custom attributes for this user

PatchRoleBodyCustomAttributes()

Method generated by attrs for class PatchRoleBodyCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchRoleBodyRestrictedCustomAttributes:

Custom attributes only admins can update

PatchRoleBodyRestrictedCustomAttributes()

Method generated by attrs for class PatchRoleBodyRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchUserBody:

Patch user body

Attributes: username (Union[Unset, str]): Username of the user email (Union[Unset, str]): Email of the user phone_number (Union[Unset, str]): Phone number of the user is_delete_protected (Union[Unset, bool]): Whether this user is delete protected is_active (Union[Unset, bool]): Whether this user is active tags (Union[Unset, List[str]]): Tags for this user locale (Union[Unset, str]): Locale of the user zoneinfo (Union[Unset, str]): Zoneinfo of the user picture (Union[Unset, str]): URL of the user's picture nickname (Union[Unset, str]): Nickname of the user first_name (Union[Unset, str]): First (or given) name of the user middle_name (Union[Unset, str]): Middle name of the user last_name (Union[Unset, str]): Last (or family) name of the user project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access custom_attributes (Union[Unset, PatchUserBodyCustomAttributes]): Custom attributes for this user restricted_custom_attributes (Union[Unset, PatchUserBodyRestrictedCustomAttributes]): Custom attributes only admins can update

PatchUserBody( username: Optional[str] = None, email: Optional[str] = None, phone_number: Optional[str] = None, is_delete_protected: Optional[bool] = None, is_active: Optional[bool] = None, tags: Optional[List[str]] = None, locale: Optional[str] = None, zoneinfo: Optional[str] = None, picture: Optional[str] = None, nickname: Optional[str] = None, first_name: Optional[str] = None, middle_name: Optional[str] = None, last_name: Optional[str] = None, project_permissions: Optional[ProjectAccessPermissions] = None, org_permissions: Optional[OrgAccessPermissions] = None, custom_attributes: Optional[PatchUserBodyCustomAttributes] = None, restricted_custom_attributes: Optional[PatchUserBodyRestrictedCustomAttributes] = None)

Method generated by attrs for class PatchUserBody.

username: Optional[str]
email: Optional[str]
phone_number: Optional[str]
is_delete_protected: Optional[bool]
is_active: Optional[bool]
tags: Optional[List[str]]
locale: Optional[str]
zoneinfo: Optional[str]
picture: Optional[str]
nickname: Optional[str]
first_name: Optional[str]
middle_name: Optional[str]
last_name: Optional[str]
project_permissions: Optional[ProjectAccessPermissions]
org_permissions: Optional[OrgAccessPermissions]
custom_attributes: Optional[PatchUserBodyCustomAttributes]
restricted_custom_attributes: Optional[PatchUserBodyRestrictedCustomAttributes]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchUserBodyCustomAttributes:

Custom attributes for this user

PatchUserBodyCustomAttributes()

Method generated by attrs for class PatchUserBodyCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PatchUserBodyRestrictedCustomAttributes:

Custom attributes only admins can update

PatchUserBodyRestrictedCustomAttributes()

Method generated by attrs for class PatchUserBodyRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class ProjectAccessInfo:

Info on one specific project access

Attributes: project_access (ProjectAccessSchema): Which Project fields to include in response bodies

ProjectAccessInfo( project_access: ProjectAccessSchema)

Method generated by attrs for class ProjectAccessInfo.

project_access: ProjectAccessSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class ProjectAccessPermissions:

Collection of permissions for project access

Attributes: can_update (Union[Unset, bool]): Default: False. can_read (Union[Unset, bool]): Default: False. user_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions device_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions role_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions is_admin (Union[Unset, bool]): Default: False. group_permissions (Union[Unset, CRUDPermissions]): Collection of CRUD permissions

ProjectAccessPermissions( can_update: Optional[bool] = False, can_read: Optional[bool] = False, user_permissions: Optional[CRUDPermissions] = None, device_permissions: Optional[CRUDPermissions] = None, role_permissions: Optional[CRUDPermissions] = None, is_admin: Optional[bool] = False, group_permissions: Optional[CRUDPermissions] = None)

Method generated by attrs for class ProjectAccessPermissions.

can_update: Optional[bool]
can_read: Optional[bool]
user_permissions: Optional[CRUDPermissions]
device_permissions: Optional[CRUDPermissions]
role_permissions: Optional[CRUDPermissions]
is_admin: Optional[bool]
group_permissions: Optional[CRUDPermissions]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class ProjectAccessSchema:

Which Project fields to include in response bodies

Attributes: is_delete_protected (bool): This must be set false before the access can be deleted created_date (datetime.datetime): Date and time the access was created can_read (bool): If true, the account can read this access can_update (bool): If true, the account can update this access user_permissions (CRUDPermissions): Collection of CRUD permissions device_permissions (CRUDPermissions): Collection of CRUD permissions tags (List[str]): List of tags on this access object project_id (str): ID of the project grantee_id (str): ID of the account that has access to the project is_admin (bool): If true, the account has admin access to the project group_permissions (CRUDPermissions): Collection of CRUD permissions role_permissions (CRUDPermissions): Collection of CRUD permissions last_updated_date (Union[Unset, datetime.datetime]): Date and time the access was last updated created_by (Union[Unset, str]): ID of the account that created this access last_updated_by (Union[Unset, str]): ID of the account that last updated this access

ProjectAccessSchema( is_delete_protected: bool, created_date: datetime.datetime, can_read: bool, can_update: bool, user_permissions: CRUDPermissions, device_permissions: CRUDPermissions, tags: List[str], project_id: str, grantee_id: str, is_admin: bool, group_permissions: CRUDPermissions, role_permissions: CRUDPermissions, last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None)

Method generated by attrs for class ProjectAccessSchema.

is_delete_protected: bool
created_date: datetime.datetime
can_read: bool
can_update: bool
user_permissions: CRUDPermissions
device_permissions: CRUDPermissions
tags: List[str]
project_id: str
grantee_id: str
is_admin: bool
group_permissions: CRUDPermissions
role_permissions: CRUDPermissions
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
last_updated_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class ProjectInfo:

Info on one specific project

Attributes: project (ProjectSchema): Which Project fields to include in response bodies

ProjectInfo(project: ProjectSchema)

Method generated by attrs for class ProjectInfo.

project: ProjectSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class ProjectList:

List of projects

Attributes: projects (Union[Unset, List['ProjectSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

ProjectList( projects: Optional[List[ProjectSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class ProjectList.

projects: Optional[List[ProjectSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class ProjectSchema:

Which Project fields to include in response bodies

Attributes: name (str): created_date (datetime.datetime): id (str): ID of the project tags (List[str]): List of tags on this project ui_config (InterfaceConfig): Configuration for the user interface alias (Union[Unset, str]): description (Union[Unset, str]): Default: ''. allowed_login_fields (Union[Unset, ProjectSchemaAllowedLoginFields]): custom_settings (Union[Unset, ProjectSchemaCustomSettings]): device_owners_have_admin_access (Union[Unset, bool]): Default: False. device_owners_can_tunnel (Union[Unset, bool]): Default: False. device_creators_are_owners_by_default (Union[Unset, bool]): Default: False. group_delete_protection_on_by_default (Union[Unset, bool]): Default: False. role_delete_protection_on_by_default (Union[Unset, bool]): Default: False. is_delete_protected (Union[Unset, bool]): Default: False. is_active (Union[Unset, bool]): Default: True. last_updated_date (Union[Unset, datetime.datetime]): default_locale (Union[Unset, str]): default_from_address (Union[Unset, str]): reset_token_expire_hours (Union[Unset, int]): Default: 24. access_token_expire_hours (Union[Unset, int]): Default: 1. refresh_token_expire_hours (Union[Unset, int]): Default: 24. session_expire_mins (Union[Unset, int]): Default: 5. pii_admin_only (Union[Unset, bool]): Default: False. use_legacy_data_and_files_permissions (Union[Unset, bool]): Default: False. groups_require_delete_permission_to_put_data_by_default (Union[Unset, bool]): Default: False.

ProjectSchema( name: str, created_date: datetime.datetime, id: str, tags: List[str], ui_config: InterfaceConfig, alias: Optional[str] = None, description: Optional[str] = '', allowed_login_fields: Optional[ProjectSchemaAllowedLoginFields] = None, custom_settings: Optional[ProjectSchemaCustomSettings] = None, device_owners_have_admin_access: Optional[bool] = False, device_owners_can_tunnel: Optional[bool] = False, device_creators_are_owners_by_default: Optional[bool] = False, group_delete_protection_on_by_default: Optional[bool] = False, role_delete_protection_on_by_default: Optional[bool] = False, is_delete_protected: Optional[bool] = False, is_active: Optional[bool] = True, last_updated_date: Optional[datetime.datetime] = None, default_locale: Optional[str] = None, default_from_address: Optional[str] = None, reset_token_expire_hours: Optional[int] = 24, access_token_expire_hours: Optional[int] = 1, refresh_token_expire_hours: Optional[int] = 24, session_expire_mins: Optional[int] = 5, pii_admin_only: Optional[bool] = False, use_legacy_data_and_files_permissions: Optional[bool] = False, groups_require_delete_permission_to_put_data_by_default: Optional[bool] = False)

Method generated by attrs for class ProjectSchema.

name: str
created_date: datetime.datetime
id: str
tags: List[str]
ui_config: InterfaceConfig
alias: Optional[str]
description: Optional[str]
allowed_login_fields: Optional[ProjectSchemaAllowedLoginFields]
custom_settings: Optional[ProjectSchemaCustomSettings]
device_owners_have_admin_access: Optional[bool]
device_owners_can_tunnel: Optional[bool]
device_creators_are_owners_by_default: Optional[bool]
group_delete_protection_on_by_default: Optional[bool]
role_delete_protection_on_by_default: Optional[bool]
is_delete_protected: Optional[bool]
is_active: Optional[bool]
last_updated_date: Optional[datetime.datetime]
default_locale: Optional[str]
default_from_address: Optional[str]
reset_token_expire_hours: Optional[int]
access_token_expire_hours: Optional[int]
refresh_token_expire_hours: Optional[int]
session_expire_mins: Optional[int]
pii_admin_only: Optional[bool]
use_legacy_data_and_files_permissions: Optional[bool]
groups_require_delete_permission_to_put_data_by_default: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class ProjectSchemaAllowedLoginFields:
ProjectSchemaAllowedLoginFields()

Method generated by attrs for class ProjectSchemaAllowedLoginFields.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class ProjectSchemaCustomSettings:
ProjectSchemaCustomSettings()

Method generated by attrs for class ProjectSchemaCustomSettings.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PubSubPermissions:

Publish/subscribe permissions for a given scope

Attributes: can_publish (Union[Unset, bool]): Default: False. can_subscribe (Union[Unset, bool]): Default: False.

PubSubPermissions( can_publish: Optional[bool] = False, can_subscribe: Optional[bool] = False)

Method generated by attrs for class PubSubPermissions.

can_publish: Optional[bool]
can_subscribe: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PutFilesBody:

Which File fields to include in PUT request bodies

Attributes: unicode_1 (Union[Unset, str]): Custom unicode index 1 unicode_2 (Union[Unset, str]): Custom unicode index 2 unicode_3 (Union[Unset, str]): Custom unicode index 3 unicode_4 (Union[Unset, str]): Custom unicode index 4 unicode_5 (Union[Unset, str]): Custom unicode index 5 unicode_6 (Union[Unset, str]): Custom unicode index 6 number_1 (Union[Unset, float, int]): Custom number index 1 number_2 (Union[Unset, float, int]): Custom number index 2 expires_in (Union[Unset, int]): Number of seconds before presigned URLs expire Default: 3600. content_type (Union[Unset, str]): Optionally specify the content type of the file you will upload num_parts (Union[Unset, int]): Number of parts to upload completed_upload_id (Union[Unset, str]): ID of completed multipart upload to merge etag_by_part (Union[Unset, PutFilesBodyEtagByPart]): List of ETags for each part of the multipart upload

PutFilesBody( unicode_1: Optional[str] = None, unicode_2: Optional[str] = None, unicode_3: Optional[str] = None, unicode_4: Optional[str] = None, unicode_5: Optional[str] = None, unicode_6: Optional[str] = None, number_1: Union[NoneType, float, int] = None, number_2: Union[NoneType, float, int] = None, expires_in: Optional[int] = 3600, content_type: Optional[str] = None, num_parts: Optional[int] = None, completed_upload_id: Optional[str] = None, etag_by_part: Optional[PutFilesBodyEtagByPart] = None)

Method generated by attrs for class PutFilesBody.

unicode_1: Optional[str]
unicode_2: Optional[str]
unicode_3: Optional[str]
unicode_4: Optional[str]
unicode_5: Optional[str]
unicode_6: Optional[str]
number_1: Union[NoneType, float, int]
number_2: Union[NoneType, float, int]
expires_in: Optional[int]
content_type: Optional[str]
num_parts: Optional[int]
completed_upload_id: Optional[str]
etag_by_part: Optional[PutFilesBodyEtagByPart]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class PutFilesBodyEtagByPart:

List of ETags for each part of the multipart upload

PutFilesBodyEtagByPart()

Method generated by attrs for class PutFilesBodyEtagByPart.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RoleAccessInfo:

Info on one specific role access

Attributes: role_access (RoleAccessSchema): Role access schema

RoleAccessInfo(role_access: RoleAccessSchema)

Method generated by attrs for class RoleAccessInfo.

role_access: RoleAccessSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RoleAccessSchema:

Role access schema

Attributes: is_delete_protected (bool): This must be set false before the access can be deleted created_date (datetime.datetime): Date and time the access was created can_read (bool): If true, the account can read this access can_update (bool): If true, the account can update this access user_permissions (CRUDPermissions): Collection of CRUD permissions device_permissions (CRUDPermissions): Collection of CRUD permissions tags (List[str]): List of tags on this access object role_id (str): ID of the role that has access account_id (str): ID of the account that has access to the role last_updated_date (Union[Unset, datetime.datetime]): Date and time the access was last updated created_by (Union[Unset, str]): ID of the account that created this access last_updated_by (Union[Unset, str]): ID of the account that last updated this access

RoleAccessSchema( is_delete_protected: bool, created_date: datetime.datetime, can_read: bool, can_update: bool, user_permissions: CRUDPermissions, device_permissions: CRUDPermissions, tags: List[str], role_id: str, account_id: str, last_updated_date: Optional[datetime.datetime] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None)

Method generated by attrs for class RoleAccessSchema.

is_delete_protected: bool
created_date: datetime.datetime
can_read: bool
can_update: bool
user_permissions: CRUDPermissions
device_permissions: CRUDPermissions
tags: List[str]
role_id: str
account_id: str
last_updated_date: Optional[datetime.datetime]
created_by: Optional[str]
last_updated_by: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RoleGroupAccessList:

List of group access for the target role

Attributes: group_access (Union[Unset, List['AccountGroupAccessSchema']]): group_ids (Union[Unset, List[str]]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

RoleGroupAccessList( group_access: Optional[List[AccountGroupAccessSchema]] = None, group_ids: Optional[List[str]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class RoleGroupAccessList.

group_access: Optional[List[AccountGroupAccessSchema]]
group_ids: Optional[List[str]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RoleInfo:

Info on one specific role

Attributes: role (RoleSchema): Which Role fields to include in response bodies

RoleInfo(role: RoleSchema)

Method generated by attrs for class RoleInfo.

role: RoleSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RoleList:

List of roles

Attributes: roles (Union[Unset, List['RoleSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

RoleList( roles: Optional[List[RoleSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class RoleList.

roles: Optional[List[RoleSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RoleOrgAccessInfo:

Organization access info for the target role

Attributes: org_access (OrgAccessSchema): Access for an organization

RoleOrgAccessInfo(org_access: OrgAccessSchema)

Method generated by attrs for class RoleOrgAccessInfo.

org_access: OrgAccessSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RoleProjectAccessList:

List of project access for the target role

Attributes: project_access (Union[Unset, List['AccountProjectAccessSchema']]): project_ids (Union[Unset, List[str]]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

RoleProjectAccessList( project_access: Optional[List[AccountProjectAccessSchema]] = None, project_ids: Optional[List[str]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class RoleProjectAccessList.

project_access: Optional[List[AccountProjectAccessSchema]]
project_ids: Optional[List[str]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RoleSchema:

Which Role fields to include in response bodies

Attributes: id (str): ID of the role name (str): Name of the role description (str): Description of the role is_delete_protected (bool): This must be set false before the role can be deleted is_org_admin (bool): Whether this user is an org admin tags (List[str]): Tags for this role created_date (datetime.datetime): UTC datetime the account was created restricted_custom_attributes (RoleSchemaRestrictedCustomAttributes): Custom attributes only admins can update created_by (Union[Unset, str]): ID of the user who created this account last_updated_by (Union[Unset, str]): ID of the user who last updated this account last_updated_date (Union[Unset, datetime.datetime]): UTC datetime the account was last updated project_id (Union[Unset, str]): ID of the project this group belongs to, if any is_project_admin (Union[Unset, bool]): Whether this user is a project admin, only visible in project scope is_group_admin (Union[Unset, bool]): Whether this user is a group admin, only visible when filtered by group custom_attributes (Union[Unset, RoleSchemaCustomAttributes]): Custom attributes for this user project_ids (Union[Unset, List[str]]): Projects they belong to, individual roles only group_ids (Union[Unset, List[str]]): Groups they belong to, individual roles only project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access

RoleSchema( id: str, name: str, description: str, is_delete_protected: bool, is_org_admin: bool, tags: List[str], created_date: datetime.datetime, restricted_custom_attributes: RoleSchemaRestrictedCustomAttributes, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, last_updated_date: Optional[datetime.datetime] = None, project_id: Optional[str] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None, custom_attributes: Optional[RoleSchemaCustomAttributes] = None, project_ids: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, project_permissions: Optional[ProjectAccessPermissions] = None, org_permissions: Optional[OrgAccessPermissions] = None)

Method generated by attrs for class RoleSchema.

id: str
name: str
description: str
is_delete_protected: bool
is_org_admin: bool
tags: List[str]
created_date: datetime.datetime
restricted_custom_attributes: RoleSchemaRestrictedCustomAttributes
created_by: Optional[str]
last_updated_by: Optional[str]
last_updated_date: Optional[datetime.datetime]
project_id: Optional[str]
is_project_admin: Optional[bool]
is_group_admin: Optional[bool]
custom_attributes: Optional[RoleSchemaCustomAttributes]
project_ids: Optional[List[str]]
group_ids: Optional[List[str]]
project_permissions: Optional[ProjectAccessPermissions]
org_permissions: Optional[OrgAccessPermissions]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RoleSchemaCustomAttributes:

Custom attributes for this user

RoleSchemaCustomAttributes()

Method generated by attrs for class RoleSchemaCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class RoleSchemaRestrictedCustomAttributes:

Custom attributes only admins can update

RoleSchemaRestrictedCustomAttributes()

Method generated by attrs for class RoleSchemaRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class SmsMfaAdded:

MFA SMS token success

Attributes: message (Union[Unset, str]): Default: 'SMS MFA successfully enabled'. recovery_code (Union[Unset, str]): SMS MFA recovery code

SmsMfaAdded( message: Optional[str] = 'SMS MFA successfully enabled', recovery_code: Optional[str] = None)

Method generated by attrs for class SmsMfaAdded.

message: Optional[str]
recovery_code: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class SoftwareMfaAdded:

MFA software token success

Attributes: recovery_code (str): Software MFA recovery code message (Union[Unset, str]): Default: 'Software MFA successfully enabled'. session (Union[Unset, str]): Session to use for answering MFA_SETUP challenge

SoftwareMfaAdded( recovery_code: str, message: Optional[str] = 'Software MFA successfully enabled', session: Optional[str] = None)

Method generated by attrs for class SoftwareMfaAdded.

recovery_code: str
message: Optional[str]
session: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class Success:

Success response base schema

Attributes: message (Union[Unset, str]): Success message Default: 'Success'.

Success(message: Optional[str] = 'Success')

Method generated by attrs for class Success.

message: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class TokenInfo:

Token info

Attributes: access_token (str): Access token token_type (str): Token type expires_in (int): Access token expiration time in seconds refresh_token (Union[Unset, str]): Refresh token

TokenInfo( access_token: str, token_type: str, expires_in: int, refresh_token: Optional[str] = None)

Method generated by attrs for class TokenInfo.

access_token: str
token_type: str
expires_in: int
refresh_token: Optional[str]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class Tunnel:

Attributes: uuid (Union[Unset, str]): UUID of the IoT tunnel opened_date (Union[Unset, datetime.datetime]): UTC datetime the tunnel was opened opened_by (Union[Unset, str]): ID of the user who opened the tunnel timeout (Union[Unset, int]): Timeout in seconds for this tunnel

Tunnel( uuid: Optional[str] = None, opened_date: Optional[datetime.datetime] = None, opened_by: Optional[str] = None, timeout: Optional[int] = None)

Method generated by attrs for class Tunnel.

uuid: Optional[str]
opened_date: Optional[datetime.datetime]
opened_by: Optional[str]
timeout: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class TunnelInfo:

Info on one specific tunnel

Attributes: tunnel (Tunnel):

TunnelInfo(tunnel: Tunnel)

Method generated by attrs for class TunnelInfo.

tunnel: Tunnel
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class TunnelList:

List of tunnels

Attributes: tunnels (List['Tunnel']):

TunnelList(tunnels: List[Tunnel])

Method generated by attrs for class TunnelList.

tunnels: List[Tunnel]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class UploadDataBody:

PUT/PATCH group data

Attributes: value (Union['UploadDataBodyValueType0', str]): Data value to store at this path unicode_1 (Union[Unset, str]): Custom unicode index 1 unicode_2 (Union[Unset, str]): Custom unicode index 2 unicode_3 (Union[Unset, str]): Custom unicode index 3 unicode_4 (Union[Unset, str]): Custom unicode index 4 unicode_5 (Union[Unset, str]): Custom unicode index 5 unicode_6 (Union[Unset, str]): Custom unicode index 6 unicode_7 (Union[Unset, str]): Custom unicode index 7 unicode_8 (Union[Unset, str]): Custom unicode index 8 unicode_9 (Union[Unset, str]): Custom unicode index 9 unicode_10 (Union[Unset, str]): Custom unicode index 10 number_1 (Union[Unset, float, int]): Custom number index 1 number_2 (Union[Unset, float, int]): Custom number index 2

UploadDataBody( value: Union[UploadDataBodyValueType0, str], unicode_1: Optional[str] = None, unicode_2: Optional[str] = None, unicode_3: Optional[str] = None, unicode_4: Optional[str] = None, unicode_5: Optional[str] = None, unicode_6: Optional[str] = None, unicode_7: Optional[str] = None, unicode_8: Optional[str] = None, unicode_9: Optional[str] = None, unicode_10: Optional[str] = None, number_1: Union[NoneType, float, int] = None, number_2: Union[NoneType, float, int] = None)

Method generated by attrs for class UploadDataBody.

value: Union[UploadDataBodyValueType0, str]
unicode_1: Optional[str]
unicode_2: Optional[str]
unicode_3: Optional[str]
unicode_4: Optional[str]
unicode_5: Optional[str]
unicode_6: Optional[str]
unicode_7: Optional[str]
unicode_8: Optional[str]
unicode_9: Optional[str]
unicode_10: Optional[str]
number_1: Union[NoneType, float, int]
number_2: Union[NoneType, float, int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class UploadDataBodyValueType0:
UploadDataBodyValueType0()

Method generated by attrs for class UploadDataBodyValueType0.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class UploadDataJob:

Represents a single POST in a bulk request

Attributes: value (Union['UploadDataJobValueType0', str]): Data value to store at this path paths (List[str]): Paths to create unicode_1 (Union[Unset, str]): Custom unicode index 1 unicode_2 (Union[Unset, str]): Custom unicode index 2 unicode_3 (Union[Unset, str]): Custom unicode index 3 unicode_4 (Union[Unset, str]): Custom unicode index 4 unicode_5 (Union[Unset, str]): Custom unicode index 5 unicode_6 (Union[Unset, str]): Custom unicode index 6 unicode_7 (Union[Unset, str]): Custom unicode index 7 unicode_8 (Union[Unset, str]): Custom unicode index 8 unicode_9 (Union[Unset, str]): Custom unicode index 9 unicode_10 (Union[Unset, str]): Custom unicode index 10 number_1 (Union[Unset, float, int]): Custom number index 1 number_2 (Union[Unset, float, int]): Custom number index 2

UploadDataJob( value: Union[UploadDataJobValueType0, str], paths: List[str], unicode_1: Optional[str] = None, unicode_2: Optional[str] = None, unicode_3: Optional[str] = None, unicode_4: Optional[str] = None, unicode_5: Optional[str] = None, unicode_6: Optional[str] = None, unicode_7: Optional[str] = None, unicode_8: Optional[str] = None, unicode_9: Optional[str] = None, unicode_10: Optional[str] = None, number_1: Union[NoneType, float, int] = None, number_2: Union[NoneType, float, int] = None)

Method generated by attrs for class UploadDataJob.

value: Union[UploadDataJobValueType0, str]
paths: List[str]
unicode_1: Optional[str]
unicode_2: Optional[str]
unicode_3: Optional[str]
unicode_4: Optional[str]
unicode_5: Optional[str]
unicode_6: Optional[str]
unicode_7: Optional[str]
unicode_8: Optional[str]
unicode_9: Optional[str]
unicode_10: Optional[str]
number_1: Union[NoneType, float, int]
number_2: Union[NoneType, float, int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class UploadDataJobValueType0:
UploadDataJobValueType0()

Method generated by attrs for class UploadDataJobValueType0.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class UserInfo:

Info on one specific user

Attributes: user (UserSchema): Which User fields to include in response bodies

UserInfo(user: UserSchema)

Method generated by attrs for class UserInfo.

user: UserSchema
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class UserList:

List of users

Attributes: users (Union[Unset, List['UserSchema']]): page_count (Union[Unset, int]): object_count (Union[Unset, int]):

UserList( users: Optional[List[UserSchema]] = None, page_count: Optional[int] = None, object_count: Optional[int] = None)

Method generated by attrs for class UserList.

users: Optional[List[UserSchema]]
page_count: Optional[int]
object_count: Optional[int]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class UserSchema:

Which User fields to include in response bodies

Attributes: locale (str): zoneinfo (str): username (str): email (str): id (str): ID of the account created_date (datetime.datetime): UTC datetime the account was created tags (List[str]): Tags for this user custom_attributes (UserSchemaCustomAttributes): Custom attributes for this user restricted_custom_attributes (UserSchemaRestrictedCustomAttributes): Custom attributes only admins can update mfa_enabled (bool): Whether MFA is enabled for this user sms_mfa_enabled (bool): Whether SMS MFA is enabled for this user software_mfa_enabled (bool): Whether software MFA is enabled for this user is_delete_protected (Union[Unset, bool]): Default: False. picture (Union[Unset, str]): picture_base64 (Union[Unset, str]): picture_content_type (Union[Unset, str]): password_last_changed (Union[Unset, datetime.datetime]): phone_number (Union[Unset, str]): phone_number_verified (Union[Unset, bool]): Default: False. nickname (Union[Unset, str]): first_name (Union[Unset, str]): middle_name (Union[Unset, str]): last_name (Union[Unset, str]): is_org_admin (Union[Unset, bool]): Default: False. new_password_required (Union[Unset, bool]): Default: False. has_temporary_password (Union[Unset, bool]): Default: False. created_by (Union[Unset, str]): ID of the user who created this account last_updated_by (Union[Unset, str]): ID of the user who last updated this account last_updated_date (Union[Unset, datetime.datetime]): UTC datetime the account was last updated last_seen (Union[Unset, datetime.datetime]): UTC datetime the user was last seen preferred_mfa (Union[Unset, str]): Preferred MFA method for this user is_project_admin (Union[Unset, bool]): Whether this user is a project admin, only visible when filtered by project is_group_admin (Union[Unset, bool]): Whether this user is a group admin, only visible when filtered by group project_permissions (Union[Unset, ProjectAccessPermissions]): Collection of permissions for project access org_permissions (Union[Unset, OrgAccessPermissions]): Collection of permissions for org access project_ids (Union[Unset, List[str]]): Projects they belong to, individual users only group_ids (Union[Unset, List[str]]): Groups they belong to, individual users only role_ids (Union[Unset, List[str]]): Roles they belong to, individual users only

UserSchema( locale: str, zoneinfo: str, username: str, email: str, id: str, created_date: datetime.datetime, tags: List[str], custom_attributes: UserSchemaCustomAttributes, restricted_custom_attributes: UserSchemaRestrictedCustomAttributes, mfa_enabled: bool, sms_mfa_enabled: bool, software_mfa_enabled: bool, is_delete_protected: Optional[bool] = False, picture: Optional[str] = None, picture_base64: Optional[str] = None, picture_content_type: Optional[str] = None, password_last_changed: Optional[datetime.datetime] = None, phone_number: Optional[str] = None, phone_number_verified: Optional[bool] = False, nickname: Optional[str] = None, first_name: Optional[str] = None, middle_name: Optional[str] = None, last_name: Optional[str] = None, is_org_admin: Optional[bool] = False, new_password_required: Optional[bool] = False, has_temporary_password: Optional[bool] = False, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, last_updated_date: Optional[datetime.datetime] = None, last_seen: Optional[datetime.datetime] = None, preferred_mfa: Optional[str] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None, project_permissions: Optional[ProjectAccessPermissions] = None, org_permissions: Optional[OrgAccessPermissions] = None, project_ids: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, role_ids: Optional[List[str]] = None)

Method generated by attrs for class UserSchema.

locale: str
zoneinfo: str
username: str
email: str
id: str
created_date: datetime.datetime
tags: List[str]
custom_attributes: UserSchemaCustomAttributes
restricted_custom_attributes: UserSchemaRestrictedCustomAttributes
mfa_enabled: bool
sms_mfa_enabled: bool
software_mfa_enabled: bool
is_delete_protected: Optional[bool]
picture: Optional[str]
picture_base64: Optional[str]
picture_content_type: Optional[str]
password_last_changed: Optional[datetime.datetime]
phone_number: Optional[str]
phone_number_verified: Optional[bool]
nickname: Optional[str]
first_name: Optional[str]
middle_name: Optional[str]
last_name: Optional[str]
is_org_admin: Optional[bool]
new_password_required: Optional[bool]
has_temporary_password: Optional[bool]
created_by: Optional[str]
last_updated_by: Optional[str]
last_updated_date: Optional[datetime.datetime]
last_seen: Optional[datetime.datetime]
preferred_mfa: Optional[str]
is_project_admin: Optional[bool]
is_group_admin: Optional[bool]
project_permissions: Optional[ProjectAccessPermissions]
org_permissions: Optional[OrgAccessPermissions]
project_ids: Optional[List[str]]
group_ids: Optional[List[str]]
role_ids: Optional[List[str]]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class UserSchemaCustomAttributes:

Custom attributes for this user

UserSchemaCustomAttributes()

Method generated by attrs for class UserSchemaCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class UserSchemaRestrictedCustomAttributes:

Custom attributes only admins can update

UserSchemaRestrictedCustomAttributes()

Method generated by attrs for class UserSchemaRestrictedCustomAttributes.

additional_properties: Dict[str, str]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class VerifyAccountSmsBody:

Verify account SMS body

Attributes: verification_code (str): Verification code

VerifyAccountSmsBody(verification_code: str)

Method generated by attrs for class VerifyAccountSmsBody.

verification_code: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class VersionInfo:

Version info for the system

Attributes: version (str): Version of the API, formatted as major.minor.patch

VersionInfo(version: str)

Method generated by attrs for class VersionInfo.

version: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class WidgetInfo:

Configuration for a single widget on the dashboard

Attributes: order (int): Order in which to display the widget widget_type (str): Type of widget to display widget_title (str): Title of the widget config (WidgetInfoConfig): Settings for the widget

WidgetInfo( order: int, widget_type: str, widget_title: str, config: WidgetInfoConfig)

Method generated by attrs for class WidgetInfo.

order: int
widget_type: str
widget_title: str
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class WidgetInfoConfig:

Settings for the widget

WidgetInfoConfig()

Method generated by attrs for class WidgetInfoConfig.

additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]
class WRUDPermissions:

Collection of permissions, only for write, read, delete

Attributes: can_write (Union[Unset, bool]): Default: False. can_read (Union[Unset, bool]): Default: False. can_update (Union[Unset, bool]): Default: False. can_delete (Union[Unset, bool]): Default: False.

WRUDPermissions( can_write: Optional[bool] = False, can_read: Optional[bool] = False, can_update: Optional[bool] = False, can_delete: Optional[bool] = False)

Method generated by attrs for class WRUDPermissions.

can_write: Optional[bool]
can_read: Optional[bool]
can_update: Optional[bool]
can_delete: Optional[bool]
additional_properties: Dict[str, Any]
def to_dict(self) -> Dict[str, Any]:
@classmethod
def from_dict(cls: Type[~T], src_dict: Dict[str, Any]) -> ~T:
additional_keys: List[str]