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: Update authentication.mdx #180

Merged
merged 2 commits into from
Feb 5, 2024
Merged

chore: Update authentication.mdx #180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ade8bd9
chore: Update authentication.mdx
markphelps Feb 5, 2024
7fd704a
chore: format code
markphelps Feb 5, 2024
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 configuration/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,15 @@ See the [Authentication: Overview](/authentication/overview) documentation for m
## Exclusions

Exclusions allow you to disable authentication for sections of the API.
The Flipt API is made of up of top-level API sections, each with its own unique prefix:
The Flipt API is made up of several top-level API sections, each with its own unique prefix.

For example:

- `/api/v1` is the core feature flag state management section
- `/meta` describes the configuration of the running Flipt instance
- `/evaluate/v1` is the application facing flag state evaluation API

Each of these API sections can be optionally omitted from requiring authentication.
A common use case is to allow the evaluation API to be publicly accessible while still requiring authenticated users for managing feature-flag configuration and state.
Several of these API sections can be optionally omitted from requiring authentication.
A common use case is to allow the evaluation API to be publicly accessible while still requiring authenticated users to manage feature-flag configuration and state.

By default, when authentication is configured as `required: true`, the effective configuration for the exclusions looks like this:

Expand All @@ -40,7 +41,6 @@ authentication:
required: true
exclude:
management: false
metadata: false
evaluation: false
```

Expand Down