add doc for Custom LDAP Property Mapping #9524

ChenWenBrian · 2024-04-30T04:43:50Z

Details

Add detailed steps for users to know how to add custom LDAP Property Mapping, cause this question is usually asked and got no answer.

Checklist

Local tests pass (ak test authentik/)
The code has been formatted (make lint-fix)

If an API change has been made

The API schema has been updated (make gen-build)

If changes to the frontend have been made

The code has been formatted (make web)

If applicable

The documentation has been updated
The documentation has been formatted (make website)

Signed-off-by: Brian, Chen <wildfox@126.com>

netlify · 2024-04-30T04:44:11Z

✅ Deploy Preview for authentik-storybook canceled.

Name	Link
🔨 Latest commit	`7445afc`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/6631536f6dfacf0008971c10

netlify · 2024-04-30T04:44:14Z

✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	`7445afc`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-docs/deploys/6631536f6f55da0008923365
😎 Deploy Preview	https://deploy-preview-9524--authentik-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

tanberry · 2024-04-30T10:07:27Z

Thanks very very much for this contribution, @ChenWenBrian ! We definitely need more procedural docs (the How To, with steps, kind of docs), so this is a great addition.

I'll make some edits (grammar and style), then after you make those changes please be sure to run either make website or npm run prettier before you push the chanes. The build is currently failing on lint_prettier.

Thanks again!

tanberry

Thanks so much @ChenWenBrian for these steps, it is great to have more procedural/How To docs.

I made quite a few copy-edits, but I made then as Suggestions so that you can easily accept them. Let me know if you have any questions.

Also, please be sure to run make website or npm run prettier before you push your changes, so that the build checks pass.

website/docs/property-mappings/index.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Brian, Chen <wildfox@126.com>

tanberry · 2024-04-30T20:24:03Z

Hi again, thanks for the speedy fixes. After checking on a few technical details with @BeryJu we think this content might actually better belong on our documentation about LDAP sources, but I want to look at it again tomorrow and get back to you. Wherever it ends up, we very much appreciate having it added to the docs.

Signed-off-by: Brian, Chen <wildfox@126.com>

codecov · 2024-04-30T20:30:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.43%. Comparing base (13ccb35) to head (7445afc).
Report is 109 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9524      +/-   ##
==========================================
- Coverage   92.45%   92.43%   -0.02%     
==========================================
  Files         669      669              
  Lines       32712    32712              
==========================================
- Hits        30243    30237       -6     
- Misses       2469     2475       +6

