website/integrations: vault: add external group documentation #11994
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Mattis Haase <[email protected]>
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for authentik-storybook canceled.
|
tanberry
reviewed
Nov 11, 2024
| @@ -88,8 +88,64 @@ vault write auth/oidc/role/reader \ | |||
| policies="reader" | |||
| ``` | |||
|
|
|||
| ## External Groups | |||
|
|
|||
| If you wish to manage group membership in vault via Authentik you have to use [external groups](https://developer.hashicorp.com/vault/tutorials/auth-methods/oidc-auth#create-an-external-vault-group). | |||
There was a problem hiding this comment.
Suggested change
| If you wish to manage group membership in vault via Authentik you have to use [external groups](https://developer.hashicorp.com/vault/tutorials/auth-methods/oidc-auth#create-an-external-vault-group). | |
| If you wish to manage group membership in Hashicorp Vault via Authentik you have to use [external groups](https://developer.hashicorp.com/vault/tutorials/auth-methods/oidc-auth#create-an-external-vault-group). |
tanberry
reviewed
Nov 11, 2024
| :::note | ||
| If you intend to create [external groups](https://developer.hashicorp.com/vault/tutorials/auth-methods/oidc-auth#create-an-external-vault-group) in Vault to manage user access the OIDC role will need to specifically request a custom scope using the `oidc_scopes` option when creating the OIDC role. |
There was a problem hiding this comment.
Does one no longer need to use the oidc_scopes option at all?
tanberry
reviewed
Nov 11, 2024
|
|
||
| ### Step 1 | ||
|
|
||
| In authentik, edit the oidc provider created above. Unser "Advanced protocol settings" add "authentik default OAuth Mapping: OpenID 'profile'". This includes the "groups" mapping. |
There was a problem hiding this comment.
Suggested change
| In authentik, edit the oidc provider created above. Unser "Advanced protocol settings" add "authentik default OAuth Mapping: OpenID 'profile'". This includes the "groups" mapping. | |
| In authentik, edit the OIDC provider created above. Unser **Advanced protocol settings** add `authentik default OAuth Mapping: OpenID 'profile'` This includes the groups mapping. |
tanberry
reviewed
Nov 11, 2024
|
|
||
| ### Step 2 | ||
|
|
||
| In hashicorp vault, change the reader role |
There was a problem hiding this comment.
Suggested change
| In hashicorp vault, change the reader role | |
| In Vault, change the reader role to have the following settings: |
tanberry
reviewed
Nov 11, 2024
| oidc_scopes=[ "openid profile email" ] | ||
| ``` | ||
|
|
||
| Add a group |
There was a problem hiding this comment.
Suggested change
| Add a group | |
| Add a group. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #11994 +/- ##
==========================================
- Coverage 92.58% 92.56% -0.02%
==========================================
Files 761 761
Lines 37822 37822
==========================================
- Hits 35016 35009 -7
- Misses 2806 2813 +7
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
tanberry
reviewed
Nov 11, 2024
| type="external" | ||
| ``` | ||
|
|
||
| Get the canonical id of the group |
There was a problem hiding this comment.
Suggested change
| Get the canonical id of the group | |
| Get the canonical ID of the group. |
There was a problem hiding this comment.
If this is the canonical ID, let's add this full name: vault_identity_group
tanberry
reviewed
Nov 11, 2024
| vault list identity/group/id | ||
| ``` | ||
|
|
||
| Get the id of the oidc accessor |
There was a problem hiding this comment.
Suggested change
| Get the id of the oidc accessor | |
| Get the ID of the OIDC accessor. |
tanberry
reviewed
Nov 11, 2024
| ``` | ||
|
|
||
|
|
||
| Add a group alias, this maps the group to the oidc backend |
There was a problem hiding this comment.
Suggested change
| Add a group alias, this maps the group to the oidc backend | |
| Add a group alias; this alias maps the group to the OIDC backend. |
tanberry
reviewed
Nov 11, 2024
| canonical_id="group_id" \ | ||
| name="group name in authentik" | ||
| ``` | ||
|
|
||
| You should then be able to sign in via OIDC |
There was a problem hiding this comment.
Can you add a period at end of this sentence, please?
tanberry
requested changes
Nov 11, 2024
|
You might need to run |
rissson
changed the title
|
I implemented the changes in a new commit. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
This PR changes the documentation page https://docs.goauthentik.io/integrations/services/hashicorp-vault/.
It adds more in-depth explanation on how to integrate authentik with hashicorp vault when wanting to use external groups.