Auth

Data structures for Authentication resource information and responses

Classes

AuthInfoData pydantic-model

Bases: pydantic.BaseModel

Authentication data for the current API key

Fields:

• user (outline_wiki_api.models.user.User)
• team (outline_wiki_api.models.team.Team)
• groups (list | None)
• group_users (list | None)
• collaboration_token (str)
• available_teams (list | None)
• token (str | None)

Attributes

token = None pydantic-field

Authentication token returned by login and register endpoints

AuthConfigData pydantic-model

Bases: pydantic.BaseModel

Authentication options

Fields:

• name (str)
• hostname (str | None)
• services (list[dict] | None)
• custom_theme (dict | None)
• providers (list[outline_wiki_api.models.auth.AuthProvider] | None)

AuthResponse pydantic-model

Bases: outline_wiki_api.models.response.Response

Authentication details response for the current API key

Fields:

• status (int)
• ok (bool)
• pagination (outline_wiki_api.models.response.Pagination | None)
• policies (list[outline_wiki_api.models.response.Policy] | None)
• data (outline_wiki_api.models.auth.AuthInfoData | outline_wiki_api.models.auth.AuthConfigData | None)