UNPKG

@auth/core

Version:

Authentication for the Web.

99 lines 3.19 kB
/** * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}> * <span>Built-in <b>Pipedrive</b> integration.</span> * <a href="https://www.pipedrive.com/"> * <img style={{display: "block"}} src="https://authjs.dev/img/providers/pipedrive.svg" height="48" /> * </a> * </div> * * @module providers/pipedrive */ import type { OAuthConfig, OAuthUserConfig } from "./index.js"; export interface PipedriveProfile extends Record<string, any> { success: boolean; data: { id: number; name: string; default_currency?: string; locale?: string; lang?: number; email: string; phone?: string; activated?: boolean; last_login?: Date; created?: Date; modified?: Date; signup_flow_variation?: string; has_created_company?: boolean; is_admin?: number; active_flag?: boolean; timezone_name?: string; timezone_offset?: string; role_id?: number; icon_url?: string; is_you?: boolean; company_id?: number; company_name?: string; company_domain?: string; company_country?: string; company_industry?: string; language?: { language_code?: string; country_code?: string; }; }; } /** * Add Pipedrive login to your page. * * ### Setup * * #### Callback URL * ``` * https://example.com/api/auth/callback/pipedrive * ``` * * #### Configuration *```ts * import { Auth } from "@auth/core" * import Pipedrive from "@auth/core/providers/pipedrive" * * const request = new Request(origin) * const response = await Auth(request, { * providers: [ * Pipedrive({ * clientId: PIPEDRIVE_CLIENT_ID, * clientSecret: PIPEDRIVE_CLIENT_SECRET, * }), * ], * }) * ``` * * ### Resources * * - [Pipedrive OAuth documentation](https://pipedrive.readme.io/docs/marketplace-oauth-authorization) * * ### Notes * * By default, Auth.js assumes that the Pipedrive provider is * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification. * * :::tip * * The Pipedrive provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/pipedrive.ts). * To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/configuring-oauth-providers). * * ::: * * :::info **Disclaimer** * * 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 Pipedrive<P extends PipedriveProfile>(options: OAuthUserConfig<P>): OAuthConfig<P>; //# sourceMappingURL=pipedrive.d.ts.map