<a id="openstreetmap-oauth-2"></a>

# OpenStreetMap OAuth 2

<a id="backend-class"></a>

## Backend class

For Django, add this class path to `AUTHENTICATION_BACKENDS`. For other
integrations, use the same class path in the framework-specific backend
setting.

| Backend name           | Class path                                                      |
|------------------------|-----------------------------------------------------------------|
| `openstreetmap-oauth2` | `social_core.backends.openstreetmap_oauth2.OpenStreetMapOAuth2` |

OpenStreetMap supports the OAuth 2.0 protocol. It supports two types of OAuth 2.0 flows:

1. Authorization code with [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636)
2. Authorization code

<a id="configuration"></a>

## Configuration

- Login to your account
- Register your application as OAuth 2 application on the [My Client Applications page](https://www.openstreetmap.org/oauth2/applications)
  * Set the redirect URIs to [https://example.com/complete/openstreetmap-oauth2/](https://example.com/complete/openstreetmap-oauth2/)
  * PKCE can be enabled/disabled using the “Confidential application?” flag.
  * Select all required Permissions.
  * Scopes names are shown next to each permission after saving.
- Fill *Client ID* in `SOCIAL_AUTH_OPENSTREETMAP_OAUTH2_KEY` and
  *Client Secret* in `SOCIAL_AUTH_OPENSTREETMAP_OAUTH2_SECRET`
  > SOCIAL_AUTH_OPENSTREETMAP_OAUTH2_KEY = ‘…’
  > SOCIAL_AUTH_OPENSTREETMAP_OAUTH2_SECRET = ‘…’

  Note: *Client Secret* isn’t required for PKCE.
- Enable the backend:
  ```default
  SOCIAL_AUTH_AUTHENTICATION_BACKENDS = (
    ...
   'social_core.backends.openstreetmap_oauth2.OpenStreetMapOAuth2',
   ...
  )
  ```

Access tokens currently do not expire automatically.

More documentation at [OpenStreetMap Wiki](http://wiki.openstreetmap.org/wiki/OAuth):

<a id="extra-configuration"></a>

## Extra Configuration

- You can specify the scopes that your application requires:
  ```default
  SOCIAL_AUTH_OPENSTREETMAP_OAUTH2_SCOPE  = [ 'read_prefs' ]
  ```
- You can choose to disable PKCE:
  ```default
  SOCIAL_AUTH_OPENSTREETMAP_OAUTH2_USE_PKCE = False
  ```

  By default, True is set.