CloudFireAuth Docs

Appearance

cloudfire-auth / OIDCAuthProviderConfig

Interface: OIDCAuthProviderConfig ​

Defined in: types/firebase-admin/auth-config.ts:552

The OIDC Auth provider configuration interface. An OIDC provider can be created via CloudFireAuth.createProviderConfig.

Extends ​

  • BaseAuthProviderConfig

Properties ​

clientId ​

clientId: string

Defined in: types/firebase-admin/auth-config.ts:558

This is the required client ID used to confirm the audience of an OIDC provider's ID token.

clientSecret? ​

optional clientSecret: string

Defined in: types/firebase-admin/auth-config.ts:580

The OIDC provider's client secret to enable OIDC code flow.

displayName? ​

optional displayName: string

Defined in: types/firebase-admin/auth-config.ts:481

The user-friendly display name to the current configuration. This name is also used as the provider label in the Cloud Console.

Inherited from ​

BaseAuthProviderConfig.displayName

enabled ​

enabled: boolean

Defined in: types/firebase-admin/auth-config.ts:486

Whether the provider configuration is enabled or disabled. A user cannot sign in using a disabled provider.

Inherited from ​

BaseAuthProviderConfig.enabled

issuer ​

issuer: string

Defined in: types/firebase-admin/auth-config.ts:576

This is the required provider issuer used to match the provider issuer of the ID token and to determine the corresponding OIDC discovery document, eg. /.well-known/openid-configuration. This is needed for the following:

  • To verify the provided issuer.
  • Determine the authentication/authorization endpoint during the OAuth `id_token` authentication flow.
  • To retrieve the public signing keys via `jwks_uri` to verify the OIDC provider's ID token's signature.
  • To determine the claims_supported to construct the user attributes to be returned in the additional user info response.
ID token validation will be performed as defined in the [spec](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).

providerId ​

providerId: string

Defined in: types/firebase-admin/auth-config.ts:476

The provider ID defined by the developer. For a SAML provider, this is always prefixed by saml.. For an OIDC provider, this is always prefixed by oidc..

Inherited from ​

BaseAuthProviderConfig.providerId

responseType? ​

optional responseType: OAuthResponseType

Defined in: types/firebase-admin/auth-config.ts:584

The OIDC provider's response object for OAuth authorization flow.