@auth/core
Version:
Authentication for the Web.
73 lines • 2.67 kB
TypeScript
/**
* <div class="provider" style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
* <span style={{fontSize: "1.35rem" }}>
* Built-in sign in with <b>Kinde</b> integration.
* </span>
* <a href="https://kinde.com" style={{backgroundColor: "#0F0F0F", padding: "12px", borderRadius: "100%" }}>
* <img style={{display: "block"}} src="https://authjs.dev/img/providers/kinde.svg" width="24"/>
* </a>
* </div>
*
* @module providers/kinde
*/
import type { OIDCConfig, OIDCUserConfig } from "./index.js";
/** The returned user profile from Kinde when using the profile callback. [Reference](https://kinde.com/api/docs/#get-user-profile). */
export interface KindeProfile extends Record<string, any> {
/** The user's given name. */
first_name: string;
/** The user's unique identifier. */
id: string;
/** The user's family name. */
last_name: string;
/** URL pointing to the user's profile picture. */
picture: string;
/** The user's email address. */
preferred_email: string;
/** The user's identifier from a previous system. */
provided_id: string;
/** The user's username. */
username: string;
}
/**
* ### Setup
*
* #### Callback URL
* ```
* https://example.com/api/auth/callback/kinde
* ```
*
* #### Configuration
* ```ts
* import { Auth } from "@auth/core"
* import Kinde from "@auth/core/providers/kinde"
*
* const request = new Request(origin)
* const response = await Auth(request, {
* providers: [
* Kinde({
* clientId: KINDE_CLIENT_ID,
* clientSecret: KINDE_CLIENT_SECRET,
* issuer: KINDE_DOMAIN,
* }),
* ],
* })
* ```
*
* ### Resources
*
* - [Kinde docs](https://docs.kinde.com/)
*
* ### Notes
*
* The Kinde provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/kinde.ts). To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/configuring-oauth-providers).
*
* ## Help
*
* If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-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](https://authjs.dev/new/github-discussions).
*/
export default function Kinde(config: OIDCUserConfig<KindeProfile>): OIDCConfig<KindeProfile>;
//# sourceMappingURL=kinde.d.ts.map