feat(providers): Add Ping Identity provider (#6614)

* adding ping identity provider * converted to typescript and also made requested changes from next-auth team * Update documentation, use OIDCConfig * Apply suggestions from code review * Update ping-id.ts * Create ping-id.svg * Update ping-id.svg * Update ping-id.svg --------- Co-authored-by: Falco Winkler <[email protected]> Co-authored-by: Balázs Orbán <[email protected]>
nextauthjs · Aug 16, 2024 · ed6b48c · ed6b48c
1 parent 208410d
commit ed6b48c
Show file tree

Hide file tree

Showing 3 changed files with 87 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/2_bug_provider.yml b/.github/ISSUE_TEMPLATE/2_bug_provider.yml
@@ -71,6 +71,7 @@ body:
         - "Osso"
         - "Osu"
         - "Patreon"
+        - "Ping Identity"
         - "Pipedrive"
         - "Reddit"
         - "Roblox"

diff --git a/docs/public/img/providers/ping-id.svg b/docs/public/img/providers/ping-id.svg
diff --git a/packages/core/src/providers/ping-id.ts b/packages/core/src/providers/ping-id.ts
@@ -0,0 +1,68 @@
+import type { OIDCConfig, OIDCUserConfig } from "./index.js"
+
+export interface PingProfile extends Record<string, any> {
+  iss: string
+  sub: string
+  aud: string
+  iat: number
+  exp: number
+  acr: string
+  amr: [string]
+  auth_time: number
+  at_hash: string
+  sid: string
+  preferred_username: string
+  given_name: string
+  picture: string
+  updated_at: number
+  name: string
+  family_name: string
+  email: string
+  env: string
+  org: string
+  "p1.region": string
+}
+
+/**
+ * Add PingId login to your page.
+ *
+ * ## Documentation
+ *
+ * - [Create App in Ping Identity](https://docs.pingidentity.com/r/en-us/pingone/p1_add_app_worker)
+ *
+ *  ---
+ * ## Example
+ *
+ * ```ts
+ * import PingId from "@auth/core/providers/ping-id"
+ *
+ * ...
+ * providers: [
+ *  PingId({
+ *    clientId: AUTH_PING_ID_ID,
+ *    clientSecret: AUTH_PING_ID_SECRET,
+ *    issuer: PING_ID_ISSUER
+ *  })
+ * ]
+ * ...
+ * ```
+ *
+ * ## 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 PingId(
+  options: OIDCUserConfig<PingProfile>
+): OIDCConfig<PingProfile> {
+  return {
+    id: "ping-id",
+    name: "Ping Identity",
+    type: "oidc",
+    options,
+  }
+}