Lark

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

Create an application in the Feishu Open Platform Developer Console and obtain the ID and secret of the application.

In the created app, set the redirect URI to:

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

Create a Jsonnet code snippet to map the desired claims to the Ory Identity schema. For specific information Lark's User API can be viewed.

local claims = std.extVar('claims');
{
  identity: {
    traits: {
      // Allowing unverified email addresses enables account
      // enumeration attacks, especially if the value is used for
      // e.g. verification or as a password login identifier.
      //
      // Therefore we only return the email if it (a) exists by lark.
      [if "email" in claims then "email" else null]: 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.

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 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:
      enabled: true
      config:
        providers:
          - id: lark # this is `<provider-id>` in the Authorization callback URL. DO NOT CHANGE IT ONCE SET!
            provider: lark
            client_id: .... # Replace this with the OAuth2 Client ID provided by lark
            client_secret: .... # Replace this with the OAuth2 Client Secret provided by lark
            mapper_url: "base64://{YOUR_BASE64_ENCODED_JSONNET_HERE}"
            # Alternatively, use an URL:
            # mapper_url: https://storage.googleapis.com/abc-cde-prd/9cac9717f007808bf17f22ce7f4295c739604b183f05ac4afb4

            # Lark uses a fixed scope for applications that should be configured on its admin page. therefore you can use an empty scope list here.
            scope: []

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.

Lark

Troubleshooting​

Troubleshooting