Skip to content

website/docs: adds code examples for getting user objects from a group object#14101

Merged
dewi-tik merged 14 commits intomainfrom
website/docs/user-object-from-group-object
Apr 23, 2025
Merged

website/docs: adds code examples for getting user objects from a group object#14101
dewi-tik merged 14 commits intomainfrom
website/docs/user-object-from-group-object

Conversation

@dewi-tik
Copy link
Contributor

@dewi-tik dewi-tik commented Apr 16, 2025

Details

Closes #13813

Adds code examples of how to get user objects from from a group object.

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

@dewi-tik dewi-tik requested a review from a team as a code owner April 16, 2025 11:52
@netlify
Copy link

netlify bot commented Apr 16, 2025 •
edited
Loading

✅ Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 3db8de9
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/680902b71be1aa000865d7b5

@netlify
Copy link

netlify bot commented Apr 16, 2025 •
edited
Loading

✅ Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 3db8de9
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/680902b7e21cfb00080f7cb1
😎 Deploy Preview https://deploy-preview-14101--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@codecov
Copy link

codecov bot commented Apr 16, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.80%. Comparing base (c6f9d5d) to head (3db8de9).
Report is 56 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #14101      +/-   ##
==========================================
+ Coverage   92.78%   92.80%   +0.02%     
==========================================
  Files         798      808      +10     
  Lines       41138    41419     +281     
==========================================
+ Hits        38168    38440     +272     
- Misses       2970     2979       +9
Flag Coverage Δ
e2e 47.81% <ø> (-0.03%) ⬇️
integration 24.25% <ø> (+0.11%) ⬆️
unit 90.64% <ø> (+0.06%) ⬆️

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.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 16, 2025 •
edited
Loading

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-3db8de9c8876774c8e60e55b003c74ea6f857d94
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-3db8de9c8876774c8e60e55b003c74ea6f857d94

Afterwards, run the upgrade commands from the latest release notes.

tanberry
tanberry reviewed Apr 23, 2025
View reviewed changes
tanberry
tanberry reviewed Apr 23, 2025
View reviewed changes
tanberry
tanberry reviewed Apr 23, 2025
View reviewed changes
tanberry
tanberry reviewed Apr 23, 2025
View reviewed changes
tanberry
tanberry reviewed Apr 23, 2025
View reviewed changes
tanberry
tanberry reviewed Apr 23, 2025
View reviewed changes
tanberry
tanberry reviewed Apr 23, 2025
View reviewed changes
tanberry
tanberry reviewed Apr 23, 2025
View reviewed changes
tanberry
tanberry approved these changes Apr 23, 2025
View reviewed changes
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding more examples, yay! And sorry for all the nits @dewi-tik ! I'm approving so that I am not a bottle-neck here...

dewi-tik and others added 10 commits April 23, 2025 14:18
@dewi-tik @tanberry
Update website/docs/users-sources/groups/group_ref.md
def4b86 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
@dewi-tik @tanberry
Update website/docs/users-sources/groups/group_ref.md
2e5054a 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
@dewi-tik @tanberry
Update website/docs/users-sources/groups/group_ref.md
0ce00b2 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
@dewi-tik @tanberry
Update website/docs/users-sources/groups/group_ref.md
f94c890 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
@dewi-tik @tanberry
Update website/docs/users-sources/groups/group_ref.md
e9d51b9 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
@dewi-tik @tanberry
Update website/docs/users-sources/groups/group_ref.md
ee149b2 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
@dewi-tik @tanberry
Update website/docs/users-sources/groups/group_ref.md
e50f87c 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
@dewi-tik
Changes based on Tana's feedback
f329c6f
@dewi-tik
Word
16d86b4
@dewi-tik
Capitalization
3db8de9
@dewi-tik dewi-tik merged commit 64af0cc into main Apr 23, 2025
91 checks passed
@dewi-tik dewi-tik deleted the website/docs/user-object-from-group-object branch April 23, 2025 15:36
kensternberg-authentik added a commit that referenced this pull request Apr 25, 2025
@kensternberg-authentik
Merge branch 'main' into dev
baa64bc 
* main:
  packages/docusaurus-theme: Fix header alignment, overscroll, vertical padding. (#14120)
  outposts: add support for gateway API (#13272)
  translate: Updates for file web/xliff/en.xlf in fr (#14200)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in fr (#14199)
  website/docs: adds code examples for getting user objects from a group object (#14101)
  translate: Updates for file web/xliff/en.xlf in zh-Hans (#14198)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#14195)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#14197)
  translate: Updates for file web/xliff/en.xlf in zh_CN (#14196)
  website/integrations: mealie add integration (#14188)
  core, web: update translations (#14187)
  core: bump goauthentik.io/api/v3 from 3.2025024.8 to 3.2025024.9 (#14189)
  website/docs: update user object doc (#14132)
  website/docs: dev-docs: style guide: no longer using italic for vars (#14185)
  website/docs: dev docs: style guide: update style conventions for urls (#14184)
  website/integrations: paperless: use <slug>. instead of hardcoded slug value (#14183)
  website/docs: updates style guide code block section (#14088)
  website: components: delete multilinecodeblock src (#14094)
  Revert "policies: buffered policy access view for concurrent authorization attempts when unauthenticated (#13629)" (#14180)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tanberry tanberry tanberry approved these changes

@rissson rissson rissson approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document how to get user object(s) from group object

3 participants

@dewi-tik @tanberry @rissson