providers/zitadel

內建 Zitadel 整合。

ZitadelProfile

使用設定檔回呼時，從 ZITADEL 回傳的使用者設定檔。請參閱這裡的標準宣告參考。如果您需要存取 ZITADEL API 或需要其他資訊，請務必加入對應的範圍。

繼承

Record<string, any>

屬性

amr

amr: string;

aud

aud: string;

auth_time

auth_time: number;

azp

azp: string;

email

email: string;

email_verified

email_verified: boolean;

exp

exp: number;

family_name

family_name: string;

gender

gender: string;

given_name

given_name: string;

iat

iat: number;

iss

iss: string;

jti

jti: string;

locale

locale: string;

name

name: string;

nbf

nbf: number;

phone

phone: string;

phone_verified

phone_verified: boolean;

picture

picture: string;

preferred_username

preferred_username: string;

sub

sub: string;

default()

default<P>(options): OIDCConfig<P>

將 ZITADEL 登入新增至您的頁面。

設定

回調網址

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

設定

import { Auth } from "@auth/core"
import ZITADEL from "@auth/core/providers/zitadel"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    ZITADEL({
      clientId: ZITADEL_CLIENT_ID,
      clientSecret: ZITADEL_CLIENT_SECRET,
    }),
  ],
})

資源

注意事項

預設情況下，Auth.js 假設 ZITADEL 提供者是基於Open ID Connect規範。

建立憑證時使用的重新導向 URI 必須包含您的完整網域，並以回呼路徑結尾。例如

對於生產環境：https://{YOUR_DOMAIN}/api/auth/callback/zitadel
對於開發環境：https://127.0.0.1:3000/api/auth/callback/zitadel

請務必在 ZITADEL 主控台中啟用開發模式，以允許本機開發的重新導向。

💡

ZITADEL 提供者帶有預設設定。若要覆寫您使用案例的預設值，請查看自訂內建 OAuth 提供者。

💡

ZITADEL 也會在設定檔中回傳 email_verified 布林值屬性。您可以使用此屬性來限制僅限已驗證帳戶的使用者存取。

const options = {
  ...
  callbacks: {
    async signIn({ account, profile }) {
      if (account.provider === "zitadel") {
        return profile.email_verified;
      }
      return true; // Do different verification for other providers that don't have `email_verified`
    },
  }
  ...
}

免責聲明 如果您認為在預設設定中發現錯誤，您可以開啟問題。

Auth.js 嚴格遵循規範，對於提供者偏離規範的任何情況，概不負責。您可以開啟問題，但如果問題是不符合規範，我們可能不會尋求解決方案。您可以在討論中尋求更多協助。

類型參數

類型參數
`P` extends `ZitadelProfile`

參數

參數	類型
`options`	`OAuthUserConfig`<`P`>

回傳

OIDCConfig<P>

yandex zoho