diff --git a/api/README.md b/api/README.md index 0c2fb4d7ac7a..d5dd6360e6b0 100644 --- a/api/README.md +++ b/api/README.md @@ -122,7 +122,7 @@ Add your feature as early as possible to the Flagsmith on Flagsmith project. You Self-hosted installations evaluate against the offline defaults in `integrations/flagsmith/data/environment.json`, so a flag that is missing from it falls back to the default value at its call site. That document holds only the flags tagged `api`, so tag yours or it will not reach self-hosted installations. -To refresh it, run `make update-flagsmith-environment`. This needs the [Flagsmith CLI](https://docs.flagsmith.com/integrating-with-flagsmith/CLI) and an Admin API credential — a browser login via `flagsmith login` is enough. The `update-flagsmith-environment` workflow runs the same target daily and opens a pull request, so dispatching it is the alternative to running it yourself. +To refresh it, run `make update-flagsmith-environment`. This needs the [Flagsmith CLI](https://docs.flagsmith.com/integrating-with-flagsmith/CLI) and a Management API credential — a browser login via `flagsmith login` is enough. The `update-flagsmith-environment` workflow runs the same target daily and opens a pull request, so dispatching it is the alternative to running it yourself. ### Code guidelines: migrations diff --git a/api/api/openapi.py b/api/api/openapi.py index fb3d5d91f56a..22727bc49691 100644 --- a/api/api/openapi.py +++ b/api/api/openapi.py @@ -157,8 +157,8 @@ def get_security_definition( "in": "header", "name": "Authorization", "description": ( - "For Admin API endpoints. " - "Find out more." + "For Management API endpoints. " + "Find out more." ), } diff --git a/api/app/settings/common.py b/api/app/settings/common.py index 219e6aba9437..7a67913a4688 100644 --- a/api/app/settings/common.py +++ b/api/app/settings/common.py @@ -987,7 +987,9 @@ "ALLOWED_CODE_CHALLENGE_METHODS": ["S256"], "SCOPES": { "mcp": "MCP access", - "admin-api": "Admin API access", + # NB: the `admin-api` key is a published OAuth scope identifier sent by + # the Flagsmith CLI — only the human-readable label may change. + "admin-api": "Management API access", }, "DEFAULT_SCOPES": ["mcp"], "SCOPES_BACKEND_CLASS": "oauth2_metadata.scopes.FlagsmithScopes", diff --git a/api/tests/integration/trust_relationships/test_token_exchange.py b/api/tests/integration/trust_relationships/test_token_exchange.py index 51147bacf7b3..76eee0debb91 100644 --- a/api/tests/integration/trust_relationships/test_token_exchange.py +++ b/api/tests/integration/trust_relationships/test_token_exchange.py @@ -28,7 +28,7 @@ def test_token_exchange__matching_token__returns_usable_access_token( assert response_json["token_type"] == "Bearer" assert response_json["expires_in"] == 3600 - # And the minted token authenticates against the admin API + # And the minted token authenticates against the Management API machine_client.credentials( HTTP_AUTHORIZATION=f"Bearer {response_json['access_token']}" ) diff --git a/api/tests/unit/oauth2_metadata/test_authorize_view.py b/api/tests/unit/oauth2_metadata/test_authorize_view.py index 0467f5652458..75a44657d432 100644 --- a/api/tests/unit/oauth2_metadata/test_authorize_view.py +++ b/api/tests/unit/oauth2_metadata/test_authorize_view.py @@ -339,7 +339,7 @@ def test_get__flagsmith_cli_requests_admin_api__returns_application_info( data = response.json() assert data["application"]["client_id"] == FLAGSMITH_CLI_CLIENT_ID assert data["scopes"]["admin-api"] == { - "label": "Admin API access", + "label": "Management API access", "grants": list(SCOPE_GRANTS[SCOPE_ADMIN_API]), } assert data["is_verified"] is True diff --git a/api/tests/unit/oauth2_metadata/test_mappers.py b/api/tests/unit/oauth2_metadata/test_mappers.py index 81a78d18a06f..af40b2b6c011 100644 --- a/api/tests/unit/oauth2_metadata/test_mappers.py +++ b/api/tests/unit/oauth2_metadata/test_mappers.py @@ -20,7 +20,7 @@ def test_map_scopes_to_descriptions__described_scopes__returns_labels_and_grants "grants": list(SCOPE_GRANTS[SCOPE_MCP]), }, SCOPE_ADMIN_API: { - "label": "Admin API access", + "label": "Management API access", "grants": list(SCOPE_GRANTS[SCOPE_ADMIN_API]), }, } diff --git a/api/trust_relationships/serializers.py b/api/trust_relationships/serializers.py index 8df7625d4941..9f07cd6d82f0 100644 --- a/api/trust_relationships/serializers.py +++ b/api/trust_relationships/serializers.py @@ -21,7 +21,7 @@ class TokenExchangeRequestSerializer(serializers.Serializer[None]): class TokenExchangeResponseSerializer(serializers.Serializer[dict[str, Any]]): access_token = serializers.CharField( - help_text="Short-lived access token for the Admin API.", + help_text="Short-lived access token for the Management API.", ) token_type = serializers.CharField(help_text='Always "Bearer".') expires_in = serializers.IntegerField( diff --git a/docs/docs/administration-and-security/access-control/rbac.md b/docs/docs/administration-and-security/access-control/rbac.md index 4f4313c6850f..f7ab6a18be0f 100644 --- a/docs/docs/administration-and-security/access-control/rbac.md +++ b/docs/docs/administration-and-security/access-control/rbac.md @@ -17,7 +17,7 @@ For example, RBAC allows you to achieve the following scenarios: - Only allow certain users to modify your production environments. - Grant a default set of permissions to all users that join your Flagsmith organisation. -- Lock down an [Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) key to a specific set of permissions. +- Lock down a [Management API](/integrating-with-flagsmith/flagsmith-api-overview/management-api) key to a specific set of permissions. - Provide Flagsmith permissions based on your enterprise identity provider's groups when using [SAML single sign-on](/administration-and-security/access-control/saml). @@ -28,7 +28,7 @@ left and open the **Users and Permissions** tab. ### How permissions are assigned -Permissions are granted to **[roles](#roles)**, and roles are assigned to users, [groups](#groups), or [Admin API keys](/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication). A user's effective permissions are the **union of all permissions** from every role assigned to them — both directly and through group membership. +Permissions are granted to **[roles](#roles)**, and roles are assigned to users, [groups](#groups), or [Management API keys](/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication). A user's effective permissions are the **union of all permissions** from every role assigned to them — both directly and through group membership. ![How permissions are assigned](/img/rbac-permissions-diagram.svg) @@ -69,7 +69,7 @@ This granular approach allows you to give users administrative control exactly w #### Custom roles -**Custom roles** can be assigned to users, groups or [Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) keys. Any +**Custom roles** can be assigned to users, groups or [Management API](/integrating-with-flagsmith/flagsmith-api-overview/management-api) keys. Any number of custom roles can be created and assigned. Creating, modifying or assigning roles requires organisation administrator permissions. @@ -299,7 +299,7 @@ assign it to the group instead. Assigning roles to groups has several benefits over assigning permissions directly to a group: -- Roles can be assigned to Admin API keys, but Admin API keys cannot belong to groups. +- Roles can be assigned to Management API keys, but Management API keys cannot belong to groups. - If you need multiple groups or users with similar permissions, the common permissions can be defined in a role and assigned to multiple groups or users instead of being duplicated. - Having roles as the single place where permissions are defined makes auditing permissions easier. diff --git a/docs/docs/administration-and-security/billing-api-usage.md b/docs/docs/administration-and-security/billing-api-usage.md index f317f52acaeb..f76e64bfbd56 100644 --- a/docs/docs/administration-and-security/billing-api-usage.md +++ b/docs/docs/administration-and-security/billing-api-usage.md @@ -45,7 +45,7 @@ default) to fetch the flags for the current environment and all users in one API The following requests are not billable: -- [Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) requests. +- [Management API](/integrating-with-flagsmith/flagsmith-api-overview/management-api) requests. - Requests made by Flagsmith SDKs to track [Flag Analytics](/managing-flags/flag-analytics). - Connecting to a [real-time flag updates](/performance/real-time-flags) stream. diff --git a/docs/docs/administration-and-security/data-management/import-and-export.md b/docs/docs/administration-and-security/data-management/import-and-export.md index f9815b441998..57fdbbdb202a 100644 --- a/docs/docs/administration-and-security/data-management/import-and-export.md +++ b/docs/docs/administration-and-security/data-management/import-and-export.md @@ -17,7 +17,7 @@ There are several ways of importing or exporting Flagsmith data: between Flagsmith projects. * [Organisation import/export](organisations-import-export). Export an entire Flagsmith organisation and copy it to a different Flagsmith instance. -* Use the [Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) to manually manage your Flagsmith data. +* Use the [Management API](/integrating-with-flagsmith/flagsmith-api-overview/management-api) to manually manage your Flagsmith data. ## Import from third-party services diff --git a/docs/docs/administration-and-security/data-management/organisations-import-export.md b/docs/docs/administration-and-security/data-management/organisations-import-export.md index b52411152a59..73bbc5621441 100644 --- a/docs/docs/administration-and-security/data-management/organisations-import-export.md +++ b/docs/docs/administration-and-security/data-management/organisations-import-export.md @@ -46,7 +46,7 @@ We **will not** export the following entities: - Audit logs - Change requests - Scheduled flag changes -- Admin API keys +- Management API keys - Groups and custom roles - SAML configurations and login method restrictions @@ -179,7 +179,7 @@ following methods: the URL bar: `https://flagsmith.example.com/organisation/YOUR_ORGANISATION_ID/...`. * From [Django Admin](/deployment-self-hosting/administration-and-maintenance/using-the-django-admin), browse to the Organisations section in the sidebar. Here you can see all of your organisations and their IDs. -* If you have an Admin API key, call the +* If you have a Management API key, call the [List Organisations API endpoint](https://api.flagsmith.com/api/v1/docs/#/api/api_v1_organisations_list). This returns all the organisations that your API key is a member of. diff --git a/docs/docs/administration-and-security/governance-and-compliance/custom-fields.md b/docs/docs/administration-and-security/governance-and-compliance/custom-fields.md index dcd0970f6817..3abb03ece24e 100644 --- a/docs/docs/administration-and-security/governance-and-compliance/custom-fields.md +++ b/docs/docs/administration-and-security/governance-and-compliance/custom-fields.md @@ -69,7 +69,7 @@ Custom fields are mainly intended to be read by humans visiting the Flagsmith da Custom field values associated with features belong to the features themselves, and not an environment's feature state; you cannot override custom field values in different environments, segments or identities. They are not returned to applications that consume flags. -Custom field values are added directly to the `metadata` field of the entity they are defined in, which can be read using the [Flagsmith Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api). For example, to fetch a feature's custom fields, use the [endpoint to fetch a feature by ID](https://api.flagsmith.com/api/v1/docs/#/api/api_v1_projects_features_read): +Custom field values are added directly to the `metadata` field of the entity they are defined in, which can be read using the [Flagsmith Management API](/integrating-with-flagsmith/flagsmith-api-overview/management-api). For example, to fetch a feature's custom fields, use the [endpoint to fetch a feature by ID](https://api.flagsmith.com/api/v1/docs/#/api/api_v1_projects_features_read): ```shell curl "https://api.flagsmith.com/api/v1/projects/YOUR_PROJECT_ID/features/YOUR_FEATURE_ID/" \ diff --git a/docs/docs/administration-and-security/governance-and-compliance/system-limits.md b/docs/docs/administration-and-security/governance-and-compliance/system-limits.md index 172ff47b4949..e6e12d4b1f91 100644 --- a/docs/docs/administration-and-security/governance-and-compliance/system-limits.md +++ b/docs/docs/administration-and-security/governance-and-compliance/system-limits.md @@ -31,7 +31,8 @@ Please contact us if you want to override the current system limits. ### Self Hosted You can modify the system limits on a per-Project basis. These limits are defined in the database against the Project. -The easiest way to modify them is with the [Django admin](/deployment-self-hosting/administration-and-maintenance/using-the-django-admin) interface. +The easiest way to modify them is with the +[Django admin](/deployment-self-hosting/administration-and-maintenance/using-the-django-admin) interface. ## Traffic Limits @@ -73,10 +74,10 @@ to our [Pricing Page](https://www.flagsmith.com/pricing) for overage pricing. We will bill you for all overage above your plan in the current calendar month. You will be charged for the overage at the end of your billing period. -### Admin API Rate Limit +### Management API Rate Limit -Requests made to [Admin API endpoints](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) (i.e., non-SDK endpoints) are subject -to a default rate limit of 500 requests per minute. +Requests made to [Management API endpoints](/integrating-with-flagsmith/flagsmith-api-overview/management-api) (i.e., +non-SDK endpoints) are subject to a default rate limit of 500 requests per minute. If you are self-hosting, you have the flexibility to modify this limit by adjusting the value of the environment variable `USER_THROTTLE_RATE`. diff --git a/docs/docs/deployment-self-hosting/mcp-server.md b/docs/docs/deployment-self-hosting/mcp-server.md index 2b7c6f41fd2b..2dd923407663 100644 --- a/docs/docs/deployment-self-hosting/mcp-server.md +++ b/docs/docs/deployment-self-hosting/mcp-server.md @@ -8,7 +8,7 @@ description: Run the Flagsmith MCP Server as part of your self-hosted deployment import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; The [Flagsmith MCP Server](/integrating-with-flagsmith/mcp-server) gives AI assistants and agents access to the -Flagsmith Admin API through the [Model Context Protocol](https://modelcontextprotocol.io). On Flagsmith SaaS it is +Flagsmith Management API through the [Model Context Protocol](https://modelcontextprotocol.io). On Flagsmith SaaS it is hosted for you at `https://mcp.flagsmith.com`. When you self-host Flagsmith, you run the server yourself as an additional container alongside your API. @@ -112,7 +112,7 @@ The server is configured entirely through environment variables. | `TRANSPORT` | `http` | MCP transport. Use `http` for a hosted server. `stdio` runs the server as a local subprocess and requires `FLAGSMITH_API_TOKEN`. | | `FASTMCP_HOST` | `0.0.0.0` | Host the HTTP transport binds to. | | `FASTMCP_PORT` | `8000` | Port the HTTP transport binds to. | -| `FLAGSMITH_API_TOKEN` | _(unset)_ | A static [API key](/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication) the server uses for every request. See [Authentication](#authentication). | +| `FLAGSMITH_API_TOKEN` | _(unset)_ | A static [API key](/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication) the server uses for every request. See [Authentication](#authentication). | | `METRICS_PORT` | _(unset)_ | Serve [Prometheus metrics](/deployment-self-hosting/observability/metrics) on this port. Disabled when unset. | | `LOG_LEVEL` | `INFO` | Log level for application loggers. | | `LOG_FORMAT` | `generic` | Log output format. Set to `json` for structured logs. | @@ -137,7 +137,7 @@ key instead. ### API key (non-interactive clients) Clients can authenticate per request by sending an -[Organisation API key](/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication) in the +[Organisation API key](/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication) in the `Authorization` header: ``` diff --git a/docs/docs/getting-started/glossary.md b/docs/docs/getting-started/glossary.md index f9897b5784cd..b48571ff8bc1 100644 --- a/docs/docs/getting-started/glossary.md +++ b/docs/docs/getting-started/glossary.md @@ -6,38 +6,58 @@ sidebar_position: 3 This glossary provides concise definitions for some of the key concepts within Flagsmith: -- [**A/B Testing**](/experimentation-ab-testing): A method of testing different feature variants with different user groups, often implemented using multivariate flags and percentage splits. +- [**A/B Testing**](/experimentation-ab-testing): A method of testing different feature variants with different user + groups, often implemented using multivariate flags and percentage splits. -- [**Core API**](/integrating-with-flagsmith/flagsmith-api-overview/admin-api): Flagsmith's private API for programmatic control of the platform. +- [**Core API**](/integrating-with-flagsmith/flagsmith-api-overview/management-api): Flagsmith's private API for + programmatic control of the platform. -- [**Edge API**](/performance/edge-api): Flagsmith's publicly accessible API, specifically intended for use with our SDKs. +- [**Edge API**](/performance/edge-api): Flagsmith's publicly accessible API, specifically intended for use with our + SDKs. -- [**Edge Proxy**](/performance/edge-proxy): A self-hosted service that provides a local, low-latency interface to the Flagsmith API. +- [**Edge Proxy**](/performance/edge-proxy): A self-hosted service that provides a local, low-latency interface to the + Flagsmith API. -- [**Environment**](/flagsmith-concepts/data-model#environments): Environments are a way to separate the configuration of your features. A project can have any number of environments. +- [**Environment**](/flagsmith-concepts/data-model#environments): Environments are a way to separate the configuration + of your features. A project can have any number of environments. -- [**Environment Document**](/integrating-with-flagsmith/sdks/#the-environment-document): A JSON document containing all configuration for feature flags in an environment. +- [**Environment Document**](/integrating-with-flagsmith/sdks/#the-environment-document): A JSON document containing all + configuration for feature flags in an environment. -- [**Feature**](/flagsmith-concepts/data-model#features): A configuration that can be enabled, disabled, or set to a specific value. Features are shared across all Environments in a project, but their values/states can be modified between Environments. +- [**Feature**](/flagsmith-concepts/data-model#features): A configuration that can be enabled, disabled, or set to a + specific value. Features are shared across all Environments in a project, but their values/states can be modified + between Environments. -- [**Feature Flag**](/getting-started/feature-flags): A boolean or multivariate switch to enable/disable features or set their values dynamically without deploying code. +- [**Feature Flag**](/getting-started/feature-flags): A boolean or multivariate switch to enable/disable features or set + their values dynamically without deploying code. -- [**Identity**](/flagsmith-concepts/data-model#identities): An entity within a particular environment, against which you can manage and override feature settings. +- [**Identity**](/flagsmith-concepts/data-model#identities): An entity within a particular environment, against which + you can manage and override feature settings. -- [**Local Evaluation Mode**](/integrating-with-flagsmith/sdks/#local-evaluation): A mode where the SDK evaluates feature flags locally using a downloaded environment document, reducing latency and API calls. +- [**Local Evaluation Mode**](/integrating-with-flagsmith/sdks/#local-evaluation): A mode where the SDK evaluates + feature flags locally using a downloaded environment document, reducing latency and API calls. -- [**Multivariate Flag**](/managing-flags/core-management): A feature flag that can take on multiple values (not just on/off), useful for A/B testing. +- [**Multivariate Flag**](/managing-flags/core-management): A feature flag that can take on multiple values (not just + on/off), useful for A/B testing. -- [**Organisation**](/flagsmith-concepts/data-model#organisations): Organisations are a way for you and other team members to manage projects and their features. Users can be members of multiple organisations. +- [**Organisation**](/flagsmith-concepts/data-model#organisations): Organisations are a way for you and other team + members to manage projects and their features. Users can be members of multiple organisations. -- [**Project**](/flagsmith-concepts/data-model#projects): Projects contain one or more Environments that share a single set of Features across all of the Environments within the Project. Organisations can have any number of Projects. +- [**Project**](/flagsmith-concepts/data-model#projects): Projects contain one or more Environments that share a single + set of Features across all of the Environments within the Project. Organisations can have any number of Projects. -- [**Role-Based Access Control (RBAC)**](/administration-and-security/access-control/rbac): A system for managing user permissions and access within an organisation. +- [**Role-Based Access Control (RBAC)**](/administration-and-security/access-control/rbac): A system for managing user + permissions and access within an organisation. -- [**SDK (Software Development Kit)**](/integrating-with-flagsmith/integration-overview): Client libraries provided by Flagsmith for integrating feature flagging into applications. +- [**SDK (Software Development Kit)**](/integrating-with-flagsmith/integration-overview): Client libraries provided by + Flagsmith for integrating feature flagging into applications. -- [**Segment**](/flagsmith-concepts/data-model#segments): A group of identities defined by traits (e.g., logins, device, location, or custom traits). You can override feature defaults for segments, such as enabling features for a "power user" group. +- [**Segment**](/flagsmith-concepts/data-model#segments): A group of identities defined by traits (e.g., logins, device, + location, or custom traits). You can override feature defaults for segments, such as enabling features for a "power + user" group. -- [**Staged Rollout**](/managing-flags/rollout/rollout-by-percentage): Gradually enabling a feature for increasing percentages of your identities to reduce risk. +- [**Staged Rollout**](/managing-flags/rollout/rollout-by-percentage): Gradually enabling a feature for increasing + percentages of your identities to reduce risk. -- [**Trait**](/flagsmith-concepts/data-model#traits): A key-value pair associated with an identity that can store any type of data. +- [**Trait**](/flagsmith-concepts/data-model#traits): A key-value pair associated with an identity that can store any + type of data. diff --git a/docs/docs/getting-started/quick-start.md b/docs/docs/getting-started/quick-start.md index c10d96b1e2b6..60d0f755f120 100644 --- a/docs/docs/getting-started/quick-start.md +++ b/docs/docs/getting-started/quick-start.md @@ -185,5 +185,5 @@ From here, some areas of the documentation you might want to check out are: - [SDKs & Integrations](/integrating-with-flagsmith/integration-overview): Explore all supported SDKs for integrating Flagsmith with your technology stack. ### Automation & API Access -- [REST API Reference](/integrating-with-flagsmith/flagsmith-api-overview/admin-api/): Learn how to manage flags programmatically and automate flag changes. +- [REST API Reference](/integrating-with-flagsmith/flagsmith-api-overview/management-api/): Learn how to manage flags programmatically and automate flag changes. diff --git a/docs/docs/integrating-with-flagsmith/CLI.md b/docs/docs/integrating-with-flagsmith/CLI.md index d6b07e780493..1f8092c1f0e5 100644 --- a/docs/docs/integrating-with-flagsmith/CLI.md +++ b/docs/docs/integrating-with-flagsmith/CLI.md @@ -77,7 +77,7 @@ flagsmith api /projects/ # call any Flagsmith endpoint w Common conventions: - `--json` for machine-readable output; `--jq ` to filter it. -- Static credentials: `FLAGSMITH_API_KEY` (Admin API) or `FLAGSMITH_ENVIRONMENT_KEY` (SDK). +- Static credentials: `FLAGSMITH_API_KEY` (Management API) or `FLAGSMITH_ENVIRONMENT_KEY` (SDK). - Self-hosted: `--api-url` or `FLAGSMITH_API_URL`. For the full command reference, see the [README](https://github.com/Flagsmith/flagsmith-cli#commands). @@ -87,7 +87,7 @@ For the full command reference, see the [README](https://github.com/Flagsmith/fl ### GitHub Actions Configure an -[OIDC trust relationship](/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication#oidc-trust-relationships) +[OIDC trust relationship](/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication#oidc-trust-relationships) for your repository, then use the [`Flagsmith/setup-cli`](https://github.com/Flagsmith/setup-cli) action: @@ -110,7 +110,7 @@ them explicitly with `--project` and `--environment`. ### Other providers If your CI provider supports OIDC, you can set up -[a generic trust relationship](/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication#other-oidc-providers) +[a generic trust relationship](/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication#other-oidc-providers) for it. Here are some of the CI providers that support OIDC: @@ -129,7 +129,7 @@ Here are some of the CI providers that support OIDC: On CI systems that don't support OIDC, pass a static credential instead. Management commands expect a `FLAGSMITH_API_KEY` variable (a -[Master API Key](/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication#generating-an-api-token)). +[Master API Key](/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication#generating-an-api-token)). If you only need `flagsmith eval`, providing an environment key via `FLAGSMITH_ENVIRONMENT_KEY` variable containing a [client-side](/integrating-with-flagsmith/flagsmith-api-overview/flags-api/authentication) or diff --git a/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/admin-api/index.md b/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/admin-api/index.md deleted file mode 100644 index ee9bc0566df9..000000000000 --- a/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/admin-api/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Admin API -sidebar_label: Admin API ---- - -The Admin API allows you to programmatically manage your Flagsmith projects, environments, features, segments, and users. Essentially, any action you can perform in the Flagsmith dashboard can also be accomplished via the Admin API. - -This API is designed for automation, integrations, and building custom workflows on top of Flagsmith. - -## API Explorer - -You can explore the full Admin API via Swagger at [https://api.flagsmith.com/api/v1/docs/](https://api.flagsmith.com/api/v1/docs/). You can also get the OpenAPI specification in [JSON](https://api.flagsmith.com/api/v1/swagger.json) or [YAML](https://api.flagsmith.com/api/v1/swagger.yaml) format. - -We also have a [Postman Collection](https://www.postman.com/flagsmith/workspace/flagsmith/overview) that you can use to experiment with the API. - -:::info -Our Admin API has a [Rate Limit](/administration-and-security/governance-and-compliance/system-limits#admin-api-rate-limit) that you should be aware of. -::: \ No newline at end of file diff --git a/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/index.md b/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/index.md index a1ca4ab3c6a9..52915c9e9662 100644 --- a/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/index.md +++ b/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/index.md @@ -16,12 +16,12 @@ This is the API that your client and server-side SDKs interact with to get flag [Learn more about the Flags API](/integrating-with-flagsmith/flagsmith-api-overview/flags-api). -### 2. The Admin API (Private Admin API) +### 2. The Management API (Private API) -This is the API you use to programmatically manage your Flagsmith projects. Anything you can do in the Flagsmith dashboard, you can also do via the Admin API. +This is the API you use to programmatically manage your Flagsmith projects. Anything you can do in the Flagsmith dashboard, you can also do via the Management API. - **Purpose:** Creating, updating, and deleting projects, environments, flags, segments, and users. - **Authentication:** Uses a secret **Organisation API Token**. - **Security:** Requires a secret key that should never be exposed in client-side code. -[Learn more about the Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api). \ No newline at end of file +[Learn more about the Management API](/integrating-with-flagsmith/flagsmith-api-overview/management-api). \ No newline at end of file diff --git a/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication.md b/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication.md similarity index 90% rename from docs/docs/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication.md rename to docs/docs/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication.md index 0713cec73a3e..9e5efd34c196 100644 --- a/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication.md +++ b/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication.md @@ -3,7 +3,7 @@ title: Authentication sidebar_label: Authentication --- -To interact with the Admin API, you need to authenticate your requests using an API Token associated with your +To interact with the Management API, you need to authenticate your requests using an API Token associated with your Organisation, or a short-lived access token obtained through an [OIDC trust relationship](#oidc-trust-relationships). :::info @@ -36,13 +36,13 @@ An API token acts with the permissions selected when it was created: either full projects within that organisation — or a set of RBAC roles. Be sure to keep it secure and never expose it in client-side applications. -For SaaS customers, the base URL for the Admin API is `https://api.flagsmith.com/`. If you are self-hosting, you will +For SaaS customers, the base URL for the Management API is `https://api.flagsmith.com/`. If you are self-hosting, you will need to use your own API URL. ## OIDC trust relationships Trust relationships let a workload that already has an OIDC identity — for example, a GitHub Actions job — call the -Admin API without any stored secrets. The workload exchanges its OIDC token for a short-lived Flagsmith access token, in +Management API without any stored secrets. The workload exchanges its OIDC token for a short-lived Flagsmith access token, in the same way cloud providers implement workload identity federation. ### Configuring a trust relationship @@ -99,7 +99,7 @@ A successful exchange returns a short-lived access token: } ``` -Use it as a bearer token on Admin API requests: +Use it as a bearer token on Management API requests: ```bash Authorization: Bearer diff --git a/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/admin-api/code-examples.md b/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/management-api/code-examples.md similarity index 87% rename from docs/docs/integrating-with-flagsmith/flagsmith-api-overview/admin-api/code-examples.md rename to docs/docs/integrating-with-flagsmith/flagsmith-api-overview/management-api/code-examples.md index 555b05b56988..656bc02883a9 100644 --- a/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/admin-api/code-examples.md +++ b/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/management-api/code-examples.md @@ -3,7 +3,7 @@ title: Code Examples sidebar_label: Code Examples --- -Here is a simple example of how to use the Admin API with `curl` to create a new environment within a project. +Here is a simple example of how to use the Management API with `curl` to create a new environment within a project. ```bash curl 'https://api.flagsmith.com/api/v1/environments/' \ diff --git a/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/management-api/index.md b/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/management-api/index.md new file mode 100644 index 000000000000..30c73a717554 --- /dev/null +++ b/docs/docs/integrating-with-flagsmith/flagsmith-api-overview/management-api/index.md @@ -0,0 +1,22 @@ +--- +title: Management API +sidebar_label: Management API +--- + +The Management API allows you to programmatically manage your Flagsmith projects, environments, features, segments, and users. Essentially, any action you can perform in the Flagsmith dashboard can also be accomplished via the Management API. + +This API is designed for automation, integrations, and building custom workflows on top of Flagsmith. + +You do not need administrator privileges to use it. Requests act with the permissions of the API key or user +making them, so any member of an organisation can use the Management API within the scope of their +[permissions](/administration-and-security/access-control/rbac). + +## API Explorer + +You can explore the full Management API via Swagger at [https://api.flagsmith.com/api/v1/docs/](https://api.flagsmith.com/api/v1/docs/). You can also get the OpenAPI specification in [JSON](https://api.flagsmith.com/api/v1/swagger.json) or [YAML](https://api.flagsmith.com/api/v1/swagger.yaml) format. + +We also have a [Postman Collection](https://www.postman.com/flagsmith/workspace/flagsmith/overview) that you can use to experiment with the API. + +:::info +Our Management API has a [Rate Limit](/administration-and-security/governance-and-compliance/system-limits#management-api-rate-limit) that you should be aware of. +::: \ No newline at end of file diff --git a/docs/docs/integrating-with-flagsmith/mcp-server.mdx b/docs/docs/integrating-with-flagsmith/mcp-server.mdx index 74c88d25f8c0..a3e5b2909bb9 100644 --- a/docs/docs/integrating-with-flagsmith/mcp-server.mdx +++ b/docs/docs/integrating-with-flagsmith/mcp-server.mdx @@ -11,7 +11,7 @@ import McpToolCatalogueEnterprise from './_mcp-tool-catalogue-enterprise.md'; # MCP Server -The Flagsmith MCP Server gives AI assistants and agents programmatic access to the Flagsmith Admin API through the +The Flagsmith MCP Server gives AI assistants and agents programmatic access to the Flagsmith Management API through the [Model Context Protocol](https://modelcontextprotocol.io). Your assistant can manage feature flags, segments, multivariate options, and release workflows on your behalf — in a human-in-the-loop IDE session, or fully automated in a CI/CD pipeline. @@ -47,7 +47,7 @@ browser, you log in to Flagsmith and authorise access, and the client stores the ### API key (CI and non-interactive agents) For automation — CI jobs, headless agents — authenticate with an -[Organisation API key](/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication) by sending it in the +[Organisation API key](/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication) by sending it in the `Authorization` header: ``` diff --git a/docs/docs/integrating-with-flagsmith/sdks/index.md b/docs/docs/integrating-with-flagsmith/sdks/index.md index 8d493585abb5..5c1bac9b9073 100644 --- a/docs/docs/integrating-with-flagsmith/sdks/index.md +++ b/docs/docs/integrating-with-flagsmith/sdks/index.md @@ -292,9 +292,9 @@ Server-side SDK Keys give server-side SDKs access to [Local Evaluation](#local-e These keys are secret and should not be shared. -### Admin API +### Management API -Admin API keys are used to interact with the Flagsmith API directly. These keys can be used in the following +Management API keys are used to interact with the Flagsmith API directly. These keys can be used in the following situations: - If you want to work with Flagsmith programatically, for example when creating and deleting Environments as part of a diff --git a/docs/docs/managing-flags/code-references.md b/docs/docs/managing-flags/code-references.md index be6f76c7ca47..2afa8aa57c1f 100644 --- a/docs/docs/managing-flags/code-references.md +++ b/docs/docs/managing-flags/code-references.md @@ -133,5 +133,5 @@ Feature details will expand on the _Usage_ tab, and list locations of each code ## Related -- [Admin API Authentication](/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication): Generate API keys for Code References +- [Management API Authentication](/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication): Generate API keys for Code References - [Flag Lifecycle](/best-practices/flag-lifecycle): Learn when to remove short-lived flags from your code diff --git a/docs/docs/managing-flags/feature-versioning.md b/docs/docs/managing-flags/feature-versioning.md index 942d8702c1e2..c5ec0e272959 100644 --- a/docs/docs/managing-flags/feature-versioning.md +++ b/docs/docs/managing-flags/feature-versioning.md @@ -6,7 +6,7 @@ sidebar_position: 5 Feature Versioning attaches versions to feature value and segment override updates. You can browse past versions, schedule future ones, and roll back to an earlier version. -Editing flags through the dashboard is unchanged. This page describes what changes when you enable Feature Versioning v2 on an environment for your webhook consumers, your audit-log pipeline, and your scripts that talk to the Admin API. +Editing flags through the dashboard is unchanged. This page describes what changes when you enable Feature Versioning v2 on an environment for your webhook consumers, your audit-log pipeline, and your scripts that talk to the Management API. ## Prerequisites diff --git a/docs/docs/performance/real-time-flags.md b/docs/docs/performance/real-time-flags.md index 56784eab2f81..20d0db01d4f4 100644 --- a/docs/docs/performance/real-time-flags.md +++ b/docs/docs/performance/real-time-flags.md @@ -10,7 +10,10 @@ Real-time flag updates require an Enterprise subscription. ::: -When an application fetches its current feature flags, it usually caches the flags for a certain amount of time to make [efficient use](/best-practices/efficient-api-usage) of the Flagsmith API and network resources. In some cases, you may want an application to be notified about feature flag updates without needing to repeatedly call the Flagsmith API. This guide explains how to achieve this by subscribing to real-time flag updates. +When an application fetches its current feature flags, it usually caches the flags for a certain amount of time to make +[efficient use](/best-practices/efficient-api-usage) of the Flagsmith API and network resources. In some cases, you may +want an application to be notified about feature flag updates without needing to repeatedly call the Flagsmith API. This +guide explains how to achieve this by subscribing to real-time flag updates. ## Setup @@ -20,11 +23,13 @@ To enable real-time flag updates for your Flagsmith project: 2. Navigate to **Project Settings > SDK Settings**. 3. Enable **Real-time updates**. -By default, applications using a supported Flagsmith SDK do not subscribe to real-time flag updates. Refer to your SDK's documentation for subscribing to real-time flag updates. +By default, applications using a supported Flagsmith SDK do not subscribe to real-time flag updates. Refer to your SDK's +documentation for subscribing to real-time flag updates. ## How it works -The following sequence diagram shows how a typical application would use real-time flag updates. [Billable API requests](/administration-and-security/billing-api-usage) are highlighted in yellow. +The following sequence diagram shows how a typical application would use real-time flag updates. +[Billable API requests](/administration-and-security/billing-api-usage) are highlighted in yellow. ```mermaid sequenceDiagram @@ -44,15 +49,23 @@ sequenceDiagram Application-->Application: Store latest update timestamp ``` -Your application subscribes to real-time flag updates by opening a long-lived [server-sent events (SSE)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) connection to Flagsmith, which is specific to its current environment. +Your application subscribes to real-time flag updates by opening a long-lived +[server-sent events (SSE)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) connection to Flagsmith, +which is specific to its current environment. -When the environment is updated in some way, either via the Flagsmith dashboard or the [Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api), all clients connected to that environment's real-time stream will receive a message containing the latest update's timestamp. If your application's latest flags are older than the received timestamp, it requests the latest flags from Flagsmith. When your application receives the latest flags, you must propagate the latest flag state throughout your application as necessary. +When the environment is updated in some way, either via the Flagsmith dashboard or the +[Management API](/integrating-with-flagsmith/flagsmith-api-overview/management-api), all clients connected to that +environment's real-time stream will receive a message containing the latest update's timestamp. If your application's +latest flags are older than the received timestamp, it requests the latest flags from Flagsmith. When your application +receives the latest flags, you must propagate the latest flag state throughout your application as necessary. ## Limitations -Real-time flag update events only contain a timestamp indicating when any flag in the environment was last updated. Applications must still call the Flagsmith API to get the actual flags for their current environment or user. +Real-time flag update events only contain a timestamp indicating when any flag in the environment was last updated. +Applications must still call the Flagsmith API to get the actual flags for their current environment or user. -Only changes made to environments or projects result in flag update events. For example, the following operations will cause updates to be sent: +Only changes made to environments or projects result in flag update events. For example, the following operations will +cause updates to be sent: - Manually toggling a flag on or off, or changing its value. - A [scheduled Change Request](/managing-flags/scheduled-flags) for a feature goes live. @@ -85,7 +98,7 @@ Each real-time flag event message is a JSON object containing a Unix epoch times ```json { - "updated_at": 3133690620000 + "updated_at": 3133690620000 } ``` @@ -97,6 +110,8 @@ curl -H 'Accept: text/event-stream' -N -i https://realtime.flagsmith.com/sse/env ## What's next? -- [Efficient API Usage](/best-practices/efficient-api-usage) – Tips for reducing API calls and making the most of your integration. +- [Efficient API Usage](/best-practices/efficient-api-usage) – Tips for reducing API calls and making the most of your + integration. - [Edge Proxy](/performance/edge-proxy) – Run the Flagsmith engine closer to your infrastructure for even lower latency. -- [Integration Approaches](/best-practices/integration-approaches) – Explore different ways to integrate Flagsmith into your applications. +- [Integration Approaches](/best-practices/integration-approaches) – Explore different ways to integrate Flagsmith into + your applications. diff --git a/docs/docs/sdk-api/flagsmith-api.info.mdx b/docs/docs/sdk-api/flagsmith-api.info.mdx index dfa8cd3b722b..f0ee7622f42d 100644 --- a/docs/docs/sdk-api/flagsmith-api.info.mdx +++ b/docs/docs/sdk-api/flagsmith-api.info.mdx @@ -8,8 +8,8 @@ hide_title: true custom_edit_url: null --- -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; +import ApiLogo from '@theme/ApiLogo'; +import Heading from '@theme/Heading'; # Flagsmith SDK API @@ -19,12 +19,15 @@ The SDK API is designed to be used by Flagsmith SDKs to evaluate feature flags a The SDK API is designed to be publicly accessible. Calls need to have an environment key supplied with each request. This is provided as an HTTP header, with the name `X-Environment-Key` and the value of the Environment Key that you can -find within the Flagsmith administrative area. See [Flags API Authentication](/integrating-with-flagsmith/flagsmith-api-overview/flags-api/authentication) for more details. +find within the Flagsmith administrative area. See +[Flags API Authentication](/integrating-with-flagsmith/flagsmith-api-overview/flags-api/authentication) for more +details. ## Core API -Please note that the SDK API is specifically to be used with our [SDKs](/integrating-with-flagsmith/integration-overview). If you want to drive aspects of -Flagsmith programmatically, you need to use our private [Core API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api). +Please note that the SDK API is specifically to be used with our +[SDKs](/integrating-with-flagsmith/integration-overview). If you want to drive aspects of Flagsmith programmatically, +you need to use our private [Core API](/integrating-with-flagsmith/flagsmith-api-overview/management-api). You can find the full spec to our Core API [here](https://api.flagsmith.com/api/v1/docs/). diff --git a/docs/docs/sdk-api/sdk-v-1-environment-document.api.mdx b/docs/docs/sdk-api/sdk-v-1-environment-document.api.mdx index f0deb32da2c0..ebdbcfad4b60 100644 --- a/docs/docs/sdk-api/sdk-v-1-environment-document.api.mdx +++ b/docs/docs/sdk-api/sdk-v-1-environment-document.api.mdx @@ -5,7 +5,7 @@ description: "Retrieve the environment document." sidebar_label: "sdk_v1_environment_document" hide_title: true hide_table_of_contents: true -api: eJztWltv2zYU/iuE9pBtiO1meygQdMU8x+mMpnZmO0GHJnAZibbZSKJKSm49w/9955CURFl24qTtm4Gi0eVcv3PhocyVJxImacpF3Au8U08F95PFyYTFCy5FHLE4nQTCz/DCO/YCpnzJE6QG2iFLJWcLRtI5Iw4HyTmaN/GVYgG5W5LR2VtFeExC4dOQsAUNM62URCJgx4TGAekGM0Yupfi6bIIqyVQiYsWUd7ryfnvxAv9U1QORL+IULYN3NElC7muZrU8KCVae8ucsonXOjy2a8NbipOUY3ciNVq2PJFcODtzEl+ILk4qch3SmIp7O0Zcjtd0TtDxdJgyUiLtPzEfQEokQp9y4Apon92yJl5ZQAYrxDBl5GuKDdsLJWyBZH3tTRtNMsolKaWr4LROVki6Bh6csUnUPNeypIAGb8tgESIsgYkoosVLJVEhA3g3dMVFspmMoFkxKDlJNcOAqBvuW5fPHXbVq6tYNWQIII9ZgTImrpT+2VgeEpgQkomwSQp6Fj6vkgYMRh+SYMekgCykOoMY0Yg/h38f361wVhCwMB1Pv9MOmG7+Sj6Nxu3/WHp59JA2SX9/E8OLd1cW4d90e9trjLr5070svCtUsziLQ4OUy4FGF47a0bgysZy9fdpFjvfHcW6+xcj5nXLIA5QEe1l+r02E4t+FZo3p6FzIXuzshQkZjB5WupdnMyglWgMEpXlqcNgKwPq7JdR5ZEJwncRaGFd+sqWSkc/haKyztMGZkWSX4BbSQ5BGFFuFpgppMUxZX+M71zFRB1audSRzQlBKVMJ9PuY9lR4syykstL5vHUziRXEiotH0RrYF1mQvYTIZCch3ZkfW3LhdkRFmY8gWVHGHeEvsn9KVK5btyC6BMPLTcfcv9WSiZVhAtJlNlvCgSqBRXS529E/bdgpwrk6hFboHdPnhOZ2wCHUWYtcqBDgr6rtKtLgsG0i4ZdgVEJLm8ByBXYHjItiNvBOAijctF2Zaveo8HougBu3qqrdmNjDRsLm6OYTY1B8aRrZ2tFr5dKD+M2cMG6KZT9JxthGRLf1I1i/PlsGy32zvptr5W70z7lOWWOsfXrhsVyxW+yVf6SbHSP6+84/rMYFd2yIxquatq8yw59+kASDnlUDgPZF+vpHI9zHE+zFWHueowVx3mqsNcdZirDnPVYa76DnNVL1/X83a4BehiJtk2ktzWZQ1sr9uqZ1BMa09Yie0UsPckYemb5BwmHPykdww5zRWBfxHlcbgkmR2QfBEv2LJo19jJH892S/3cvlfaaQU1SQf4QTiRWciUHrg2F4495q3vOvxoS57pIPKSL+Ag9JJyKczsJ9bSfRbPYM5rkqEQqXU9UxmU7RLjkkKkSAxVAGz65eMI1Ce2XYNW++IC7tr9f+H//qBfmbCuT7rlRHxmP7cO7adWu1IOwSCcuHaMYY/i5/lc+llI5c+OwF+cOAw1/1p/Ow44ovzcaBQC6iHRgdoZl0fhNp/khdwP8u4/V20E/c2wCyPtcDL+u92H24vuaFS7nvT6nYurUe8ah+XOoD9u9/qjDd4KTX8wnjh0eJvrG3bfdN/D38vusNMFijfdyejyojfGGXtwdnUxgIveaDLqjs0F8tqb/lPTopNjPbDQ1PIjf4Gh3XfVLHBfTh6ivrREtRZexClX6Qp0bNt0wm3gnTINN8Vre/KMryRsXTamtSu2SPPDLwiHne5hp3vY6R52uoed7mGne9jp/vBfEB5YP8wkUx9eXHGjfA+4KajYHFYaldm/btLmhyxq48/WnzcK+/Lt8L7DKehdo2rF/Mw0XCh5h560L3v6JMfph1td21AQ2pXgHnVELJ0LPHQzY7oeaDqHm4fOprQ8VCbBcqV1ZTIEjnmaJuq01WLBjDWBuznNK6/pi8jbPLZT1qU+cQM26saTOzHCQzOmJre6UjbqhL/VGHOUOmc00L3HzEbe+4bD3TCEG3aYbwgwPAaJgIarmuQVJXPJpn8c5S6B46rqTssPuT6lg9n9U5LdhdxvgCmNQszR63MO86bIUhIJyV616OsmZtg7Clte+WRH2hlESfL/8jZQd6IdRNDyUO43uSKhFFO2ny93VHEfLXPcQEWYHzp+OCghjS4tcc/iDeJv8XmM8hogHgdsoMSCMl1S74RJXokwesMY/pXcGI4bT9cpj6dCG5L3jyIdMRNhJwXJbfQsTnbn7pEiHQBE7ywwiYAXQO/MmX+v0doDfsC2UJ0XmPbCoGxOl1HzdYxFlGOpqSxJhEz/rFYYeAVZyLAjAK3F8K/RGbmwT48rv1Piq8bvjU5IM2VWtESoNKKxww0tgixOtp6q2wRlVR6D+7FH8mzqpOxr2kpCyvUkoVvQyjYv3Xkxhid6jao3MHiMnW8O/iL1aoVZdCXD9Roff86Y1M0S99OwKt1hgnzAAdImKPY8fXjOa/s+S9Ji431aP/+3djvsG/3dgdZqwCwS9sKZ/2CCc2Rv62XGjHt9TG8H22plqgycy+kXdgjYwVHUoaFGhG9hhfkftAl21g== +api: eJztWt1zIjcS/1dUugcnqQHi3EOqSG7rJhhvqPUCAbyVq/UWlmcaUDwjTSQNa0LN/37V0nzBgM06mzf8YpjpbnX/+lNCWyoTUMxwKQYh7VIdPs7Xl3MQa66kiEGYeSiDFD9Qj4agA8UTpKZdOgGjOKyBmBWQGgcpONp34lZDSB42ZHr1ThMuSCQDFhFYsyi1i5JYhuARJkLSD5dAxko+bdrUowp0IoUGTbtb+sP33+O/3eWpRwMpDGrW3VKWJBEPrMzOHxoJtlQHK4hZk/O+wxLeWV92akq3CqV1554Ui7fvxJ0Yy8+gNLmO2FLH3KzQlgt92BLU3GwSoF0qH/6AAEFLFEJsuDOFJXz+CBv8mBNqo7hYIiM3ET7wE07ewYZmHl0AM6mCuTbMOP6ciSnFNtSj3ECsmxZa2I0kISy4cA6yIohcEEZyqWQhFWGi7jqPaFhaH8o1KMVD0M45PARhuNlUz182NV+mqd0EEgUasSashmtO7+Vah4QZkiiJskkEa4heXpKHNYy4MLAEVUN2ECKogsXwHP5DfJ8VS20pi6LRgnY/7pvxHbmfzvzhlT+5uictUny+E9+R+/e3N7PBB38y8Gd9fFn/XllRLg0ijWn3Iy1kUI/ucHyqtJttErj68cc+cmR7z2mWYeb8mXIFIcrjIc3tzdesMVzn7slwefYQQR27BykjYKKGSj+n2Y/KOWaAw0lscpz2HJB5Dbm1RzkItScijaId23JVydTG8Ae7YKWHUyNNd5xfQruQKmaGdqklaMh0aXGL7+qWuSzYtepoEIfMMKITCPiCB5h2rEyjItWKtHk5hBPFpeJmcyqiDbDGhYD9YCglN5Gd5vY25WYejdPI8DVTHGE+4PsvqEs7mV+XWwLl/GHlnprur0LJlYJ4PV9oZ0UZQJW4RuicHLDv1+Rau0AtYysBFYAwbAlzFmH3cJjUhMQPO9VqXDIQv2I45hCZFPKegVxzsYzgMPJOADZpbBdVWb4dvOyIsgYcq6l5zu5FpGOr41ZTLA/NkTPkYGVruO8Yys9j9rwCtuiUNecQITlQn3RD46IdVuX2cCU9VNealemUtDyQ5/i6bsaO5hrfFJ1+Xnb616W3aM4MeWfnYrmb7nq3eFacp1QApFxwUM9F36CiqltY4Hyeq85z1XmuOs9V57nqPFed56rzXPUV5qpB0deLcngA6HImOTSSfGrKGuW17uA6o3Ja+4JOnE8BJ08SOX2bXEtlj/Q8YlZcE65JzLiINiTNB6RAijVsynKNlfzlaM+pX1v3Kj1zQW3SY0px0ESlEWg7cO03jhPmra86/FhNXmkg8pLP3Ky4qLXCND9ircwHseQC2mQipclNT3XKomiDfjGMCyJAGwjdy5cRaE5sxwYt/+aGetQf/o96dDga7kxYHy771UR8lR+3TvKj1rxTTtIIcOI6Moa9iB8NuArSiKlvagK/rflhYvkze3YcckT5td4oBTRdYh111C8vwu2O5KU6DfL+b7c+gv520vdn/cl89qs/pB696U+njc/zwbB3czsdfMBhuTcazvzBcLrHu0MzHM3mNTr8Wqw36b/t/049Ou5Pev3hzH/bn0/HN4MZztijq9ubEfXoYDqf9mfuA/LmX4ZfGha9AutRDk0jPooX6NpTu2aJ+2b+HPU4J2qU8NJPxZJ1gTXd9o2oF/BeFYb74q0+RcTvBGxTNoZ1XWwZ5udfEM473fNO97zTPe90zzvd8073vNP9x39BeKZ/uEmmObzUxU2LPeC+oHJzuFOo3P51n7a4ZNEYfw7+vFHqV2yHTx1OaYZ/HtUQpK7gftzSGj3xxwN7k6P78ZPNbbbU1pTwEdeIwawkXrpZgs0HZla0S5+7m9KhuJhag9J2rVRFtEtXxiS62+lAuIQ2S3h7UWReO5Bx49pOlZf2xo0/HtjCUxgxxUszLid7ciWVIdONCJwZZXbikqiLpcWmDEzZyrO3lFQkcEI0CgERJpJjIQlYFLntEY6PTwaUYFFJK1MVgEd0GqwI08SPk4ibFHtf5u1rRb75hWkefPucdkjwdZUjZsUMCZggEo89NIiQWD1IoMCGGIt0ZcF7/pQwAVGbzFZAHmGDRyZYJBOm9Wepwp/st1TjUjHgW74UUkFoTT4YU1XHTPg7G+wczVoBC60r3JBKf2/VuFuOsAnE9OpdBUCb/MzISsHiPxdFbIUy0Ltx1Qkibq9LYZn5V5I+RDxosYS3SjEXb665CIlMDYmlgp877I215j3TBtQXG+KnZiUV/6uox00j/DDmwsr9W6YovmYGTrPFhhZq9mL4YY2TjyD2iP+OzTOU13pguFVjqVlh2Ll2ZY8kSFESSaJgwZ/IneO4o7ZgcrGQVpGikJd1AUuCR7HKuHXWl8eLyIUmPanAbvEwiPzxQLdJbwXBo0XrBPgv3lRLF5XOWuFQdtf8mDumhJhxrHk6TRKpzH93S13m0YgHgKW5uy0w/GV6RW7yp97OD8b4qvXvVi9iqXajRSK1iZmocevwkawvD15v3AdlW91H/GfvRuahY+DJdJKIcTvS2V6wzbuIbYHow0s7LDQ7CfUotqCV1Aapt1uMolsVZRk+/jMFZbsWHmwojrOG7WFeEaDYfOwtRuoHASSmPAHpNi9iZvVW99YeALFGDrhunX+oDeJMbGqyD9Uyp8ajvS95hG27dVmWZSX9Op/GjnCUeeioEeFPWZb9H22uAQk= sidebar_class_name: "get api-method" info_path: sdk-api/flagsmith-api custom_edit_url: null diff --git a/docs/docs/sdk-api/sdk-v-1-flags.api.mdx b/docs/docs/sdk-api/sdk-v-1-flags.api.mdx index fffc48c8cbb7..a4eabe23b64c 100644 --- a/docs/docs/sdk-api/sdk-v-1-flags.api.mdx +++ b/docs/docs/sdk-api/sdk-v-1-flags.api.mdx @@ -1,11 +1,11 @@ --- id: sdk-v-1-flags title: "sdk_v1_flags" -description: "Retrieve the flags for an environment." +description: "Retrieve the feature flags for an environment." sidebar_label: "sdk_v1_flags" hide_title: true hide_table_of_contents: true -api: eJztVt9v2zYQ/lcI7iFdYVvx1icjzeYl6RA0TYvELQrEQUJLJ4uNTKokpcYz/L/vjpRsOXKHDMXelgfHJu/3ffcdV1wXYISTWp0nfMRt8nBXDe/SXMwt7/EEbGxkQdd4eQXOSKiAuQyYF2GpNkwoBqqSRqsFKDeYqqnq9/tT9fJSO3g5Yt8yUKwwupKJVHOvfJ+CcKWBe/a1BLNkwsxLUu7hrbRoLim0VI59k3k+VQZQFp1IVEV3zKKZHJiefYHYMYqAvTp8xV7INEQWbLNEg2VKOwaP0rqfGaaJ+lPlMoxYsBwPu8GWNsS4G4XLKEuZYIgylRgEXidQGIiFgwStfMhBWEBtzC0ShYyqYRTEnQQb/bZVfX20/X58z6SyDkQywGIXwogFODCWj25WXOEPLHqdDd5L6oGvV6czlyjL9G76TrM5OH9kHYaJ96hn4wwWgo9W3C0Lsm+xp2qONwupLkDNXcZHw/X6tscN2EIrC5akfzk8pH+7blEr1sphOnQniiKXscdS9MWSwKrrThgjKH7pYGFb56GZeyCHRbbowG77TshjL5o0fW7YXI8RSNhs6VN+Q/BcUOOuT9/66hpCOnWDvDZV7aS043BrpJbvYddTSW6EI0h7AOY4Ejm5eJrKrkuZtNJFWMEcDF/36j4/7ce6MddtFKhygQjh15Px5en46hSP3n28mJx/Gl+djydn/Ha9puZ9LaWBhATRc+2mNnq7JitilkM7ppnWiGJFrut073xx7yqRlz4SVeY5afGRMyX0uFbwPvVg7aS1x2onxU6gTUy9Fur3hYKK9Idohrg00i19DGdbEmLjD+fsLdD5LUHZEZ2hA6Q3jj9xyjJNdIcD4gePQM+bufXMFtGsgKmaaSxNjiKZc4UdRREkcxig+CBtEDKI9aKD3i1+zlCBguIUTRP1NQ1HAMfe2LdDU0g6qCkgQ77AGjfI4Z/7Le1+EHwSB3IkjsGG0eyAHQmWGUhfHzQpJTq2u+lEcS5pECIcCPdTUc5wuvsYSn9j5uD4jVQJ06VjC23gKBLHA4LPO4GkZv51IuMS22LkX55C9iYxTpClvN0fSsXICsH0vFxmwsqYImulQY4aLvUYJxk/svoB1BPhH8l5Qvb6aJ4YByVpcQSGDUupGR7kIuSlRzYNGlPOaTqkSrUPRDqa2RYcCYk9TuAOfqrh97F7YNkJFgQXYOJBhLpY9JMM4gdfrWeUH2u7cY23ftX7LEKVwxYRsd8iuC4kjZoti0Ib9/vuhGFWiELAreT5KNTwj+tTdlGfYtab9Rqu+r/2T3KBm9nXpNDWLYRqaSMnsGrI9j55Vtv99v/r5799/dTT4uDRRUUupN9DnnVXNUHf0CgRbAmsTbuIzjPsKV2vVjQpH02+XtNxeCoReSfS1ssuFbmFf2jy8x9Se+N9ILZrLa96c3JP+5UwMmzPG1rANRNQfEFtHMdQuJZW50G1bu+uP88mKCs6ZPPgyab+0trNQi1btvctjRAGfbaW9a7aahXoDCvcyIer72psCC9IU51off8Ns7BNQg== +api: eJztVm1vGzcM/iuE9iFtcbabrZ+8NpubpEPQlxVNOgyIg4Q50T41Oukq8dx4xv33gbpzbMfuy9Bhn+YPsSNRJB/y0SMulK8oIBvvTrQaqqhvLmf7lxOL06gypSnmwVSyrYbqHXEwNCPggmBCyHUgSKYw8QHQAbmZCd6V5Lg/dmPX6/XG7tEbz/RoCJ8KclAFPzPauGlyctV5uYKPNYU5YJjWcjgDLkwEcrryxjF8MtaOXSCugwMyXFAAhGjc1BL46w+UM0gG8OTxE3hgJhsZak8RnGegWxP5IQSU82PHBTpAsCbuSLaObY6bWXAhKI0mx2ZiKICJoKkKlCOT7o/dW0sYCepIcDXAygxm+4PWnA3FwS+ro8+ern4fXIFxkQl1X2WqwoAlMYWohucL5bAkNVQdGpUpI71I9drq0BssCfwmfPYwJU5LkZFlX2Uq5gWVqIYLxfNK/EcOxk1VpkrjXpGbcqGG+01zkalAsfIuUhTrHx8/lq/NsCpTuXdMjmUPq8qaPHFq8CGKwWI7HIaAkr9hKuPaetvMHdSrAkVyHFd9F+bBgyXMhO0htBwhDdfzBPmF0LOUxp0evUzVDcJ46YZEXVZ1C9JGwJWTzj4DTRMjYZCF0omAlmZkJcR9KJshjV6DaxzTlIJqsq7P9/vRLN1tN4pcXarhuTo9G705Gr07Upl6/f7V2ckfo3cno7NjddE00ryPtQmkxdBo1YXpnF404gWvLa3ndO29JXQSuoN7mYp7OUNbp0xcba2cUkMONWXKO/p9ksi6BWuH1y2IksYMg8GWP/dxbkZLmLCj1VdM7+FfQs3WLtMuhBdN+mQqUl4Hw/ME7XilbTB6ewIvSdYv5IawqOXwXNRTXWSqJC68qOmUUvtR7pJaykESzIFcQQqz5SWvg1VDVTBXcTgYkJ5SHyvTnyyJ1899uXUpVrQ81lOSpJRks8z6VO5cy7lDX/jAcDp3eZv3Xekk5FIOUpsIA4XtUD5A3jqJ4mSpiRFytLa9bqL/t0zBob2z9XXIKYNY5wVghFFZWcO1pr6w615W8OA5RpM//FJ2YvDvJgdcIEOODryzc4jkNKQ8IA+UFBptXCF4bW4rdGT7cFYQ3NBcngARmgpj/OSD/jn9V0cJVZLsmqnzgXSCvJNEK1GsjCx0El8Q6tSK7gX4s7d2utcabhfi9OjlqgB9eIpQBJo821tyS/s8bvJqkFsjQjcIFPmHqr62Ju9hZXp3bvYOXhinwdcMpQ/0dIAHCc1rjEzhHwMZ1Vz4YP5KT8ROECNdGpf8fheUYGbI9G1YErUks6/STyTZ35C7Z/w9mM/EX+8ao7woNRdCu/YFbYeOpYpBFWhibmHcnhgrJTJl3MSnRAyL9K3pgkhCpkRl2jiz/c+LyF6EQx8I0OlEotHbk9iHw4Lym1Stbyj/3sEqtPZ5GuUSirbK7ZSAeVJ5KtGI5sW6qnzgXzelrsmUNTm52L43bQ2fnx7Bq241U6vxqd3q/dQ7tFhHSjWpfOQS3drpqG9gtg87R9vFan75f8r9b6bc7tYw3fKgsmjSvJGewUX3Yp7LlRL6CmmXbZP3tfCRZXuxkBvzPtimkeV2JJbXVJvYDTUTtJG+0OxvH5h35nsjqrc2TXQTkkrvcBpp0jByLhNOpwiSX3tslOdU8dqprcG5WR8mfjs+U5nCLdG5SaLT/VibwdDN13zvejzaNOTv2lC2eWyxaGWtae7s263PnrgTvtZa6iTz1N+o7fvn sidebar_class_name: "get api-method" info_path: sdk-api/flagsmith-api custom_edit_url: null @@ -36,7 +36,7 @@ import Heading from "@theme/Heading"; -Retrieve the flags for an environment. +Retrieve the feature flags for an environment. --- *Note*: when providing the `feature` query argument, this endpoint will @@ -71,7 +71,7 @@ Please use `/api/v1/identities/?identifier=` instead. diff --git a/docs/docs/sdk-api/sdk-v-1-get-identities.api.mdx b/docs/docs/sdk-api/sdk-v-1-get-identities.api.mdx index 87994be262cb..98b52d8786f5 100644 --- a/docs/docs/sdk-api/sdk-v-1-get-identities.api.mdx +++ b/docs/docs/sdk-api/sdk-v-1-get-identities.api.mdx @@ -5,7 +5,7 @@ description: "Retrieve the flags and traits for an identity." sidebar_label: "sdk_v1_get_identities" hide_title: true hide_table_of_contents: true -api: eJytV1tv2zYU/iuE9pB2sK16eyhgdMW8xBmMpN3guMEAJ3BoibbZyJRKUl49Q/995xxKFuVLmqx7iiWd2/eda7ZBmgnNrUzVMA56gYkfp+vudCHsVMZCWWmlMEEriIWJtMxQDqRGwmop1oLZpWDzhC8M4ypmVnNpDZunGh5Zqb/pgHrGNV8JK7QJepNtoOABzDiJuRQaRCQa/pILvYEHLb7kUguIyOpctAITLcWKB71tYDcZqhoIQC1AciXVtVALuwx63aJo7WxDLMpIsL9v+sDULE0TwRWBnPM8sUFvzhMjiuIeAzFZqgxwAAo/vXmDf5pcgF6UKoue4BvPskRGxGf42aDA1vPY1HwIeSbDdTesmQ4fWOWxc6fu1Ehk8AxfDVFdUcoiLbgVMQOm8yzGny3Gk1Qt2N/SLhllAdOC3Jcw09lnESEbmcaUU14hJC8HR9gFZwm+GNZSRSsg054415ojtdKKlTnE6YHgzIDhxBUNezUHFLkWzFiA8Bqgw5MCWLMNwb1EPysEdHNx9W0opbVvBFAbLeVbDPIu0S23DCyibZZAdSfPYc+jQUIVLKiWa9qQLleRp8n9iN+LyhXUUJL8Mac+acL4kT3cjPsfL/qjiwfWZtXvOwUfPny6Hg9v+6NhfzzAj/5zjWLnWqh8BR6Cyga8amjc19GNQfXi7dsBahR77wPoOK9XJ8hHibf06Slclukp0D2fJSI+2oSV+KCUwXpzmlMqk+maJ7njSW1KnvYSgGNgz673qiTBe6PyJGlgK0NlN+iQ3ZLDfahVtdVojgfqmb3tYvFRqitH1En4gkbnf+ypR7FpkzOWcQmz15g0kjQfaBrszeKnK5oCmYLFpyp2jELsCoSq0F+WFail2f+RJxfH8fzUQJoh7qv76Ri7LBxWtben3PDbZayR3uFukI/KKQ62CjRnRJRrSAARM1BrqVO1AmHW/3NIRPYm94SMJusE9zCahp25THEvw0KmNYp7LjiyN3CxCb2uFmyuE5BbWpuZXhiKeCE6oNOZV7OvE6Wrg61eT8YBKGBkRHYV+g2uMVckRwHUpZvJK6Kd9u5S8JiIKxfzX21Pu+0E9+KArQYDnwkVZylUj+mwd5wttZj/clZBitPINOGEUYLr3oTQF/aHLJ/BHm5DKO2dmbP3lxKulDS3bJVq8S7k7zuY/Q/cwGXyYiD9HHKj5T+07I+C6MdwnZDd74Ki5Rqa+XlYZtzICCPzYKCj6vChXkMZKvv0Uag94e/BPEZ7bTCPuxQksTrdLeQGUdVTsGVh435ld07jLqCOk2qeUiD+bKRyxEpsBVjczs+6e7p2zww7B0LoHsUiAl0g/Xwpokdi6xn0A7c71/A1x0IlFI5ld+/xiO49OOwktprJsyzV9tdmhwEqqEKBc6C3u0x/u7lg1+XbVuP+wk/tn9vnCc+NG2hZauyKK08bBgNbdxnMA3b6QN/WJ+nLb/WyEKz4asMs4RKHshso23IATbBKMCPdHYAyCpxZS4gZZbZbrIRPOikKfO3ub7pqpCnXP93ZT8T+alRWzGt2KjDaVM0JXa6igFbHgTOn4P97UMvf44OWqEADuVU1AIbtFPtRJDJf6+DiL/y5/ftgDLL8oMfcXip/eMsStqdn+9isdGE80u49obbdui4G4it59+mkxq7PSzoRBeytfwGMcM+d +api: eJytV1tv2zYU/isH3EPaQbab7aGA1hVzk3QI0nZF4hYDkiChpWOLDUWyJOXGM/Tfh0NKlmwnaXrxiyXqXL9z5Yppg5Z7odVxzlLm8purxf7VHP2VyFF54QU6lrAcXWaFITqWslP0VuACwRcIM8nnDrjKwVsuvIOZtsAVNPzLIUuY4ZaX6NE6lp6vmOIlspRFiplAyxImSPDnCu2SJczi50pYzFnqbYUJc1mBJWfpivmlIVbnrVBzlrBSqDeo5r5g6X5dJ2vZ3nLlBCq/LXpH1FRriVwFJ2e8kp6lMy4d1vUlGeKMVg4dMfz27Bn9bWLBEpZp5UlTumLcGCmygOfokyOCVU/jJuf1iBsxWuyPOqRH19BqHF6oC3WKxqJD5V2AuoUUMovcYw7aQmVyekyAS63m8EX4AkIUKCyEfeOmnn7CjNAwlkIe4pqu+jG4A10vvKSD446qTlgQ3SPn1nKCVngs3a6fPSc4OKHmMiYNPJkh95VFcJ57fAoWfWUV5jBdBndfk56SHDo7PPm6K420rxjQCW3oE8hxJkgt92CsJtkgcYHyMej1YBDK4zzkcgcbwRUz8n5w39H3ulW1YlzKf2ahTjbd+BWuzybjd4fj08NrGED7fKF+heu3H95Mjj+OT4/HkyP62H/vvFirRlWVLD1nrQyWsA2Oy866ydLg4fPnR8RRb52zuu7X6jnh0fjb6OwxvG7CU5N6PpWY31mELflRQ0P5FjmvQppcLbisIk5q2eC0FQBqA1tye0cNCL0TVUm54VtjKpyRQvgYFNYJW3AreFPn27ofIfVjwx4w401z+B5Bp5F7G/w2/zt874aub9I+lUNIvtb1UNt0EJr5d1b5DS4HQRkYLixw53QmQscK/WlrOjxcY8GQqxtcPlRDEyKCE1yuTf+2PFFVOf0ZmRPtaDJmKz6dI5smbrP3wzGJUdits97kjO14HbGN8B6vR8tpM1dYTb+EOcwqK/wyAHOkFsJqVaLyMH5/HIBMzy+DZ6HXn9NmQKJL9IWmTWGOIVScJi+7Y5LRqEW7aEd+ZSVLWeG9celohPkch9yI4aztxsNMlzt7Rterj/I5kmUB7Nb0MxqsMUkOdKGth7OlyqLx6xCRynbsh7gitwG2LVXaQhaFOBKCKjdaUDZnXMo4k7gCvPVoFZdrWl3ZDBNwVVYAdzAujRS+ynFIUdyyCp684k5kTx+yjgh+rnHgC+4h4wq0kktwqHIIdtAWEeLFpes8eCtuDVcohzApkAoZRFw+DHfui7b5H+GtcqSqRPoq5kpbzIPLd2ZS10OMOAn5H1ayAnkeQtHsbP8OetyDSLgLxNnhSQfAEF5wKCzO/txrcyvXmdvMq1EmaRN0I4vO/2KqqRTZgBsxWIvZe/laqBx05aHUFl+M+MvgzVvuPNpvdmRc+UJb8V/YA+90YpyXQgW5P+SKFQvu8XG+hNQiy76aftR/9A2qLeIf8XlC8gZT7mjNqnxBaRfX5DgR2uYGxuJM3MJF5LhgofUJNdPBkP6QCn2BWkLCqMtEPYv9+5vInoMDbTFcVSiJxu+P3RAOCsxuAlqPgH/vZac611lFiRq8iCjHqwDPwoqAJRfU81xljLb+r81WVydMigypIafrS8urs0N405wmG6s5fRr8PjiQvHJxshjtfMlVj9vlN7DYhzl6uP/utupuK99+jWsSweOtHxnJBU3H2NlXzSQ4pyyhiOyvHWisoOFRaOeJZrWiTPhgZV3TcbyahYVXuGYzDFewB2x/ctpkzFO4z7CwMmyOymYnYGGG7yiLDP2bY0d/2ax/U0rA88s6aQuAzI6M4yxD0+fauQzW/QH699GEJYzv1FhcEJqH3tbC1bIn+65eGc24CUvQPWyrVaziul7TL5r19h6OdZ03cJIXdV3/D7Egi0A= sidebar_class_name: "get api-method" info_path: sdk-api/flagsmith-api custom_edit_url: null @@ -62,7 +62,7 @@ Retrieve the flags and traits for an identity. diff --git a/docs/docs/sdk-api/sdk-v-1-post-identities.api.mdx b/docs/docs/sdk-api/sdk-v-1-post-identities.api.mdx index 523b2e692d55..688b9d6830f5 100644 --- a/docs/docs/sdk-api/sdk-v-1-post-identities.api.mdx +++ b/docs/docs/sdk-api/sdk-v-1-post-identities.api.mdx @@ -5,7 +5,7 @@ description: "Identify a user, set their traits, and retrieve their flags." sidebar_label: "sdk_v1_post_identities" hide_title: true hide_table_of_contents: true -api: eJztWFlv4zYQ/iuE+pC2sOykfVgg2C7qzQEYeyLHokCySGhpHHMjUSpJOXEN//fODCWLcpxN9ij2oXmTyLk53zeUFlFRgpFOFXqURruRTa8vZjsXZWHdhUpBO+UU2KgXpWATo0oSRLERb03mQorKgukJC064KSgjnJHK2Z6QOhUGnFEwg3prkskr20djBv6uwLqXRTqPdhf8qgygf2cq6EVJoR3apy1ZlplKOL7BJ0u+F5FNppBLeuoGdTmQpRrMdgZt4INLUfvqn+tzfWohFa5o4+KIxKQwGK6o1eYcunWFAYGZ1AlR2G5eAvopxp8gcfheGioeFwiD8eoTBYbealmLjvQV6SqXQVs5klriKtvmRPX83STaPUM7DnJ7N7sjKA1YVLZY9GuYxzOZVSBK2dRcYDgzDCIV0gqly8qJmylokRjA+ukrgVlWZeqfg3QfzozNX6DPzyV2wjG8QqEmrwuOsJtcra3wgK+4BKslXeXj7sq4KDKQOlyqvXbUsixaflyP4wO79pFoq5puWo9jg4tNBmsLy2Uv6NWzoC7djNejGdFhcDDehTRGzh9Owv7X8QcdG8h/2Bmt8HPkwcOaIRRv45ubmxhxk8eVyUAnRUomn7D5hM0nbP4AbOZV5lQpjRswJrGR5BMan9D4hMYfgEava8tCW98Uv21v323S6Ltfc71HRm+AALx5t3DlBse2b/obUrynZwV2+Y1yU8bw6o7+/SHMpgNxf7i9R8HYouHMs5D4eYJZVMg51mEKvxBHVUZjWuM5p3tIfnJK6Hj/1cOp1NYeCKA1Wsv3RAoTRW4lEwrZFhlSZfaY6gVlaBAelo3KpWUOnyvuW9pfQQV7KMvqlu+m8au4PD4Zvt0fHu1filg0z+caN96cvj4ZfRgejYYnB7QZvrdZrFwDUg/BobGBSx2NEEuouv/s2QFpLNfWN8ArqvOtfQYKh/XxLMm9HGcQ1q5BdSt+UMtQv3nNC26TL6PYryPUOlRxTA4bYl1Ltem2NpvNgXZohpqPj7pxxEjqTMWvwNTaaJTWFolifmA2+J8Mvq+cVOFxNDPo/qHRkN/qxO6dIp7FeYygOQtJZfAAuDAHeqZMoXMUFsP3Iy7k7tlHzoyZ9Yx+35DpHNy0oN859B+Hzkq6Kb5tGBwR+TAzMJZd4Mccyk2dK+3uYADpFfRRpz9pyK+fFPmdn0EtNR6gAoXG1W5iP6Y55rtkYwZt75bqFdddkdUpyJQr53kw+isOtGMvuBYHjjVkfAE6LQtsH9sXz6WYGpj8sdWklBaJ7aYzSDIa+XaAwHA/ldUYB3GMocQrM1svDhXecwu8JuZ41X0+kC/6dPxvpHVgvjiRYYWHY9Q/PO03JjFMc6XZ7jelYtQM0fy4XMbSqoQiC9IgR9QffH4ENpLhvi+uQa8Jf0vOJ2QvRvM0TFGSutNfhjwTNaDCMYsj91ace43ziCFH96Wj9ofiwa3MywzWLykBG9WcedZhrbX9hpi2O/dK+j3JcFtboqwnBVcjZGjGBMGhFxHCfLKznfsBtGXFHn1M0WcVdTLq4snvTSG55iN7RA/gAa9c425FaOFS+qP2t06Z8K0Tr5eK8G6rsiyM+7MLc8wKoQDERihbH+TL433xul7tdQuMW/Hv8V4mK+tplcgnlzrQRnoSsx1BG6IlofV6LNqb8bf+aK6b08GtG5SZVDQpPMktalI8o86lA9pZ5VPHREQ6Jf5EmcWCuvPUZMslLWOzGeZe1JNG0RxnJu41jU/N5dtqz6cS872HxLmtHvEzjQaYNzFMEijdPcr8tbAMOf/9u+MTFB7XP9dztIargeVe+OLDlnfA7Cdg/RCMZZzTQSSbSNkHfQ2d77au2mLh6QKr2cjP6s/QezRWhOKl6SA/4oT8F3jekSs= +api: eJztWVtv2zYU/isE95B2kO1meyjgdcWcSwEjvSFOgwFOkNDSscWGIlmScqIZ+u/DISVLcpwmTTv0YXmzpHP7zp30iioNhjmu5DihQ2qTq4vl7oVW1l3wBKTjjoOlEU3AxoZrJKRDOvaf5gVhJLdgImLBEZcCN8QZxp2NCJMJMeAMhyVUn+aCLWyfRtTAlxys21NJQYcr/8gNJHToTA4RjZV0IB1+YloLHnv7Bp8t6l5RG6eQMfzVNepywDQfLHcHjeGDS1Lp6p/JM/nJQkKcauzyFpG5MoRJUrEV3nTrlAHCna0Aodmu0ECHVM0+Q+xoRLVB53kHDVc0sM85GHyqaK0zXC6QlzsBjeeQqoxokO2ByuLDnA6nK8odZPY2umPQBixIZwkjV1D0lkzkQDSrfU60UUueQEKYJVzq3JHrFCSJDTDH5YIoQ3KdhN8tuPcj8+IvrqD4GrATb8MRFGtcF97CLriKm0sHC++C9SuZZ7Pum5lSAphsv6q0dtiEoOX5ph2nXnWwRFpeZ9OmHVtUbBNYSSjLqJWr05Zfuog3rRljMLwxQQUzhhX3g7D/tf2tjG3Rn+6O1/VzHIrHc7ZL8aZ3fX3dmyuT9XIjQMYqQZFPtflUm0+1+RNqM8uF45oZN/A1mTDHnqrxqRqfqvEnVGPgtVpJG5Litxcvbicp/eFrbtDoq7dVAS6Fplx9gkOyzm9IIsKEkgtyzV3qa3i9o//4EvaiW+QhuNGDythyuRChC5Fnc2AuN0CsYw6eY4/KjYSEzAoP9w3qyRDQ5ODofiiVtHsMaIRW9BFJYM5RLfMNBWUTAUsQD/Feyw11hbfdhu6SLIOvOfc9fl+XyooyIaqU78L4lVxOTkbvD0bHB5ekR+rfZ/JXcvnu09uT8enoeDw6OcSP7ecGxVo1yDzDcqhl0Ih2ONq1VGg4ePnyEDnKjfdbyotWeCudLYY3VXhKVM9mAtq+q6u6IT+saDDfAueFT5Nva7GPa6iVqWSCCpvGumSGszva0gOknlbs3mesag6PEXQcuDedX+d/49/trus0PiwHn3w1dF/bnTn9iCrfGNbMWhVz37F8f/qfjOJHzs52OOqpePcYq9vxOmJ3zrUwV/xgKyNqIc4Nd4V3zKFccqNkBtKR0cexd+Rweu6R+V4/xQslFJ2BSxVeMOHNEsaKuZQO6ZZRRlGHWYKxXkVuBB3S1Dlth4MBJAvoM83787od92OV3bqeapr1YbIANM17u7Z9gpM1ZMm+SpVxZFLIOFi/jhGqRFs8LQYWmPF+21ClDImDEItCQCZacUznmAkRhhKTBG4cGMnEmlblJoaI2DxOcQsdZVpwlyfQxzBuWEWe7THL4+dfsw4JfqxxxKXMkZhJoqQoiAWZEG8HrhE+XkzYBsE7fqOZBNEnJylgJRMetg/NrL1WJvnDP+F1IXZ6/MoXUhlIPOStqdQ0Ec2PfAFwhJUCS3wowoikf/da3L1AeNsRk4OjxgF98oqR1MD8z506txIV225eDWKB26AdGLDuF53PBI97TPPeWszO6zdcJkTljmTKwKsBe+3RvGPWgflmIKPcpcrwf/wiuBXEKMm49HK/C4rhS+bgYVh8aqFl96YfNiB1BXKD+Hswn6C83ozhcZTlLsW0C3tyGAl1dyPawJzfkLPAcUZ978NV+ri5az68YZkWsLm/tsZCNbymnfGx8b2eEC86Rw68ufZ9b+MVop4r7432qPTNCftSRLHVBbDL3bs72Y4l+3jOxhM3ZvLo49j2yX4K8ZUP2QNyYOd1ozpRcY7V4l0ZQh0OJCz2iwpkjGPjtbnWyri/uv22jKjgMeBYGK7qQO5NDsjb6m3UdfDe5KD3e29fsNyG+YZTIGOyxW2TK7LcJfiB3P3Hw6o5NH3vfxBVcjq4cQMtGMeRHabNqppOU8xcDNDuGk9lE060FAfZcEpXK8zOT0aUJb7+koPxQ7Da+2YY8+l5GdWJj8kV0mo/QOn5lRjJfVo94J4VN4kgYhTHoN0dzP4gWbaH78cPkxMa0Vn1v0umEuRpSY7aD8FsdquYwypS/WjtR0wWLUu2NeVg9BV0jvRdttUqtIuyXNMvq0X6Do51QwnUGMjzsiz/BUeXTM4= sidebar_class_name: "post api-method" info_path: sdk-api/flagsmith-api custom_edit_url: null @@ -62,7 +62,7 @@ Identify a user, set their traits, and retrieve their flags. diff --git a/docs/docs/support/faq/feature-flags-remote-config.mdx b/docs/docs/support/faq/feature-flags-remote-config.mdx index da9efc4bf2b8..9c7cb5e78611 100644 --- a/docs/docs/support/faq/feature-flags-remote-config.mdx +++ b/docs/docs/support/faq/feature-flags-remote-config.mdx @@ -85,7 +85,7 @@ No direct "Export" button exists. You would need to write a script to fetch the **Create Environments API:** Yes. -**Create Flag via SDK:** No. Flags are administrative resources created via the Dashboard or the Admin API, not the Client SDKs. +**Create Flag via SDK:** No. Flags are administrative resources created via the Dashboard or the Management API, not the Client SDKs. **Related documentation:** [Flagsmith API Overview](/integrating-with-flagsmith/flagsmith-api-overview) diff --git a/docs/docs/third-party-integrations/ci-cd/terraform.md b/docs/docs/third-party-integrations/ci-cd/terraform.md index 631c03cf9882..d62394ab39d6 100644 --- a/docs/docs/third-party-integrations/ci-cd/terraform.md +++ b/docs/docs/third-party-integrations/ci-cd/terraform.md @@ -15,7 +15,7 @@ your Infrastructure as Code tooling. You can find the latest Hashicorp docs for using the Flagsmith provider [here](https://registry.terraform.io/providers/Flagsmith/flagsmith/latest/docs). -Some API actions require object UUIDs/IDs to be referenced. You can enable the [JSON View](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) +Some API actions require object UUIDs/IDs to be referenced. You can enable the [JSON View](/integrating-with-flagsmith/flagsmith-api-overview/management-api) from your account settings page which will help you access these variables. ::: diff --git a/docs/sdk/sdk-api-info.mdx b/docs/sdk/sdk-api-info.mdx index 6b424a2aa56e..35654f14308c 100644 --- a/docs/sdk/sdk-api-info.mdx +++ b/docs/sdk/sdk-api-info.mdx @@ -1,5 +1,5 @@ -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; +import ApiLogo from '@theme/ApiLogo'; +import Heading from '@theme/Heading'; # Flagsmith SDK API @@ -9,11 +9,14 @@ The SDK API is designed to be used by Flagsmith SDKs to evaluate feature flags a The SDK API is designed to be publicly accessible. Calls need to have an environment key supplied with each request. This is provided as an HTTP header, with the name `X-Environment-Key` and the value of the Environment Key that you can -find within the Flagsmith administrative area. See [Flags API Authentication](/integrating-with-flagsmith/flagsmith-api-overview/flags-api/authentication) for more details. +find within the Flagsmith administrative area. See +[Flags API Authentication](/integrating-with-flagsmith/flagsmith-api-overview/flags-api/authentication) for more +details. ## Core API -Please note that the SDK API is specifically to be used with our [SDKs](/integrating-with-flagsmith/integration-overview). If you want to drive aspects of -Flagsmith programmatically, you need to use our private [Core API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api). +Please note that the SDK API is specifically to be used with our +[SDKs](/integrating-with-flagsmith/integration-overview). If you want to drive aspects of Flagsmith programmatically, +you need to use our private [Core API](/integrating-with-flagsmith/flagsmith-api-overview/management-api). You can find the full spec to our Core API [here](https://api.flagsmith.com/api/v1/docs/). diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index b871d917423b..8d8e3c3bd593 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -118,7 +118,7 @@ export default function Home() { diff --git a/docs/static/img/rbac-permissions-diagram.svg b/docs/static/img/rbac-permissions-diagram.svg index 2ceec27c0ae9..1237db9ee1e7 100644 --- a/docs/static/img/rbac-permissions-diagram.svg +++ b/docs/static/img/rbac-permissions-diagram.svg @@ -1 +1 @@ -PermissionsBuilt-in rolesCustom rolesUsersGroupsAdmin API KeysAssigned toAssigned toAssigned toContains many \ No newline at end of file +PermissionsBuilt-in rolesCustom rolesUsersGroupsManagement API KeysAssigned toAssigned toAssigned toContains many \ No newline at end of file diff --git a/docs/vercel.json b/docs/vercel.json index 891cc1be0a89..dd7221131aef 100644 --- a/docs/vercel.json +++ b/docs/vercel.json @@ -735,6 +735,18 @@ { "source": "/integrating-with-flagsmith/flagsmith-api-overview/admin-api/updating-flags", "destination": "/managing-flags/updating-flags" + }, + { + "source": "/integrating-with-flagsmith/flagsmith-api-overview/admin-api", + "destination": "/integrating-with-flagsmith/flagsmith-api-overview/management-api" + }, + { + "source": "/integrating-with-flagsmith/flagsmith-api-overview/admin-api/authentication", + "destination": "/integrating-with-flagsmith/flagsmith-api-overview/management-api/authentication" + }, + { + "source": "/integrating-with-flagsmith/flagsmith-api-overview/admin-api/code-examples", + "destination": "/integrating-with-flagsmith/flagsmith-api-overview/management-api/code-examples" } ], "trailingSlash": false diff --git a/frontend/web/components/AdminAPIKeys.js b/frontend/web/components/ManagementAPIKeys.js similarity index 98% rename from frontend/web/components/AdminAPIKeys.js rename to frontend/web/components/ManagementAPIKeys.js index 2b5c6a70724d..ce02cd8e5d12 100644 --- a/frontend/web/components/AdminAPIKeys.js +++ b/frontend/web/components/ManagementAPIKeys.js @@ -198,7 +198,7 @@ export class CreateAPIKey extends PureComponent { isValid={!!this.state.name} type='text' inputClassName='input--wide' - placeholder='e.g. Admin API Key' + placeholder='e.g. Management API Key' /> <> @@ -335,7 +335,7 @@ export class CreateAPIKey extends PureComponent { } } -export default class AdminAPIKeys extends PureComponent { +export default class ManagementAPIKeys extends PureComponent { static displayName = 'TheComponent' state = { @@ -369,7 +369,7 @@ export default class AdminAPIKeys extends PureComponent { createAPIKey = () => { openModal( - 'New Admin API Key', + 'New Management API Key', { @@ -459,7 +459,7 @@ export default class AdminAPIKeys extends PureComponent { } > - {`API keys are used to authenticate with the Admin API. `} + {`API keys are used to authenticate with the Management API. `}