OIDCAuthProviderConfig interface

رابط پیکربندی ارائه‌دهنده تأیید اعتبار [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). یک ارائه دهنده OIDC می تواند از طریق BaseAuth.createProviderConfig ایجاد شود. .

امضا:

export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig

گسترش می یابد: BaseAuthProviderConfig

خواص

ویژگی تایپ کنید شرح
شناسه مشتری رشته این شناسه مشتری مورد نیاز است که برای تأیید مخاطبان ارائه‌دهنده OIDC [IDToken] (https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) استفاده می‌شود.
clientSecret رشته رمز سرویس گیرنده ارائه دهنده OIDC برای فعال کردن جریان کد OIDC.
صادر کننده رشته این صادرکننده ارائه‌دهنده مورد نیاز است که برای تطبیق با صادرکننده ارائه‌دهنده شناسه و برای تعیین سند کشف OIDC مربوطه، به عنوان مثال، استفاده می‌شود. [ /.well-known/openid-configuration ](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). این برای موارد زیر لازم است:
  • برای تأیید صادرکننده ارائه شده.
  • در طول جریان تأیید اعتبار OAuth id_token ، نقطه پایانی احراز هویت/مجوز را تعیین کنید.
  • برای بازیابی کلیدهای امضای عمومی از طریق jwks_uri برای تأیید امضای شناسه ارائه دهنده OIDC.
  • برای تعیین ادعاهای_پشتیبانی شده برای ساخت ویژگی‌های کاربر که باید در پاسخ اطلاعات اضافی کاربر برگردانده شوند.
اعتبار سنجی رمز شناسه همانطور که در [spec] (https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation) تعریف شده انجام می شود.
نوع پاسخ OAuthResponseType شی پاسخ ارائه دهنده OIDC برای جریان مجوز OAuth.

OIDCAuthProviderConfig.clientId

این شناسه مشتری مورد نیاز است که برای تأیید مخاطبان ارائه‌دهنده OIDC [IDToken] (https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) استفاده می‌شود.

امضا:

clientId: string;

OIDCAuthProviderConfig.clientSecret

رمز سرویس گیرنده ارائه دهنده OIDC برای فعال کردن جریان کد OIDC.

امضا:

clientSecret?: string;

OIDCAuthProviderConfig.issuer

این صادرکننده ارائه‌دهنده مورد نیاز است که برای تطبیق با صادرکننده ارائه‌دهنده شناسه و برای تعیین سند کشف OIDC مربوطه، به عنوان مثال، استفاده می‌شود. [ /.well-known/openid-configuration ](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). این برای موارد زیر لازم است:

  • برای تأیید صادرکننده ارائه شده.
  • در طول جریان تأیید اعتبار OAuth id_token ، نقطه پایانی احراز هویت/مجوز را تعیین کنید.
  • برای بازیابی کلیدهای امضای عمومی از طریق jwks_uri برای تأیید امضای شناسه ارائه دهنده OIDC.
  • برای تعیین ادعاهای_پشتیبانی شده برای ساخت ویژگی‌های کاربر که باید در پاسخ اطلاعات اضافی کاربر برگردانده شوند.
اعتبار سنجی رمز شناسه همانطور که در [spec] (https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation) تعریف شده انجام می شود.

امضا:

issuer: string;

OIDCAuthProviderConfig.responseType

شی پاسخ ارائه دهنده OIDC برای جریان مجوز OAuth.

امضا:

responseType?: OAuthResponseType;