Spotify

Ory Console
Ory CLI

Follow these steps to add Spotify as a social sign-in provider to your project using the Ory Console:

Go to Authentication → Social Sign-In in the Ory Console.
Click the switch next to the Spotify logo to start the configuration.
Copy the Redirect URI and save it for later use.
Create a Spotify Application.
From the registered application page in Spotify, copy the following data to the corresponding fields in the form in the Ory Console:
- Client ID
- Client Secret
From the registered application page in Spotify, click EDIT SETTINGS.
Add the saved Redirect URI from Ory to the Redirect URIs of the registered application.
Click Save to confirm and close the dialog.
In the Scopes field of the form in the Ory Console, add the following scopes:
- user-read-email
- user-read-private
In the Data Mapping field of the form in the Ory Console, add the following Jsonnet code snippet, which maps the desired claims to the Ory Identity schema:

local claims = std.extVar('claims');

{
  identity: {
    traits: {
      email: claims.email,
    },
  },
}

danger

Don't save secrets such as API keys, credentials, or personal data directly in Jsonnet code snippets. Jsonnet code snippets used for data mapping aren't stored in an encrypted format in Ory Network.

Click Save Configuration.

Follow these steps to add Spotify as a social sign-in provider to your project using the Ory CLI:

Create a Spotify Application.

In the created app, set the redirect URI to:

https://$PROJECT_SLUG.projects.oryapis.com/self-service/methods/oidc/callback/spotify

Create a Jsonnet code snippet to map the desired claims to the Ory Identity schema.
```
local claims = std.extVar('claims');

{
  identity: {
    traits: {
      email: claims.email,
    },
  },
}
```
info
Spotify provides an OIDC discovery URL, but it doesn't support the openid claim and returns the access_token only. Ory sends requests to Spotify's /me API and adds the user info to std.extVar('claims').

danger
Don't save secrets such as API keys, credentials, or personal data directly in Jsonnet code snippets. Jsonnet code snippets used for data mapping aren't stored in an encrypted format in Ory Network.
Encode the Jsonnet snippet with Base64 or host it under an URL accessible to Ory Network.
```
cat your-data-mapping.jsonnet | base64
```

Download the Ory Identities config from your project and save it to a file:

## List all available workspaces
ory list workspaces

## List all available projects
ory list projects --workspace <workspace-id>

## Get config
ory get identity-config --project <project-id> --workspace <workspace-id> --format yaml > identity-config.yaml

Add the social sign-in provider configuration to the downloaded config. Add the Jsonnet snippet with mappings as a Base64 string or provide an URL to the file.

selfservice:
  methods:
    oidc:
      config:
        providers:
          - id: spotify # this is `<provider-id>` in the Authorization callback URL. DO NOT CHANGE IT ONCE SET!
            provider: spotify
            client_id: .... # Replace this with the OAuth2 Client ID provided by Spotify
            client_secret: .... # Replace this with the OAuth2 Client Secret provided by Spotify
            mapper_url: "base64://{YOUR_BASE64_ENCODED_JSONNET_HERE}"
            # Alternatively, use an URL:
            # mapper_url: https://storage.googleapis.com/abc-cde-prd/9cac9717f007808bf17f22ce7f4295c739604b183f05ac4afb4
            scope:
              - user-read-email
              - user-read-private
      enabled: true

Update the Ory Identities configuration using the file you worked with:

ory update identity-config --project <project-id> --workspace <workspace-id> --file identity-config.yaml

Troubleshooting

When you add a social sign-in provider, you can encounter common problems such as:

Redirect URI mismatch
Redirect loops during registration
Domain verification issues

To troubleshoot those issues, read Social sign-in troubleshooting.

Spotify

Troubleshooting​

Troubleshooting