Skip to content

Role models

Request and response types for the Role API.

models

Classes:

RoleCreate

Bases: BaseModelWithConfig

Attributes:

applications class-attribute instance-attribute

applications: list[str] | None = None

device class-attribute instance-attribute

device: PermissionObject | None = None

gateway class-attribute instance-attribute

gateway: PermissionObject | None = None

name instance-attribute

name: str

user class-attribute instance-attribute

user: PermissionObject | None = None

users class-attribute instance-attribute

users: list[str] | None = None

RoleCreateResponse

Bases: BaseModelWithConfig

Attributes:

id instance-attribute

id: str

RoleError

Bases: BaseModelWithConfig

Attributes:

response instance-attribute

response: bool

RoleInstance

Bases: BaseModelWithConfig

Attributes:

applications instance-attribute

applications: list[str]

device instance-attribute

device: PermissionObject | None

gateway instance-attribute

gateway: PermissionObject | None

id instance-attribute

id: str

name instance-attribute

name: str

user instance-attribute

user: PermissionObject | None

users instance-attribute

users: list[str]

RolePatch

Bases: BaseModelWithConfig

Attributes:

applications class-attribute instance-attribute

applications: list[str] | None = None

device class-attribute instance-attribute

device: PermissionObject | None = None

gateway class-attribute instance-attribute

gateway: PermissionObject | None = None

name class-attribute instance-attribute

name: str | None = None

user class-attribute instance-attribute

user: PermissionObject | None = None

users class-attribute instance-attribute

users: list[str] | None = None

RoleResponse

Bases: BaseModelWithConfig

Attributes:

roles instance-attribute

RoleUpdate

Bases: BaseModelWithConfig

Attributes:

applications instance-attribute

applications: list[str] | None

device instance-attribute

device: PermissionObject | None

gateway instance-attribute

gateway: PermissionObject | None

name instance-attribute

name: str

user instance-attribute

user: PermissionObject | None

users instance-attribute

users: list[str] | None