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

chore: document allowed teams #194

Merged
merged 1 commit into from
Mar 25, 2024
Merged

chore: document allowed teams #194

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
28 changes: 28 additions & 0 deletions configuration/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,34 @@
the user is a member of.
</Note>

#### Allowed Teams

Check warning on line 323 in configuration/authentication.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Titles] 'Allowed Teams' should be in sentence case

Raw Output:
{"message": "[Openly.Titles] 'Allowed Teams' should be in sentence case", "location": {"path": "configuration/authentication.mdx", "range": {"start": {"line": 323, "column": 6}}}, "severity": "WARNING"}

As of version [1.39.0](https://github.com/flipt-io/flipt/releases/tag/v1.39.0) of Flipt, the GitHub authentication method also supports the ability to restrict access to a set of GitHub teams. This is important if you want to limit access to Flipt to only members of a specific team within an organization as opposed to all members of the organization.

Check warning on line 325 in configuration/authentication.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.So] Don't start a sentence with 'so '

Raw Output:
{"message": "[Openly.So] Don't start a sentence with 'so '", "location": {"path": "configuration/authentication.mdx", "range": {"start": {"line": 325, "column": 125}}}, "severity": "WARNING"}

Check warning on line 325 in configuration/authentication.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.SentenceLength] Write short sentences (less than 25 words).

Raw Output:
{"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "configuration/authentication.mdx", "range": {"start": {"line": 325, "column": 194}}}, "severity": "WARNING"}

To enable this feature, set the `github.allowed_teams` configuration value to a list of GitHub teams within existing allowed organizations. For example:

```yaml config.yaml
authentication:
methods:
github:
enabled: true
scopes:
- read:org
allowed_organizations:
- my-org
- my-other-org
allowed_teams:
my-org:
- my-team
my-other-org:
- my-other-team
```

<Note>
The organizations to check for team membership must be included in the
`allowed_organizations` list.
</Note>

### Kubernetes

The `kubernetes` method provides the ability to exchange Kubernetes service account tokens for client tokens.
Expand Down
Loading