goauthentik/authentik

Update source docs with new property mappings

Open

#10724 opened on Aug 1, 2024

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Python (4,050 stars) (319 forks)batch import
documentationenhancementenhancement/confirmedhelp wantedneeds_documentationpr_wanted

Description

With #8771, it is now possible to get additional properties from an OAuth and SAML source, plus getting groups and syncing those. We need to update our sources documentation with those changes. As some of those docs are community supported, I'm opening this issue to ping whomever made recent changes to those if they want to update them with the new (and recommended) way of getting that data. Those changes will make it in 2024.8, so it may be a bit difficult to try things out just yet, but the currently documented way of getting data will still work until the documentation can be changed.

Documentation for those changes is available in #10652 (see the authentik-docs comment for the preview link). Please link back to this issue if you open a PR for those.

  • AzureAD - @tograss
  • Discord - authentik support level, but we've seen a lot of contribution on this so - @Keyinator @Aterfax
  • GitHub - authentik support level, but we've seen a lot of contribution on this so - @TheMythologist
  • Google - community supported

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of authentikFamiliarity with documentation style
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Review the documentation changes in PR #10652 (see authentik docs preview). For each source listed (AzureAD, Discord, GitHub, Google), update the corresponding documentation page to reflect the new property mappings. Ensure consistency with the examples provided in the PR. Link the PR back to this issue.