-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
archivebox.api.v1_auth
Nick Sweeting edited this page Nov 13, 2024
·
2 revisions
:allowtitles:
:class: autosummary longtable
:align: left
* - {py:obj}`PasswordAuthSchema <archivebox.api.v1_auth.PasswordAuthSchema>`
- ```{autodoc2-docstring} archivebox.api.v1_auth.PasswordAuthSchema
:summary:
```
* - {py:obj}`TokenAuthSchema <archivebox.api.v1_auth.TokenAuthSchema>`
- ```{autodoc2-docstring} archivebox.api.v1_auth.TokenAuthSchema
:summary:
```
:class: autosummary longtable
:align: left
* - {py:obj}`get_api_token <archivebox.api.v1_auth.get_api_token>`
- ```{autodoc2-docstring} archivebox.api.v1_auth.get_api_token
:summary:
```
* - {py:obj}`check_api_token <archivebox.api.v1_auth.check_api_token>`
- ```{autodoc2-docstring} archivebox.api.v1_auth.check_api_token
:summary:
```
:class: autosummary longtable
:align: left
* - {py:obj}`router <archivebox.api.v1_auth.router>`
- ```{autodoc2-docstring} archivebox.api.v1_auth.router
:summary:
```
:canonical: archivebox.api.v1_auth.router
:value: >
'Router(...)'
```{autodoc2-docstring} archivebox.api.v1_auth.router
```
:canonical: archivebox.api.v1_auth.PasswordAuthSchema
Bases: {py:obj}`ninja.Schema`
```{autodoc2-docstring} archivebox.api.v1_auth.PasswordAuthSchema
```
```{rubric} Initialization
```
```{autodoc2-docstring} archivebox.api.v1_auth.PasswordAuthSchema.__init__
```
````{py:attribute} username
:canonical: archivebox.api.v1_auth.PasswordAuthSchema.username
:type: typing.Optional[str]
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_auth.PasswordAuthSchema.username
```
````
````{py:attribute} password
:canonical: archivebox.api.v1_auth.PasswordAuthSchema.password
:type: typing.Optional[str]
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_auth.PasswordAuthSchema.password
```
````
:canonical: archivebox.api.v1_auth.get_api_token
```{autodoc2-docstring} archivebox.api.v1_auth.get_api_token
```
:canonical: archivebox.api.v1_auth.TokenAuthSchema
Bases: {py:obj}`ninja.Schema`
```{autodoc2-docstring} archivebox.api.v1_auth.TokenAuthSchema
```
```{rubric} Initialization
```
```{autodoc2-docstring} archivebox.api.v1_auth.TokenAuthSchema.__init__
```
````{py:attribute} token
:canonical: archivebox.api.v1_auth.TokenAuthSchema.token
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_auth.TokenAuthSchema.token
```
````
:canonical: archivebox.api.v1_auth.check_api_token
```{autodoc2-docstring} archivebox.api.v1_auth.check_api_token
```
- π’ Quickstart
- π₯οΈ Install
- π³ Docker
- β‘οΈ Supported Sources
- β¬ οΈ Supported Outputs
- οΉ©Command Line
- π Web UI
- π§© Browser Extension
- πΎ REST API / Webhooks
- π Python API / REPL / SQL API
- βοΈ Configuration
- π¦ Dependencies
- πΏ Disk Layout
- π Security Overview
- π Developer Documentation
- Upgrading
- Setting up Storage (NFS/SMB/S3/etc)
- Setting up Authentication (SSO/LDAP/etc)
- Setting up Search (rg/sonic/etc)
- Scheduled Archiving
- Publishing Your Archive
- Chromium Install
- Cookies & Sessions Setup
- Merging Collections
- Troubleshooting
- βοΈ Web Archiving Community
- Background & Motivation
- Comparison to Other Tools
- Architecture Diagram
- Changelog & Roadmap