Skip to main content

Discord

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

  1. Create a Discord OAuth2 application.

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

    https://{project.slug}.projects.oryapis.com/self-service/methods/oidc/callback/discord
  3. 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 Discord.
    [if 'email' in claims && claims.email_verified then 'email' else null]: claims.email,
    },
    },
    }
    info

    Discord doesn't implement OpenID Connect. Ory makes a request to Discord's User API and adds the data to std.extVar('claims'). Not all fields are supported. Check the list of supported fields in the source code.

    The identify scope adds these fields:

    iss                 # always https://discord.com/api/v6/oauth2/
    sub # numeric discord user id
    name # username + # + discriminator
    nickname # username
    preferred_username # username
    picture # avatar url
    locale # user locale

    The email scope adds these fields:

    email               # user email
    email_verified # whether email is verified
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 The Ory Network.

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

    cat your-data-mapping.jsonnet | base64
  2. 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
  3. 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: discord # this is `<provider-id>` in the Authorization callback URL. DO NOT CHANGE IT ONCE SET!
    provider: discord
    client_id: .... # Replace this with the OAuth2 Client ID provided by Discord
    client_secret: .... # Replace this with the OAuth2 Client Secret provided by Discord
    mapper_url: "base64://{YOUR_BASE64_ENCODED_JSONNET_HERE}"
    # Alternatively, use an URL:
    # mapper_url: https://storage.googleapis.com/abc-cde-prd/9cac9717f007808bf17f22ce7f4295c739604b183f05ac4afb4
    scope:
    - identify
    - email
    enabled: true
  4. Update the Ory Identities configuration using the file you worked with:

    ory update identity-config {project-id} --file updated_config.yaml