Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🛂 feat: Required OpenID Role #2279

Merged
merged 20 commits into from
Apr 2, 2024
Merged

🛂 feat: Required OpenID Role #2279

merged 20 commits into from
Apr 2, 2024

Conversation

danny-avila
Copy link
Owner

Summary

Slight refactor, continuation of #1488 by @siriusfreak

This change allows to perform role-based authorization for OpenID providers.

The new parameter OPENID_REQUIRED_ROLE specifies the allowed role name.

Other Changes

Moved OAuth2/OIDC instructions to dedicated pages to de-clutter https://docs.librechat.ai/install/configuration/user_auth_system.html

Change Type

New feature (non-breaking change which adds functionality)

Testing

Tested by the personal installation of Keycloak. The configuration process is described in the OpenID with Keycloak and Role Restriction section.

Test Configuration:

Checklist

  • My code adheres to this project's style guidelines
  • I have performed a self-review of my own code
  • I have commented in any complex areas of my code
  • I have made pertinent documentation changes
  • My changes do not introduce new warnings
  • I have written tests demonstrating that my changes are effective or that my feature works (No test for this module in the current codebase)
  • Local unit tests pass with my changes (No test for this module itself (No test for this module in the current codebase)
  • Any changes dependent on mine have been merged and published in downstream modules (Not applicable)

@danny-avila danny-avila mentioned this pull request Apr 2, 2024
8 tasks
@danny-avila danny-avila merged commit 1bafe80 into main Apr 2, 2024
2 checks passed
@danny-avila danny-avila deleted the add-req-openid-role branch April 2, 2024 07:08
jinzishuai pushed a commit to aitok-ai/LibreChat that referenced this pull request May 20, 2024
* feat: add possibility to filter by roles for OpenID provider

---------

Co-authored-by: Sirius <siriusfrk@gmail.com>
kenshinsamue pushed a commit to intelequia/LibreChat that referenced this pull request Sep 17, 2024
* feat: add possibility to filter by roles for OpenID provider

---------

Co-authored-by: Sirius <siriusfrk@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants