User

Classes

UserRole

Bases: str, enum.Enum

Available user roles in the system

User pydantic-model

Bases: pydantic.BaseModel

Represents a user in the system.

This model contains all the essential information about a user account, including personal details, preferences, and activity timestamps.

Fields:

• id (uuid.UUID)
• name (str)
• avatar_url (str | None)
• email (pydantic.EmailStr | None)
• color (str | None)
• role (outline_wiki_api.models.user.UserRole | None)
• is_suspended (bool)
• created_at (datetime.datetime)
• updated_at (datetime.datetime)
• last_active_at (datetime.datetime | None)
• timezone (str | None)
• language (str | None)
• preferences (dict | None)
• notification_settings (dict | None)

Attributes

notification_settings = None pydantic-field

User's notification preferences and settings

preferences = None pydantic-field

Dictionary of user-specific preferences and settings

role = None pydantic-field

User's role determining access permissions

UserMembership pydantic-model

Bases: pydantic.BaseModel

Fields:

• users (list[outline_wiki_api.models.user.User] | None)
• memberships (list[outline_wiki_api.models.membership.Membership] | None)

UserResponse pydantic-model

Bases: outline_wiki_api.models.response.Response

Fields:

• status (int)
• ok (bool)
• pagination (typing.Optional[outline_wiki_api.models.response.Pagination])
• policies (typing.Optional[typing.List[outline_wiki_api.models.response.Policy]])
• data (outline_wiki_api.models.user.User | None)

UserListResponse pydantic-model

Bases: outline_wiki_api.models.response.Response

Fields:

• status (int)
• ok (bool)
• pagination (typing.Optional[outline_wiki_api.models.response.Pagination])
• policies (typing.Optional[typing.List[outline_wiki_api.models.response.Policy]])
• data (list[outline_wiki_api.models.user.User] | None)