Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
API reference
instagram

providers/instagram

Built-in Instagram integration.

default()

default(config): OAuthConfig<Record<string, any>>

Add Instagram login to your page.

Setup

Callback URL

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

Configuration

import { Auth } from "@auth/core"
import Instagram from "@auth/core/providers/instagram"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Instagram({
      clientId: INSTAGRAM_CLIENT_ID,
      clientSecret: INSTAGRAM_CLIENT_SECRET,
    }),
  ],
})

Resources

Notes

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

⚠️

Email address is not returned by the Instagram API.

💡

Instagram display app required callback URL to be configured in your Facebook app and Facebook required you to use https even for localhost! In order to do that, you either need to add an SSL to your localhost or use a proxy such as ngrok.

💡

The Instagram provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.

Disclaimer If you think you found a bug in the default configuration, you can open an issue.

Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.

Parameters

ParameterType
configOAuthUserConfig<Record<string, any>>

Returns

OAuthConfig<Record<string, any>>

Auth.js © Balázs Orbán and Team - 2024