diff --git a/docs/guides/cli/15_config-identity-service.mdx b/docs/guides/cli/15_config-identity-service.mdx index 463732ac07..2f46d2f8c1 100644 --- a/docs/guides/cli/15_config-identity-service.mdx +++ b/docs/guides/cli/15_config-identity-service.mdx @@ -1,6 +1,6 @@ --- id: identity-cli -title: Ory Identities CLI +title: Configure Identities --- Using the Ory CLI, you can quickly adjust the configuration of the Ory Identities and apply config from the Ory Network diff --git a/docs/hydra/reference/api.mdx b/docs/hydra/reference/api.mdx index d7de182e65..f2c6f3cb0e 100644 --- a/docs/hydra/reference/api.mdx +++ b/docs/hydra/reference/api.mdx @@ -3,7 +3,7 @@ id: api hide_title: true title: HTTP API documentation description: Ory Hydra HTTP API documentation -sidebar_label: HTTP API +sidebar_label: REST API --- ```mdx-code-block diff --git a/docs/keto/reference/rest-api.mdx b/docs/keto/reference/rest-api.mdx index 67b348568f..8515b192cb 100644 --- a/docs/keto/reference/rest-api.mdx +++ b/docs/keto/reference/rest-api.mdx @@ -3,7 +3,7 @@ id: rest-api hide_title: true title: HTTP API documentation description: Ory Keto HTTP API documentation -sidebar_label: HTTP API +sidebar_label: REST API --- ```mdx-code-block diff --git a/docs/kratos/reference/api.mdx b/docs/kratos/reference/api.mdx index 218c6f8554..0a444aaa08 100644 --- a/docs/kratos/reference/api.mdx +++ b/docs/kratos/reference/api.mdx @@ -1,9 +1,9 @@ --- id: api hide_title: true -title: HTTP API documentation -description: Ory Kratos HTTP API documentation -sidebar_label: HTTP API +title: REST API documentation +description: Ory Kratos REST API documentation +sidebar_label: REST API --- ```mdx-code-block diff --git a/docs/oathkeeper/reference/api.mdx b/docs/oathkeeper/reference/api.mdx index 2f0d9d4301..b9a078712b 100644 --- a/docs/oathkeeper/reference/api.mdx +++ b/docs/oathkeeper/reference/api.mdx @@ -3,7 +3,7 @@ id: api hide_title: true title: HTTP API documentation description: Ory Oathkeeper HTTP API documentation -sidebar_label: HTTP API +sidebar_label: REST API --- ```mdx-code-block diff --git a/docs/reference/overview.mdx b/docs/reference/overview.mdx index 4268bdfb75..7fb686838f 100644 --- a/docs/reference/overview.mdx +++ b/docs/reference/overview.mdx @@ -6,6 +6,16 @@ sidebar_label: Overview --- import Link from "@docusaurus/Link" +import Tabs from "@theme/Tabs" +import TabItem from "@theme/TabItem" + + + + +# Ory Network + +These tools are intended for Ory Network integrations only. You must use the service-specific tools for Ory OEL or Ory OSS +integrations. ## Ory CLI @@ -25,27 +35,120 @@ are available for supported languages. ## Ory SDKs -Ory provides two SDK families depending on your deployment. The Ory Network SDK is a single, unified client that covers identity -management, OAuth2, and permissions in one package. Service-specific SDKs are available for self-hosted deployments, with a -separate client for each Ory product. - -### Ory Network SDK - A unified client (ory_client) for integrating with Ory Network. It covers identities, OAuth2, and permissions in a single package, targeting your project's API at `https://{project_slug}.projects.oryapis.com/`. Available in multiple languages. Consult the REST API documentation for code samples and usage examples. [Learn more...](/sdk) -### Service‑specific SDKs for self‑hosted deployments + + + + +# Ory Enterprise License + +These tools are intended for self-hosted deployments only. You must use the unified Ory Network tools for Ory Network +integrations. + +## Ory CLI + +Service-specific CLIs are available for self-hosted deployments, with a separate client for product. + +The CLI is the primary interface for managing Ory OEL from the command line. Use it to create and configure projects, manage +identities and permissions, run local development environments with built-in tunneling, and move configurations between +self-hosted and Ory Network deployments. + +Each CLI is documented under its respective product reference. + +- [Ory Kratos](/kratos/cli/kratos-cleanup-sql) +- [Ory Hydra](/hydra/cli/hydra-create-client) +- [Ory Keto](/keto/cli/keto-check) +- [Ory Oathkeeper](/oathkeeper/cli/oathkeeper-credentials-generate) +- [Ory Talos](/talos/reference/cli/talos) + +## Rest APIs + +Service-specific REST APIs are available for self-hosted deployments, with a separate client for each Ory product. + +Ory's REST APIs let you manage identities, OAuth2 clients, permissions, and project configuration programmatically. Public APIs +handle end-user flows like authentication. Administrative APIs require a Personal Access Token and cover backend operations. SDKs +are available for supported languages. + +Each product's REST API is documented under its respective product reference. + +- [Ory Kratos](/kratos/reference/api) +- [Ory Hydra](/hydra/reference/api) +- [Ory Keto](/keto/reference/rest-api) +- [Ory Polis](/polis/reference/api) +- [Ory OathKeeper](/oathkeeper/reference/api) +- [Ory Talos](/talos/reference/api/ory-talos-api) + +## SDKs + +Service-specific SDKs are available for self-hosted deployments, with a separate client for each Ory product. + +- [Ory Kratos](/kratos/sdk/overview) +- [Ory Hydra](/hydra/sdk/overview) +- [Ory Keto](/keto/sdk/overview) +- [Ory Polis](/polis/reference/api) +- [Ory Oathkeeper](/oathkeeper/sdk) + +Each SDK is documented under its respective product reference. + + + + + +# Ory Open Source + +These tools are intended for self-hosted deployments only. You must use the unified Ory Network tools for Ory Network +integrations. + +## Ory CLI + +Service-specific CLIs are available for self-hosted deployments, with a separate client for product. + +The CLI is the primary interface for managing Ory OEL from the command line. Use it to create and configure projects, manage +identities and permissions, run local development environments with built-in tunneling, and move configurations between +self-hosted and Ory Network deployments. + +Each CLI is documented under its respective product reference. + +- [Ory Kratos](/kratos/cli/kratos-cleanup-sql) +- [Ory Hydra](/hydra/cli/hydra-create-client) +- [Ory Keto](/keto/cli/keto-check) +- [Ory Oathkeeper](/oathkeeper/cli/oathkeeper-credentials-generate) +- [Ory Talos](/talos/reference/cli/talos) + +## Rest APIs + +Service-specific REST APIs are available for self-hosted deployments, with a separate client for each Ory product. -Each SDK is documented under its respective product reference. These are intended for self-hosted deployments only. You must use -the unified Ory Network SDK for Ory Network integrations. +Ory's REST APIs let you manage identities, OAuth2 clients, permissions, and project configuration programmatically. Public APIs +handle end-user flows like authentication. Administrative APIs require a Personal Access Token and cover backend operations. SDKs +are available for supported languages. -Separate clients for each self-hosted Ory product: +Each product's REST API is documented under its respective product reference. + +- [Ory Kratos](/kratos/reference/api) +- [Ory Hydra](/hydra/reference/api) +- [Ory Keto](/keto/reference/rest-api) +- [Ory Polis](/polis/reference/api) +- [Ory OathKeeper](/oathkeeper/reference/api) +- [Ory Talos](/talos/reference/api/ory-talos-api) + +## SDKs + +Service-specific SDKs are available for self-hosted deployments, with a separate client for each Ory product. - [Ory Kratos](/kratos/sdk/overview) - [Ory Hydra](/hydra/sdk/overview) - [Ory Keto](/keto/sdk/overview) - [Ory Polis](/polis/reference/api) - [Ory Oathkeeper](/oathkeeper/sdk) + +Each SDK is documented under its respective product reference. + + + + diff --git a/docs/sdk.mdx b/docs/sdk.mdx index af23f3fd7e..97f80e9c3a 100644 --- a/docs/sdk.mdx +++ b/docs/sdk.mdx @@ -9,9 +9,9 @@ The Ory SDK allows for integration with Ory services, including **Ory Identities Before using the SDK, consult the Ory [REST](./reference/api.mdx) API documentation, which includes code samples and examples for various programming languages. -This SDK is intended to be used with Ory Network. For self-hosting Ory services use the respective client. Read more in the -[self-hosting documentation](./reference/reference-overview#servicespecific-sdks-for-selfhosted-deployments) for each service -under **Reference/SDK**. +This SDK is intended to be used with Ory Network. For the Ory OEL and Ory OSS self-hosting services, use the service-specific +tools for those deployments. Read more in the [Ory OEL and Ory OSS reference documentation](./reference/reference-overview) for +each service. ## Download the SDK diff --git a/sidebars-network.ts b/sidebars-network.ts index 81e88daced..d3bffcf7a6 100644 --- a/sidebars-network.ts +++ b/sidebars-network.ts @@ -827,6 +827,47 @@ const networkSidebar = [ }, ], }, + { + type: "category", + label: "Reference", + collapsed: false, + items: [ + "reference/api", + "sdk", + { + type: "category", + label: "CLI reference", + collapsed: true, + collapsible: true, + link: { + type: "generated-index", + slug: "/category/ory-cli-reference", + }, + items: [ + "guides/cli/installation", + "guides/cli/config-with-cli", + "guides/cli/proxy-and-tunnel", + "guides/cli/cli-basics", + "guides/cli/identity-cli", + "guides/cli/oauth2-cli", + "guides/cli/configure-permission-service", + { + type: "category", + label: "CLI commands reference", + link: { + type: "generated-index", + }, + items: [ + { + type: "autogenerated", + dirName: "cli", + }, + ], + }, + ], + }, + ], + }, ], }, ] diff --git a/sidebars-oel.ts b/sidebars-oel.ts index 56b3552a51..176e3124cf 100644 --- a/sidebars-oel.ts +++ b/sidebars-oel.ts @@ -139,6 +139,9 @@ const oelSidebar = [ label: "Reference", items: [ "kratos/reference/api", + { + SDK: ["kratos/sdk/overview", "kratos/self-hosted/go"], + }, { "Command Line Interface (CLI)": [ { @@ -147,9 +150,6 @@ const oelSidebar = [ }, ], }, - { - SDK: ["kratos/sdk/overview", "kratos/self-hosted/go"], - }, "kratos/reference/configuration", "kratos/reference/json-schema-json-paths", "kratos/reference/html-forms", diff --git a/sidebars-oss.ts b/sidebars-oss.ts index ce1f9e7f32..124defc71a 100644 --- a/sidebars-oss.ts +++ b/sidebars-oss.ts @@ -113,6 +113,9 @@ const ossSidebar = [ label: "Reference", items: [ "kratos/reference/api", + { + SDK: ["kratos/sdk/overview", "kratos/self-hosted/go"], + }, { "Command Line Interface (CLI)": [ { @@ -121,9 +124,6 @@ const ossSidebar = [ }, ], }, - { - SDK: ["kratos/sdk/overview", "kratos/self-hosted/go"], - }, "kratos/reference/configuration", "kratos/reference/json-schema-json-paths", "kratos/reference/html-forms", diff --git a/sidebars.ts b/sidebars.ts index 122958a502..560b259acd 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -23,44 +23,7 @@ import quickstartsSidebar, { quickstartsOssSidebar, } from "./sidebars-quickstarts" -const cli: SidebarItemsConfig = [ - { - type: "category", - label: "Ory CLI reference", - collapsed: false, - collapsible: false, - link: { - type: "generated-index", - slug: "/category/ory-cli-reference", - }, - items: [ - "guides/cli/installation", - "guides/cli/cli-basics", - "guides/cli/identity-cli", - "guides/cli/oauth2-cli", - "guides/cli/configure-permission-service", - "guides/cli/proxy-and-tunnel", - "guides/cli/config-with-cli", - { - type: "category", - label: "CLI commands reference", - link: { - type: "generated-index", - }, - items: [ - { - type: "autogenerated", - dirName: "cli", - }, - ], - }, - ], - }, -] - const api: SidebarItemsConfig = [ - "reference/api", - "ecosystem/api-design", { type: "category", label: "Operations", @@ -204,7 +167,6 @@ const sidebars: SidebarsConfig = { quickstartsOelSidebar, quickstartsOssSidebar, api, - cli, troubleshooting, security, elements, diff --git a/src/navbar.ts b/src/navbar.ts index 5f59032dfb..87e788513e 100644 --- a/src/navbar.ts +++ b/src/navbar.ts @@ -91,16 +91,8 @@ export const navbar: Navbar = { position: "left", items: [ { - to: "/docs/reference/api", - label: "REST API", - }, - { - to: "/docs/category/ory-cli-reference", - label: "Ory CLI", - }, - { - to: "/docs/sdk", - label: "Ory SDKs", + to: "/docs/reference/reference-overview", + label: "REST APIs, SDKs, and CLIs references", }, { to: "/docs/category/operations-reference",