Flag	Coverage Δ
e2e	`50.62% <ø> (-0.02%)`	⬇️
integration	`25.99% <ø> (ø)`
unit	`89.75% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ChenWenBrian · 2024-04-30T20:32:51Z

Hi @tanberry , thanks for your help. I accepted all your changes and fixed a few typos.

I haven't prepare a dev environment for this project, just update the doc from github UI. so, hope this won't bring too much trouble🙏

tanberry · 2024-05-15T21:17:35Z

Hi again @ChenWenBrian apologies for my delay. We do want to move this content to a different section in the docs; we think it would fit better here: https://docs.goauthentik.io/docs/sources/ldap/#property-mappings

Let me know if you want to do this yourself (either in this PR or in a new one). Or if not, I can move it. Either way, thank you for adding this steps!

ChenWenBrian · 2024-05-16T06:21:05Z

@tanberry please help to move the content, cause i'm not familiar with the procedure, thanks

tanberry · 2024-06-18T21:20:40Z

Closing this one since the work is now done in #10158. Thanks @ChenWenBrian!

Co-authored-by: 4d62 <ext@4d62.me> Co-authored-by: "Brian, Chen" <wildfox@126.com> Co-authored-by: Tana M Berry <tana@goauthentik.com>

* main: (350 commits) web: bump @swc/core from 1.6.6 to 1.6.7 in /web/sfe (#10395) web: bump @sentry/browser from 8.14.0 to 8.15.0 in /web in the sentry group across 1 directory (#10388) website/integrations: aws: cleanup (#10355) web: bump API Client version (#10389) web/flows: Simplified flow executor (#10296) website/docs: sources: ldap: remove extra example (#10387) website/docs: add new content from old PR #9524 (#10158) stages/authenticator_validate: fix friendly_name being required (#10382) core: bump go api client (#10383) web: bump API Client version (#10381) outposts: make refresh interval configurable (#10138) core, web: update translations (#10378) web: bump @sentry/browser from 8.13.0 to 8.14.0 in /web in the sentry group (#10379) core: bump goauthentik.io/api/v3 from 3.2024060.3 to 3.2024060.4 (#10380) sources/oauth: fix link not being saved (#10374) website/docs: update postgres on docker: fix backtick (#10372) website/integrations: apache guacamole: cleanup doc page (#10354) web: bump API Client version (#10371) Revert "core: applications api: add option to only list apps with launch url (#10336)" (#10370) web: bump @wdio/cli from 8.39.0 to 8.39.1 in /web (#10362) ...

* main: (179 commits) website/integrations: add offline_access scope to DokuWiki (#10208) api: use custom json renderer for speed (#9977) core: bump github.com/sethvargo/go-envconfig from 1.0.3 to 1.1.0 (#10405) core: bump goauthentik.io/api/v3 from 3.2024060.5 to 3.2024060.6 (#10404) web: bump glob from 10.4.2 to 10.4.3 in /web (#10407) web: bump @swc/core from 1.6.7 to 1.6.13 in /web/sfe (#10408) core: bump ruff from 0.5.0 to 0.5.1 (#10390) web: bump @swc/cli from 0.3.14 to 0.4.0 in /web/sfe (#10394) core: bump certifi from 2024.2.2 to 2024.7.4 (#10398) web: bump @swc/core from 1.6.6 to 1.6.7 in /web/sfe (#10395) web: bump @sentry/browser from 8.14.0 to 8.15.0 in /web in the sentry group across 1 directory (#10388) website/integrations: aws: cleanup (#10355) web: bump API Client version (#10389) web/flows: Simplified flow executor (#10296) website/docs: sources: ldap: remove extra example (#10387) website/docs: add new content from old PR #9524 (#10158) stages/authenticator_validate: fix friendly_name being required (#10382) core: bump go api client (#10383) web: bump API Client version (#10381) outposts: make refresh interval configurable (#10138) ...

* main: (29 commits) website/integrations: aws: cleanup (#10355) web: bump API Client version (#10389) web/flows: Simplified flow executor (#10296) website/docs: sources: ldap: remove extra example (#10387) website/docs: add new content from old PR #9524 (#10158) stages/authenticator_validate: fix friendly_name being required (#10382) core: bump go api client (#10383) web: bump API Client version (#10381) outposts: make refresh interval configurable (#10138) core, web: update translations (#10378) web: bump @sentry/browser from 8.13.0 to 8.14.0 in /web in the sentry group (#10379) core: bump goauthentik.io/api/v3 from 3.2024060.3 to 3.2024060.4 (#10380) sources/oauth: fix link not being saved (#10374) website/docs: update postgres on docker: fix backtick (#10372) website/integrations: apache guacamole: cleanup doc page (#10354) web: bump API Client version (#10371) Revert "core: applications api: add option to only list apps with launch url (#10336)" (#10370) web: bump @wdio/cli from 8.39.0 to 8.39.1 in /web (#10362) core: bump goauthentik.io/api/v3 from 3.2024060.2 to 3.2024060.3 (#10356) website: bump react-tooltip from 5.27.0 to 5.27.1 in /website (#10357) ...

add doc for Custom LDAP Property Mapping

28dcd9a

Signed-off-by: Brian, Chen <wildfox@126.com>

ChenWenBrian requested a review from a team as a code owner April 30, 2024 04:43

ChenWenBrian mentioned this pull request Apr 30, 2024

Sync more AD/LDAP attributes like displayName #9040

Closed

tanberry requested changes Apr 30, 2024

View reviewed changes

ChenWenBrian and others added 7 commits May 1, 2024 04:11

Update website/docs/property-mappings/index.md

cfabb14

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Brian, Chen <wildfox@126.com>

Update website/docs/property-mappings/index.md

7e7f89b

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Brian, Chen <wildfox@126.com>

Update website/docs/property-mappings/index.md

90ca319

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Brian, Chen <wildfox@126.com>

Update website/docs/property-mappings/index.md

0191e54

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Brian, Chen <wildfox@126.com>

Update website/docs/property-mappings/index.md

0714c73

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Brian, Chen <wildfox@126.com>

Update website/docs/property-mappings/index.md

4d16664

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Brian, Chen <wildfox@126.com>

Update website/docs/property-mappings/index.md

f9c5f74

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Brian, Chen <wildfox@126.com>

Update index.md

7445afc

Signed-off-by: Brian, Chen <wildfox@126.com>

tanberry added the status/awaiting-contributor Awaiting a response from the contributor label May 15, 2024

tanberry removed the status/awaiting-contributor Awaiting a response from the contributor label Jun 18, 2024

tanberry mentioned this pull request Jun 18, 2024

website/docs: add new content from old PR #9524 #10158

Merged

2 tasks

tanberry closed this Jun 18, 2024

rissson pushed a commit that referenced this pull request Jul 5, 2024

website/docs: add new content from old PR #9524 (#10158)

5103eeb

Co-authored-by: 4d62 <ext@4d62.me> Co-authored-by: "Brian, Chen" <wildfox@126.com> Co-authored-by: Tana M Berry <tana@goauthentik.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add doc for Custom LDAP Property Mapping #9524

add doc for Custom LDAP Property Mapping #9524

ChenWenBrian commented Apr 30, 2024

netlify bot commented Apr 30, 2024 •

edited

Loading

netlify bot commented Apr 30, 2024 •

edited

Loading

tanberry commented Apr 30, 2024

tanberry left a comment

tanberry commented Apr 30, 2024

codecov bot commented Apr 30, 2024 •

edited

Loading

ChenWenBrian commented Apr 30, 2024

tanberry commented May 15, 2024

ChenWenBrian commented May 16, 2024

tanberry commented Jun 18, 2024

add doc for Custom LDAP Property Mapping #9524

add doc for Custom LDAP Property Mapping #9524

Conversation

ChenWenBrian commented Apr 30, 2024

Details

Checklist

netlify bot commented Apr 30, 2024 • edited Loading

✅ Deploy Preview for authentik-storybook canceled.

netlify bot commented Apr 30, 2024 • edited Loading

✅ Deploy Preview for authentik-docs ready!

tanberry commented Apr 30, 2024

tanberry left a comment

Choose a reason for hiding this comment

tanberry commented Apr 30, 2024

codecov bot commented Apr 30, 2024 • edited Loading

Codecov Report

ChenWenBrian commented Apr 30, 2024

tanberry commented May 15, 2024

ChenWenBrian commented May 16, 2024

tanberry commented Jun 18, 2024

netlify bot commented Apr 30, 2024 •

edited

Loading

netlify bot commented Apr 30, 2024 •

edited

Loading

codecov bot commented Apr 30, 2024 •

edited

Loading