@zitadel/vue
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

ZITADEL Vue SDK

Authenticate your ZITADEL users within your Vue applications.

NPM Version NPM License PRs Welcome

Getting Started

Features

The NPM package @zitadel/vue wraps the NPM package vue-oidc-client. All vue-oidc-client features are available and the whole configuration can be overridden.

The following features are added to vue-oidc-client

The following is an example for a minimal OIDC configuration:

const zitadelAuth = createZITADELAuth({
   issuer: `${myZITADELInstancesOrigin}`,
   client_id: `${myApplicationsClientID}`,
   project_resource_id: `${myApplicationsProjectResourceID}`,
})

The following defaults apply:

  • The OIDC Code Flow with PKCE is used for authentication at ZITADEL.
  • ZITADELs user info endpoint is called to enrich the user profile.
  • The access token is refreshed automatically by default before it expires.
  • If you specify a project_resource_id, the scopes for retrieving the users roles from the user info endpoint are added automatically. You can conveniently use zitadelAuth.hasRole("someRoleKey").

Package Sidebar

Install

npm i @zitadel/vue

Weekly Downloads

121

Version

1.0.4

License

MIT

Unpacked Size

4.82 kB

Total Files

6

Last publish

Collaborators

  • eliobischof
  • peintnermax
  • ffo
  • cbuehler