VKontakte

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

1. Create a VK OAuth2 Application.

2. In the created app, set the redirect URI to:

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

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

   local claims = std.extVar('claims');
   {
     identity: {
       traits: {
         // VK doesn't provide an 'email_verified field'.
         //
         // Email might be empty if the user isn't allowed the 'email' scope.
         [if 'email' in claims then 'email' else null]: claims.email,
       },
     },
   }
   info

   VK returns an access_token but doesn't return an id_token. Ory sends requests to VK's 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.

4. Encode the Jsonnet snippet with Base64 or host it under an URL accessible to Ory Network.

   cat your-data-mapping.jsonnet | base64

5. 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

6. 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: vk # this is `<provider-id>` in the Authorization callback URL. DO NOT CHANGE IT ONCE SET!
               provider: vk
               client_id: .... # Replace this with the OAuth2 Client ID provided by VK app
               client_secret: .... # Replace this with the OAuth2 Client Secret provided by VK app
               mapper_url: "base64://{YOUR_BASE64_ENCODED_JSONNET_HERE}"
               # Alternatively, use an URL:
               # mapper_url: https://storage.googleapis.com/abc-cde-prd/9cac9717f007808bf17f22ce7f4295c739604b183f05ac4afb4
               scope:
                 - email # required for email and email_verified claims in the near future
         enabled: true

7. 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.