From c824ef33aecc3abad788989484a62cc47ce2235d Mon Sep 17 00:00:00 2001 From: Mark Phelps <209477+markphelps@users.noreply.github.com> Date: Sat, 21 Oct 2023 12:09:33 -0400 Subject: [PATCH] chore: add keycloak to auth docs; vale fixes --- .vale/styles/Flipt/spelling-exceptions.txt | 4 ++++ authentication/methods.mdx | 1 + configuration/authentication.mdx | 6 +++--- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.vale/styles/Flipt/spelling-exceptions.txt b/.vale/styles/Flipt/spelling-exceptions.txt index 72c709d..76d6974 100644 --- a/.vale/styles/Flipt/spelling-exceptions.txt +++ b/.vale/styles/Flipt/spelling-exceptions.txt @@ -1,10 +1,12 @@ affordance APIs auditable +backoff boolean caddy codeowners codespaces +config darwin datetime declaratively @@ -17,6 +19,7 @@ flipt flipt's Gitlab grafana +grpc hostname http httplug @@ -24,6 +27,7 @@ https javascript jq json +keycloak linux memcached Minio diff --git a/authentication/methods.mdx b/authentication/methods.mdx index 1c5b012..e625cd4 100644 --- a/authentication/methods.mdx +++ b/authentication/methods.mdx @@ -90,6 +90,7 @@ Numerous OIDC providers are available. For example, we've tested Flipt with: - Dex - Okta - AzureAD +- Keycloak Each provider has their own way of establishing clients and acquiring the relevant credentials. You can find further documentation on leveraging providers like these in our [OIDC Configuration](/configuration/authentication#method-oidc) documentation. diff --git a/configuration/authentication.mdx b/configuration/authentication.mdx index de1e074..7bcd4bc 100644 --- a/configuration/authentication.mdx +++ b/configuration/authentication.mdx @@ -138,8 +138,7 @@ authentication: - profile ``` -Multiple providers can be configured simultaneously. -Each will result in a Login option being presented in the UI, along with a separate endpoint being added in the API to support each provider flow. +Multiple providers can be configured simultaneously. Each provider will result in a login option being presented in the UI, along with a configured endpoint to support the provider flow. !["OIDC Login"](../images/configuration/oidc_login.png) @@ -151,8 +150,9 @@ Flipt has been tested with each of the following providers: - [Dex](https://dexidp.io/docs/openid-connect/) - [Okta](https://developer.okta.com/docs/concepts/oauth-openid/#oauth-2-0) - [AzureAD](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc) +- [Keycloak](https://www.keycloak.org/docs/latest/server_admin/index.html#_identity_broker_oidc) -Though the intention is that it should work with other OIDC providers, these are just the handful the Flipt team has validated. +Though the intention is that it should work with all OIDC providers, these are just the handful the Flipt team has validated. Following any of the links above should take you to the relevant documentation for each of these providers' OIDC client setups. You can use the credentials and client configuration obtained using those steps as configuration for your Flipt instance.