Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/cli/15_config-identity-service.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/hydra/reference/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/keto/reference/rest-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/kratos/reference/api.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/oathkeeper/reference/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
123 changes: 113 additions & 10 deletions docs/reference/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ sidebar_label: Overview
---

import Link from "@docusaurus/Link"
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"

<Tabs>
<TabItem value="network" label="Ory Network" default>

# 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

Expand All @@ -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
</TabItem>

<TabItem value="oel" label="Ory OEL" default>

# 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.

</TabItem>

<TabItem value="oss" label="Ory OSS" default>

# 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.

</TabItem>

</Tabs>
6 changes: 3 additions & 3 deletions docs/sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
41 changes: 41 additions & 0 deletions sidebars-network.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
],
},
],
},
],
},
],
},
]
Expand Down
6 changes: 3 additions & 3 deletions sidebars-oel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,9 @@ const oelSidebar = [
label: "Reference",
items: [
"kratos/reference/api",
{
SDK: ["kratos/sdk/overview", "kratos/self-hosted/go"],
},
{
"Command Line Interface (CLI)": [
{
Expand All @@ -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",
Expand Down
6 changes: 3 additions & 3 deletions sidebars-oss.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ const ossSidebar = [
label: "Reference",
items: [
"kratos/reference/api",
{
SDK: ["kratos/sdk/overview", "kratos/self-hosted/go"],
},
{
"Command Line Interface (CLI)": [
{
Expand All @@ -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",
Expand Down
38 changes: 0 additions & 38 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -204,7 +167,6 @@ const sidebars: SidebarsConfig = {
quickstartsOelSidebar,
quickstartsOssSidebar,
api,
cli,
troubleshooting,
security,
elements,
Expand Down
12 changes: 2 additions & 10 deletions src/navbar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading