-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
auth/oidc: Adds documentation for SecureAuth IdP #16274
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
```release-note:feature | ||
auth/oidc: Adds support for group membership parsing when using SecureAuth as an OIDC provider. | ||
``` |
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
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
34 changes: 34 additions & 0 deletions
34
website/content/docs/auth/jwt/oidc-providers/secureauth.mdx
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
layout: docs | ||
page_title: OIDC Provider Setup - Auth Methods - SecureAuth | ||
description: OIDC provider configuration for SecureAuth | ||
--- | ||
|
||
## SecureAuth | ||
|
||
The [SecureAuth](https://www.secureauth.com/) identity provider returns group membership | ||
claims as a comma-separated list of strings (e.g. `groups: "group-1,group-2"`) instead | ||
of a list of strings. | ||
|
||
To properly obtain group membership when using SecureAuth as the identity provider for | ||
Vault's OIDC Auth Method, the `secureauth` provider must be explicitly configured as | ||
shown below. | ||
|
||
```shell | ||
vault write auth/oidc/config -<<"EOH" | ||
{ | ||
"oidc_client_id": "your_client_id", | ||
"oidc_client_secret": "your_client_secret", | ||
"default_role": "your_default_role", | ||
"oidc_discovery_url": "https://idp.sasp.gosecureauth.com/your_secure_auth", | ||
"provider_config": { | ||
"provider": "secureauth" | ||
} | ||
} | ||
EOH | ||
``` | ||
|
||
This will instruct the OIDC Auth Method to parse the comma-separated groups claims string | ||
into individual groups. Note that the role's [`groups_claim`](/api-docs/auth/jwt#groups_claim) | ||
value must be properly configured to target the groups claim for your SecureAuth identity | ||
provider. |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@austingebauer could you please update this changelog note to either use the "new feature" format, or move this changelog note to a different section of the changelog?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do, @mladlow 👍