diff --git a/authentication/methods.mdx b/authentication/methods.mdx index e625cd4..b508801 100644 --- a/authentication/methods.mdx +++ b/authentication/methods.mdx @@ -58,6 +58,26 @@ The bootstrap token can also be configured to have an expiration date by setting See the [Configuration: Method Token](/configuration/overview#authentication-methods-token) documentation for more details. +### Token Expiration + +Tokens can be created with an optional expiration date. This can be used to ensure that a token is only valid for a short period of time before automatically expiring. Expired tokens will be automatically be deleted by Flipt. The interval and grace period for this cleanup process can be configured via the `token.cleanup.interval` and `token.cleanup.grace_period` values in the configuration. + +### Namespaced Tokens + +Tokens can be created with an optional namespace to allow for more granular control over access to resources. Namespaces allow for grouping resources such as flags, segments, etc. To learn more about namespaces, see the [Concepts: Namespaces](/concepts#namespaces) documentation. + +Namespaced tokens are useful for the scenario when you want to limit the privileges of an integration such as a CI/CD pipeline or internal service. + + + It's important to note that namespaced tokens offer limited access to the + Flipt API, as only API requests that can be scoped to a namespace are + supported. + + +For example, the `/api/v1/namespaces/{namespace}/flags` endpoint supports a `namespace` parameter, therefore a namespaced token can be used to access this endpoint. However, the `/auth/v1/tokens` endpoint is not associated with a single `namespace`, so a namespaced token cannot be used to access this endpoint. + +This also means that namespaced tokens themselves cannot be used to create additional tokens. Tokens must be created using a non-namespaced (default) token. + ## OpenID Connect [OpenID Connect](https://openid.net/connect/) (OIDC) is a simple identity layer on top of the OAuth 2.0 protocol. It allows Clients to verify the identity of the End-User based on the authentication performed by an Authorization Server, as well as to obtain basic profile information about the End-User in an interoperable and REST-like manner. diff --git a/authentication/using-tokens.mdx b/authentication/using-tokens.mdx index 5172120..e5cdb7c 100644 --- a/authentication/using-tokens.mdx +++ b/authentication/using-tokens.mdx @@ -57,9 +57,9 @@ def doRequest(): ### 2. `Cookie` Header - Please enable [CSRF](/configuration/authentication#session) prevention in your - Flipt configuration when using a "session compatible" authentication method - and `Cookie` based authentication in the browser. + It's important to enable [CSRF](/configuration/authentication#session) + prevention in your Flipt configuration when using a "session compatible" + authentication method and `Cookie` based authentication in the browser. For browser-based applications (e.g. Flipt's own user interface) we support supplying a client token via a particular `Cookie` called `flipt_client_token`. diff --git a/images/authentication/create-token.png b/images/authentication/create-token.png index 0195898..3eeef68 100644 Binary files a/images/authentication/create-token.png and b/images/authentication/create-token.png differ diff --git a/images/concepts/constraints.png b/images/concepts/constraints.png index fb39eab..27ae431 100644 Binary files a/images/concepts/constraints.png and b/images/concepts/constraints.png differ diff --git a/images/concepts/constraints_types.png b/images/concepts/constraints_types.png index 4c79309..7fc160e 100644 Binary files a/images/concepts/constraints_types.png and b/images/concepts/constraints_types.png differ diff --git a/images/concepts/distributions.png b/images/concepts/distributions.png index c52195f..9b0244c 100644 Binary files a/images/concepts/distributions.png and b/images/concepts/distributions.png differ diff --git a/images/concepts/evaluation.png b/images/concepts/evaluation.png index 001f7df..96a6afa 100644 Binary files a/images/concepts/evaluation.png and b/images/concepts/evaluation.png differ diff --git a/images/concepts/flags.png b/images/concepts/flags.png index e158457..4832639 100644 Binary files a/images/concepts/flags.png and b/images/concepts/flags.png differ diff --git a/images/concepts/flags_boolean.png b/images/concepts/flags_boolean.png index b91c085..b79a048 100644 Binary files a/images/concepts/flags_boolean.png and b/images/concepts/flags_boolean.png differ diff --git a/images/concepts/flags_variants.png b/images/concepts/flags_variants.png index 5f26305..da66d49 100644 Binary files a/images/concepts/flags_variants.png and b/images/concepts/flags_variants.png differ diff --git a/images/concepts/namespaces_default.png b/images/concepts/namespaces_default.png index eac5fd2..fd6b17f 100644 Binary files a/images/concepts/namespaces_default.png and b/images/concepts/namespaces_default.png differ diff --git a/images/concepts/namespaces_production.png b/images/concepts/namespaces_production.png index 2903328..0176880 100644 Binary files a/images/concepts/namespaces_production.png and b/images/concepts/namespaces_production.png differ diff --git a/images/concepts/rollouts.png b/images/concepts/rollouts.png index 52a5ef1..a67f5f6 100644 Binary files a/images/concepts/rollouts.png and b/images/concepts/rollouts.png differ diff --git a/images/concepts/rules.png b/images/concepts/rules.png index 8d9fa01..4c53f93 100644 Binary files a/images/concepts/rules.png and b/images/concepts/rules.png differ diff --git a/images/concepts/segments.png b/images/concepts/segments.png index 6b15b5a..0a1774b 100644 Binary files a/images/concepts/segments.png and b/images/concepts/segments.png differ diff --git a/images/concepts/settings_namespaces.png b/images/concepts/settings_namespaces.png index 491c121..a69abf3 100644 Binary files a/images/concepts/settings_namespaces.png and b/images/concepts/settings_namespaces.png differ diff --git a/images/configuration/readonly.png b/images/configuration/readonly.png index 378f176..8157c69 100644 Binary files a/images/configuration/readonly.png and b/images/configuration/readonly.png differ diff --git a/images/getting_started/create_constraint.png b/images/getting_started/create_constraint.png index 289a35d..54713d5 100644 Binary files a/images/getting_started/create_constraint.png and b/images/getting_started/create_constraint.png differ diff --git a/images/getting_started/create_flag.png b/images/getting_started/create_flag.png index 2e141da..b0ddfca 100644 Binary files a/images/getting_started/create_flag.png and b/images/getting_started/create_flag.png differ diff --git a/images/getting_started/create_rule.png b/images/getting_started/create_rule.png index 2aa5dab..9299b42 100644 Binary files a/images/getting_started/create_rule.png and b/images/getting_started/create_rule.png differ diff --git a/images/getting_started/create_segment.png b/images/getting_started/create_segment.png index e4c4a34..1c6cc75 100644 Binary files a/images/getting_started/create_segment.png and b/images/getting_started/create_segment.png differ diff --git a/images/getting_started/create_variant.png b/images/getting_started/create_variant.png index e3738ac..7029506 100644 Binary files a/images/getting_started/create_variant.png and b/images/getting_started/create_variant.png differ diff --git a/images/getting_started/evaluation_console.png b/images/getting_started/evaluation_console.png index 8e9caaa..dd9d478 100644 Binary files a/images/getting_started/evaluation_console.png and b/images/getting_started/evaluation_console.png differ diff --git a/reference/overview.mdx b/reference/overview.mdx index 5ed6562..8274d4a 100644 --- a/reference/overview.mdx +++ b/reference/overview.mdx @@ -10,6 +10,10 @@ The Flipt REST API can also be used with any language that can make HTTP request The latest version of the REST API is fully documented using the [OpenAPI v3 specification](https://github.com/flipt-io/flipt-openapi). +## SDKs + +We're adding new SDKs all the time. To see the current list of official REST SDKs, head to the [REST SDKs](/integration/rest) documentation. + ## Backward Compatibility We take great care to ensure that the Flipt REST API is backward compatible. This means that you can safely upgrade to a newer version of Flipt without having to change your API calls. @@ -34,24 +38,6 @@ All previous endpoints without the `/namespaces` prefix still work as before (i. See the [Concepts: Namespaces](/concepts#namespaces) section for more information. -## SDKs - -Official REST client SDKs exist for the following languages: - -- [Go](https://pkg.go.dev/go.flipt.io/flipt/sdk/go) -- [Node.js/TypeScript](https://github.com/flipt-io/flipt-node) -- [Java](https://github.com/flipt-io/flipt-java) -- [Rust](https://github.com/flipt-io/flipt-rust) -- [Python](https://github.com/flipt-io/flipt-python) - - -We're working on more REST API SDKs and would love to hear from you if you're -interested in helping out or have a request for an SDK in a specific language. - -Please reach out to us in our [Discord server](https://www.flipt.io/discord). - - - ## Authentication