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(teammemberships): refactor SCIM pkg #792

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

abhijith-darshan
Copy link
Contributor

@abhijith-darshan abhijith-darshan commented Dec 10, 2024

Description

Currently the Organization controller and TeamMembership controller both use SCIM API to -

  1. Validate the provided SCIM Config (Organization Controller)
  2. Fetch Members of an IDP Group (TeamMembership Controller)

The SCIM pkg is refactored to reduce the number of calls being made to the SCIM endpoint.

The Organization controller will check if a Group exists by searching for the provided IDP Group and will not attempt to list members as it is not needed

The TeamMembership controller will list all Users for the provided IDP Group (With Pagination)

  • Max result of 100 items can be fetched per page

SCIM Pkg is refactored:

  • SCIM Client to use Basic Auth Transport as RoundTripper (Future auth mechanisms can be used via Transports instead)
  • Pagination is introduced
  • QueryParameters as QueryOptions to SCIM API(s)
  • Pre-defined Query Parameters

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help
  • Separate ticket for tests # (issue/pr)

Unit Tests are added and subsequent unit tests for Organization and TeamMembership is updated

Added to documentation?

  • 📜 README.md
  • 🤝 Documentation pages updated
  • 🙅 no documentation needed
  • (if applicable) generated OpenAPI docs for CRD changes

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes

@abhijith-darshan abhijith-darshan self-assigned this Dec 10, 2024
@abhijith-darshan abhijith-darshan changed the title feat(scim) - refactor SCIM pkg feat(teammemberships) - refactor SCIM pkg Dec 10, 2024
@abhijith-darshan abhijith-darshan changed the title feat(teammemberships) - refactor SCIM pkg feat(teammemberships): refactor SCIM pkg Dec 10, 2024
@abhijith-darshan abhijith-darshan marked this pull request as ready for review December 10, 2024 06:39
@abhijith-darshan abhijith-darshan requested a review from a team as a code owner December 10, 2024 06:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant