@idpass/data-collect-core / OIDCConfig

Interface: OIDCConfig

Defined in: interfaces/types.ts:717

OpenID Connect (OIDC) configuration for authentication.

Defines the configuration parameters needed to integrate with an OIDC provider for user authentication and authorization flows.

Example

const oidcConfig: OIDCConfig = {
  authority: "https://auth.example.com",
  client_id: "datacollect-app",
  redirect_uri: "https://app.example.com/callback",
  post_logout_redirect_uri: "https://app.example.com/logout",
  response_type: "code",
  scope: "openid profile email",
  state: "random-state-value",
  custom: { tenant: "production" }
};

Properties

authority

authority: string

Defined in: interfaces/types.ts:719

The OIDC provider's base URL (issuer identifier)

---

client_id

client_id: string

Defined in: interfaces/types.ts:721

Client identifier registered with the OIDC provider

---

redirect_uri

redirect_uri: string

Defined in: interfaces/types.ts:723

URI where the OIDC provider redirects after successful authentication

---

post_logout_redirect_uri

post_logout_redirect_uri: string

Defined in: interfaces/types.ts:725

URI where the OIDC provider redirects after logout

---

response_type

response_type: string

Defined in: interfaces/types.ts:727

OAuth 2.0 response type (typically "code" for authorization code flow)

---

scope

scope: string

Defined in: interfaces/types.ts:729

Space-separated list of requested scopes (e.g., "openid profile email")

---

state?

optional state: string

Defined in: interfaces/types.ts:731

Optional state parameter for CSRF protection during auth flow

---

extraQueryParams?

optional extraQueryParams: Record<string, string>

Defined in: interfaces/types.ts:733

Optional custom parameters specific to the OIDC provider