Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Enhance the explanation for the group filter #503

Merged
merged 1 commit into from
Nov 13, 2023
Merged

Enhance the explanation for the group filter #503

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/administration/configure-authentication/oidc-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ Before configuring an OIDC provider in Harbor, make sure that your provider is c

![LDAP authentication](../../../img/select-oidc-auth.png)
1. Enter information about your OIDC provider.
- **Primary Auth Mode**: Whether to use the OIDC mode as the primary auth mode.
{{< note >}}
To override and login via DB is possible when visiting the URL '/account/sign-in' explicitly
{{< /note >}}
- **Primary Auth Mode**: Whether to use the OIDC mode as the primary auth mode.
{{< note >}}
To override and login via DB is possible when visiting the URL '/account/sign-in' explicitly
{{< /note >}}
- **OIDC Provider Name**: The name of the OIDC provider.
- **OIDC Provider Endpoint**: The URL of the endpoint of the OIDC provider.
- **OIDC Client ID**: The client ID with which Harbor is registered as client application with the OIDC provider.
- **OIDC Client Secret**: The secret for the Harbor client application.
- **OIDC Group Filter**: The [regular expression](https://pkg.go.dev/regexp/syntax) to filter OIDC groups.Only the groups that match the provided regular express will be added to Harbor.
- **OIDC Group Filter**: The [regular expression](https://pkg.go.dev/regexp/syntax) to select matching groups from the `Group Claim Name` list . Matching groups are added to Harbor. This filter does not limit the users' capability to log in into Harbor.
- **Group Claim Name**: The name of a custom group claim that you have configured in your OIDC provider, that includes the groups to add to Harbor.
- **OIDC Admin Group**: The name of the admin group, if the ID token of the user shows that he is a member of this group, the user will have admin
privilege in Harbor. **Note**: You can only set one Admin Group. Please also make sure the value in this field matches the value of group item in ID token.
Expand Down