{py:mod}archivebox.api.v1_auth

:allowtitles:

Module Contents

Classes

: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:
    ```

Functions

: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:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`router <archivebox.api.v1_auth.router>`
  - ```{autodoc2-docstring} archivebox.api.v1_auth.router
    :summary:
    ```

API

: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
```