# \_auth\_SIMKL

SIMKL authentication provider (OAuth).

{% tabs %}
{% tab title="End users" %}

### What this auth provider does

Connects CrossWatch to SIMKL via OAuth.

### Auth flow

* `oauth_code` (redirect URI + token exchange)

### Writes to config

Namespace:

* `cfg[\"simkl\"]`

Common fields:

* `client_id`, `client_secret`
* `access_token`

### Related docs

* UI setup: [Auth: SIMKL](/crosswatch/providers/authentication/auth-trackers/auth-simkl.md)
* Adapter: [Adapter: SIMKL](/crosswatch/providers/synchronization/adapter-simkl.md)
* Sync module: [SIMKL module](/blueprint-architecture/sync/_mod_simkl.md)

### Gotchas

* Redirect URI must match exactly.
* Switching HTTP ↔ HTTPS requires updating the SIMKL app settings.
  {% endtab %}

{% tab title="Power users" %}

### Code map

* `providers/auth/_auth_SIMKL.py`

### Public surface

* class: `SimklAuth`
* functions: `log()`, `html()`

### External endpoints

* `https://simkl.com/oauth/authorize`
* `https://api.simkl.com/oauth/token`

### Capabilities

<details>

<summary>Capabilities (raw)</summary>

```json
{
  "features": {
    "watchlist": {
      "read": true,
      "write": true
    },
    "collections": {
      "read": false,
      "write": false
    },
    "ratings": {
      "read": true,
      "write": true,
      "scale": "1-10"
    },
    "watched": {
      "read": true,
      "write": true
    },
    "liked_lists": {
      "read": true,
      "write": false
    }
  },
  "entity_types": [
    "movie",
    "show"
  ]
}
```

</details>
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_simkl.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
