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 (typing.Optional[typing.List])
• group_users (typing.Optional[typing.List])
• collaboration_token (str)
• available_teams (typing.Optional[typing.List])
• token (typing.Optional[str])

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 (typing.Optional[str])
• services (typing.Optional[typing.List[typing.Dict]])
• custom_theme (typing.Optional[typing.Dict])
• providers (typing.Optional[typing.List[outline_wiki_api.models.auth.AuthProvider]])

AuthResponse pydantic-model

Bases: outline_wiki_api.models.response.Response

Authentication details response for the current API key

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 (typing.Optional[typing.Union[outline_wiki_api.models.auth.AuthInfoData, outline_wiki_api.models.auth.AuthConfigData]])