Skip to content

ACL

albert.resources.acls

AccessControlLevel

Bases: str, Enum

Access control levels you can grant users.

Attributes:

Name Type Description
PROJECT_OWNER
PROJECT_EDITOR
PROJECT_VIEWER
PROJECT_ALL_TASKS
PROJECT_STRICT_VIEWER
PROJECT_PROPERTY_TASKS
INVENTORY_OWNER
INVENTORY_VIEWER
CUSTOM_TEMPLATE_OWNER
CUSTOM_TEMPLATE_VIEWER
CAS_FULL_ACCESS

PROJECT_OWNER

PROJECT_OWNER = 'ProjectOwner'

PROJECT_EDITOR

PROJECT_EDITOR = 'ProjectEditor'

PROJECT_VIEWER

PROJECT_VIEWER = 'ProjectViewer'

PROJECT_ALL_TASKS

PROJECT_ALL_TASKS = 'ProjectAllTask'

PROJECT_STRICT_VIEWER

PROJECT_STRICT_VIEWER = 'ProjectStrictViewer'

PROJECT_PROPERTY_TASKS

PROJECT_PROPERTY_TASKS = 'ProjectPropertyTask'

INVENTORY_OWNER

INVENTORY_OWNER = 'InventoryOwner'

INVENTORY_VIEWER

INVENTORY_VIEWER = 'InventoryViewer'

CUSTOM_TEMPLATE_OWNER

CUSTOM_TEMPLATE_OWNER = 'CustomTemplateOwner'

CUSTOM_TEMPLATE_VIEWER

CUSTOM_TEMPLATE_VIEWER = 'CustomTemplateViewer'

CAS_FULL_ACCESS

CAS_FULL_ACCESS = 'CASFullAccess'

ACL

Bases: BaseAlbertModel

A single access rule for a user.

Attributes:

Name Type Description
id str

The user or team this rule applies to.

fgc AccessControlLevel | None

The access level for that user or team.

Show JSON schema:
{
  "$defs": {
    "AccessControlLevel": {
      "description": "Access control levels you can grant users.",
      "enum": [
        "ProjectOwner",
        "ProjectEditor",
        "ProjectViewer",
        "ProjectAllTask",
        "ProjectStrictViewer",
        "ProjectPropertyTask",
        "InventoryOwner",
        "InventoryViewer",
        "CustomTemplateOwner",
        "CustomTemplateViewer",
        "CASFullAccess"
      ],
      "title": "AccessControlLevel",
      "type": "string"
    }
  },
  "description": "A single access rule for a user.\n\nAttributes\n----------\nid : str\n    The user or team this rule applies to.\nfgc : AccessControlLevel | None\n    The access level for that user or team.",
  "properties": {
    "id": {
      "description": "The id of the user for which this ACL applies",
      "title": "Id",
      "type": "string"
    },
    "fgc": {
      "anyOf": [
        {
          "$ref": "#/$defs/AccessControlLevel"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The Fine-Grain Control Level"
    }
  },
  "required": [
    "id"
  ],
  "title": "ACL",
  "type": "object"
}

Fields:

id

id: str

The id of the user for which this ACL applies

fgc

fgc: AccessControlLevel | None = None

The Fine-Grain Control Level

ACLContainer

Bases: BaseResource

Access settings with a default class and a list of rules.

Attributes:

Name Type Description
acl_class str | None

The default access class (for example, "restricted" or "confidential").

fgclist list[ACL] | None

Specific access rules for users or teams.

acl_class

acl_class: str | None = Field(default=None, alias='class')

fgclist

fgclist: list[ACL] | None = Field(
    default=None, alias="fgclist"
)