OIDCAuthProviderConfig interface

Интерфейс конфигурации поставщика аутентификации [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). Поставщик OIDC можно создать с помощью BaseAuth.createProviderConfig(). .

Подпись:

export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig

Расширяет: BaseAuthProviderConfig .

Характеристики

Свойство Тип Описание
ID клиента нить Это необходимый идентификатор клиента, используемый для подтверждения аудитории [идентификационного токена] поставщика OIDC (https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken).
клиентсекрет нить Секрет клиента поставщика OIDC для включения потока кода OIDC.
эмитент нить Это обязательный эмитент поставщика, используемый для сопоставления поставщика, эмитента токена идентификатора, и для определения соответствующего документа обнаружения OIDC, например. [ /.well-known/openid-configuration ](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). Это необходимо для следующего:
  • Чтобы проверить предоставленного эмитента.
  • Определите конечную точку аутентификации/авторизации во время потока аутентификации OAuth id_token .
  • Чтобы получить общедоступные ключи подписи через jwks_uri для проверки подписи токена идентификатора поставщика OIDC.
  • Чтобы определить претензии_поддерживаемые для создания атрибутов пользователя, которые будут возвращены в ответе с дополнительной информацией о пользователе.
Проверка токена идентификатора будет выполняться, как определено в [спецификации](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
тип ответа Тип ответа OAuthResponseType Объект ответа поставщика OIDC для потока авторизации OAuth.

OIDCAuthProviderConfig.clientId

Это необходимый идентификатор клиента, используемый для подтверждения аудитории [идентификационного токена] поставщика OIDC (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.
  • Чтобы определить претензии_поддерживаемые для создания атрибутов пользователя, которые будут возвращены в ответе с дополнительной информацией о пользователе.
Проверка токена идентификатора будет выполняться, как определено в [спецификации](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).

Подпись:

issuer: string;

OIDCAuthProviderConfig.responseType

Объект ответа поставщика OIDC для потока авторизации OAuth.

Подпись:

responseType?: OAuthResponseType;