Twitch

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

Create a Twitch OAuth2 Application.

In the created app, set the redirect URI to:

https://{project.slug}.projects.oryapis.com/self-service/methods/oidc/callback/twitch

Create a Jsonnet code snippet to map the desired claims to the Ory Identity schema.

local claims = {
  email_verified: false,
} + std.extVar('claims');

{
  identity: {
    traits: {
      // Allowing unverified email addresses enables account
      // enumeration attacks, if the value is used for
      // verification or as a password login identifier.
      //
      // Therefore we only return the email if it (a) exists and (b) is marked verified
      // by Twitch.
      [if 'email' in claims && claims.email_verified then 'email' else null]: claims.email,
    },
  },
}

info

Twitch provides an OIDC discovery URL, but it doesn't support the openid claim and returns an access_token only. Ory sends requests to Twitch'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 The 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 projects
ory list projects

## Get config
ory get identity-config {project-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: twitch # this is `<provider-id>` in the Authorization callback URL. DO NOT CHANGE IT ONCE SET!
            provider: generic
            client_id: .... # Replace this with the OAuth2 Client ID provided by Twitch
            client_secret: .... # Replace this with the OAuth2 Client Secret provided by Twitch
            issuer_url: https://id.twitch.tv/oauth2
            mapper_url: "base64://{YOUR_BASE64_ENCODED_JSONNET_HERE}"
            # Alternatively, use an URL:
            # mapper_url: https://storage.googleapis.com/abc-cde-prd/9cac9717f007808bf17f22ce7f4295c739604b183f05ac4afb4
            scope:
              - openid
              - user:read:email # required for email and email_verified claims in the near future
            requested_claims: # explicitly request email and email_verified claims because twitch doesn't add them by default
              id_token:
                email:
                  essential: true
                email_verified:
                  essential: true
      enabled: true

Update the Ory Identities configuration using the file you worked with:
```
ory update identity-config {project-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.

Twitch

Troubleshooting​

Troubleshooting