Skip to content

Implement authentication support for Nuxt documentation templateΒ #3921

@larsrickert

Description

@larsrickert

Why?

The Nuxt documentation template should support easy integration for authentication so e.g. specific content can be shown/hidden depending on the user login state.

You can contact @larsrickert, we already have some working technical example applications that we might be able to re-use / base our implementation on.

Open questions / TODOs

Acceptance criteria

  • supports OAuth
  • supports SSO
  • any OAuth auth provider can be used (SIAM, GitHub, Google, custom OAuth providers...). Must be configured by the user
  • also supports multiple providers that the user can choose from
  • independent on which auth provider is used, the user profile data scheme should always be in the same format so it can be used reliably (+ custom provider data can be attached if needed)
  • composables or a pinia store is offered to easily access auth related data and functions (user profile, login, logout etc.)
  • by default, a OnyxUserMenu is displayed inside the NavBar if the user is logged in. Can be fully customized / overriden by the project
  • auth is supported in both client and server side
  • the documentation is updated to explain how to use the auth feature and how to customize it

Implementation details

  • use official (Nuxt) libraries. Do not implement auth on our own!!

Definition of Done

  • Should be covered by tests:

    • functional tests (Playwright or unit test)
    • visual tests (Playwright screenshots)
  • Make sure, that

    • follow-up tickets were created if necessary
    • updated version + documentation is deployed

Approval

Storybook
Documentation

  • Checked and approved by
    • designer
    • dev

Metadata

Metadata

Assignees

Labels

devRequires technical expertise

Type

Projects

Status

In Progress

Relationships

None yet

Development

No branches or pull requests

Issue actions