providers/threads

Built-in Threads integration.

ThreadsProfile

User

Properties

data

data: {
  id: string;
  threads_biography: string;
  threads_profile_picture_url: string;
  username: string;
};

id

id: string;

Unique identifier of this user. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

threads_biography?

optional threads_biography: string;

The text of this user’s profile biography (also known as bio), if the user provided one.

To return this field, add fields=threads_biography in the authorization request’s query parameter.

threads_profile_picture_url?

optional threads_profile_picture_url: string;

The URL to the profile image for this user, as shown on the user’s profile.

To return this field, add fields=threads_profile_picture_url in the authorization request’s query parameter.

username?

optional username: string;

The Threads handle (username) of this user.

To return this field, add fields=username in the authorization request’s query parameter.

default()

default(config): OAuthConfig<ThreadsProfile>

Add Threads login to your page.

Setup

Callback URL

https://example.com/api/auth/callback/threads

Configuration

import { Auth } from "@auth/core"
import Threads from "@auth/core/providers/threads"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Threads({
      clientId: THREADS_CLIENT_ID,
      clientSecret: THREADS_CLIENT_SECRET,
    }),
  ],
})

Resources

• Threads App documentation

Notes

By default, Auth.js assumes that the Threads provider is based on the OAuth 2 specification.

Parameters

Returns

OAuthConfig<ThreadsProfile>