Skip to content

Clarify what name to use in alloworgsmap #667

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

Merged
merged 1 commit into from
Sep 23, 2024
Merged

Clarify what name to use in alloworgsmap #667

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
9 changes: 7 additions & 2 deletions docs/admin/auth/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Then add the following lines to your site configuration:
"clientSecret": "replace-with-the-oauth-client-secret",
"allowSignup": false, // CAUTION: Set to true to enable signup. If nothing is specified in `allowOrgs` or `allowOrgsMap`, any GitHub user can sign up.
"allowOrgs": ["your-org-name"], // Restrict logins and sign-ups if enabled to members of these orgs.
"allowOrgsMap": { "orgName": ["your-team-name"]} // Restrict logins and sign-ups if enabled to members of teams that belong to a given org.
"allowOrgsMap": { "orgName": ["Your Team Name"]} // Restrict logins and sign-ups if enabled to members of teams that belong to a given org.
}
]
}
Expand Down Expand Up @@ -154,15 +154,20 @@ When combined with `"allowSignup": false` or unset, an admin should first create

Note that subteams inheritance is not supported — the name of child teams (subteams) should be informed so their members can be granted access to Sourcegraph.

When configuring teams in allowOrgsMap, use the team's display name. If the team names do not match exactly, users will be unable to create an account.

```json
{
"type": "github",
// ...
"allowOrgsMap": {
"org1": [
"team1", "subteam1"
"Your Team Name"
],
"org2": [
"team1", "subteam1"
],
"org3": [
"subteam2"
]
}
Expand Down
Loading