The permissions.py module

Summary

Classes

Resource	Provides the schema for the resource type.
Subject	Provides the schema for the subject type.
RoleAssignment	Provides the schema for the role assigned to the user.
RoleQuery	Provides the schema for querying the role of the user.

Enums

ResourceType	Resource type schema.
RoleType	Provides the role type schema for the role of the user.
SubjectType	Provides the subject type schema for the user or group.

Description

Provides the schemas for resource type, role type, and subject type.

Permission functionality related RoleAssignment and RoleQuery schema.

Module detail

class permissions.Resource(/, **data: Any)

Provides the schema for the resource type.

Overview

Attributes

path
type

Import detail

from ansys.hps.data_transfer.client.models.permissions import Resource

Attribute detail

Resource.path: str | None = 'my/path/to/data/file.txt'

Resource.type: ResourceType | None = None

class Resource.Subject(/, **data: Any)

Provides the schema for the subject type.

Overview

Attributes

id
type

Import detail

from ansys.hps.data_transfer.client.models.permissions import Subject

Attribute detail

Subject.id: str | None = '946991ec-828c-4de4-acbe-962ada8bc441'

Subject.type: SubjectType | None = None

class Subject.RoleAssignment(/, **data: Any)

Provides the schema for the role assigned to the user.

Overview

Attributes

resource
role
subject

Import detail

from ansys.hps.data_transfer.client.models.permissions import RoleAssignment

Attribute detail

RoleAssignment.resource: Resource | None = None

RoleAssignment.role: RoleType | None = None

RoleAssignment.subject: Subject | None = None

class RoleAssignment.RoleQuery(/, **data: Any)

Provides the schema for querying the role of the user.

Overview

Attributes

resource
role
subject

Import detail

from ansys.hps.data_transfer.client.models.permissions import RoleQuery

Attribute detail

RoleQuery.resource: Resource | None = None

RoleQuery.role: RoleType | None = None

RoleQuery.subject: Subject | None = None

class RoleQuery.ResourceType(*args, **kwds)

Resource type schema.

Overview

Attributes

Doc

Import detail

from ansys.hps.data_transfer.client.models.permissions import ResourceType

Attribute detail

ResourceType.Doc = 'document'

class ResourceType.RoleType(*args, **kwds)

Provides the role type schema for the role of the user.

Overview

Attributes

Reader
Writer
Admin

Import detail

from ansys.hps.data_transfer.client.models.permissions import RoleType

Attribute detail

RoleType.Reader = 'reader'

RoleType.Writer = 'writer'

RoleType.Admin = 'admin'

class RoleType.SubjectType(*args, **kwds)

Provides the subject type schema for the user or group.

Overview

Attributes

User
Group
Any

Import detail

from ansys.hps.data_transfer.client.models.permissions import SubjectType

Attribute detail

SubjectType.User = 'user'

SubjectType.Group = 'group'

SubjectType.Any = 'any'