access_grants

Access grant models for resource permissions.

Access grants provide fine-grained permission control over resources like models, tools, notes, channels, and knowledge collections.

Classes

AccessGrantModel

Bases: BaseModel

Full access grant model with all fields.

Used when storing and retrieving access grants from the database.

Returned by:

• Code Reference models
  • channels Classes ChannelModel Attributes access_grants
  • knowledge Classes KnowledgeModel Attributes access_grants
  • models Classes ModelModel Attributes access_grants
  • notes Classes NoteModel Attributes access_grants
  • prompts Classes PromptModel Attributes access_grants
  • tools Classes
    • ToolModel Attributes access_grants
    • ToolResponse Attributes access_grants

Attributes

id

id: str

Unique identifier for the grant.

resource_type

resource_type: str

Type of resource: 'knowledge', 'model', 'prompt', 'tool', 'note', 'channel', or 'file'.

resource_id

resource_id: str

ID of the resource this grant applies to.

principal_type

principal_type: str

Type of principal: 'user' or 'group'.

principal_id

principal_id: str

ID of the user or group, or '*' for wildcard (public access).

permission

permission: str

Permission level: 'read' or 'write'.

created_at

created_at: int

Timestamp when the grant was created (epoch time).

AccessGrantResponse

Bases: BaseModel

Slim grant model for API responses.

Resource context (resource_type, resource_id) is implicit from the parent response.

Attributes

id

id: str

Unique identifier for the grant.

principal_type

principal_type: str

Type of principal: 'user' or 'group'.

principal_id

principal_id: str

ID of the user or group, or '*' for wildcard (public access).

permission

permission: str

Permission level: 'read' or 'write'.