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
24 changes: 24 additions & 0 deletions docs/guides/cli/10_config-with-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,30 @@ All Ory components use the same configuration format and APIs whether they are s

This allows you to use the Ory CLI to configure your components, no matter how you use Ory!

## Stored secrets

:::warning

When you read your Ory Network project configuration through the API or the Ory CLI (for example with `ory get project` or
`ory get identity-config`), the following secret fields are returned **empty** even when a value is stored:

- SMTP `courier.smtp.connection_uri` — the password segment of the URI is removed.
- OIDC provider `client_secret` — for every entry in `selfservice.methods.oidc.config.providers`.
- Apple provider `apple_private_key`.

The stored value stays in place and continues to be used at runtime. Only the API response is redacted.

When you write the configuration back:

- **To keep the stored secret**: leave the field as the API returned it (`null` for OIDC `client_secret` and `apple_private_key`,
or a URI without the password segment for SMTP `connection_uri`). The server merges your update with the existing secret.
- **To rotate a secret**: set the new value explicitly.
- **Setting an OIDC `client_secret` or Apple `apple_private_key` to an empty string is rejected by configuration validation** —
these fields are required when the provider is configured, so you cannot accidentally clear them by sending an empty value. To
remove a secret entirely, remove the provider.

:::

## Configure projects

There are two ways to adjust the configuration of projects. You can:
Expand Down
8 changes: 8 additions & 0 deletions docs/guides/cli/15_config-identity-service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ title: Ory Identities CLI
Using the Ory CLI, you can quickly adjust the configuration of the Ory Identities and apply config from the Ory Network
environment to self-hosted Ory Kratos Identity Server instances.

:::note

When you export the configuration with `ory get identity-config`, the SMTP `connection_uri` password, OIDC provider
`client_secret`, and `apple_private_key` are returned empty even when a value is stored. See the
[stored secrets note](./config-with-cli#stored-secrets) for the behavior when writing the configuration back.

:::

:::tip

[Ory Kratos](https://github.com/ory/kratos) is the open-source project that powers the Ory Identities.
Expand Down
8 changes: 8 additions & 0 deletions docs/guides/gitops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ This guide will walk you through the process of managing your Ory Network config
these steps, you'll be able to track changes, review, and approve them through pull requests, and automatically update the
configuration upon merge.

:::note

When you export the configuration with `ory get ...`, the SMTP `connection_uri` password, OIDC provider `client_secret`, and
`apple_private_key` are returned empty even when a value is stored. See the
[stored secrets note](./cli/config-with-cli#stored-secrets) for the behavior when writing the configuration back.

:::

This guide uses the GitHub Actions to update the configuration and manage changes through pull requests. You can adapt this to
GitLab CI, TravisCI, CircleCI, and other CI/CD systems.

Expand Down
8 changes: 8 additions & 0 deletions docs/guides/manage-project-via-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,14 @@ curl --location --request GET "https://api.console.ory.com/projects/${ORY_PROJEC
--header "Authorization: Bearer ${WORKSPACE_API_KEY}" | jq
```

:::note

The response does not include the password segment of the SMTP `connection_uri`, the OIDC provider `client_secret`, or the Apple
`apple_private_key`. These fields are returned empty even when a value is stored. The stored value is still used at runtime. See
the [stored secrets note](./cli/config-with-cli#stored-secrets) for the behavior when writing the configuration back.

:::

### Update an Ory Network project Configuration

You can use Workspace API keys to change a projects configuration through the API.
Expand Down
8 changes: 8 additions & 0 deletions docs/identities/get-started/social-sign-in.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,14 @@ The configuration includes:
<TabItem value="cli">
```

:::note

When you export the configuration with `ory get identity-config`, the OIDC provider `client_secret` (and the Apple
`apple_private_key`) are returned empty even when a value is stored. See the
[stored secrets note](../../guides/cli/config-with-cli#stored-secrets) for the behavior when writing the configuration back.

:::

To enable and configure social sign-in using the CLI:

1. First, download your Ory Identities configuration:
Expand Down
8 changes: 8 additions & 0 deletions docs/kratos/emails-sms/01_sending-emails-smtp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,14 @@ SparkPost separates US and EU accounts — pick data residency before integratio

### Your own server

:::note

When you export the configuration with `ory get identity-config`, the password segment of the SMTP `connection_uri` is returned
empty even when a value is stored. See the [stored secrets note](../../guides/cli/config-with-cli#stored-secrets) for the behavior
when writing the configuration back.

:::

<Tabs>
<TabItem value="smtp" label="SMTP">
You can send emails from your own SMTP server. Follow these steps to configure Ory to use a custom SMTP server:
Expand Down
8 changes: 8 additions & 0 deletions docs/kratos/social-signin/01_overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,11 @@ application.
The Ory Network provides GUI-based flows for adding and configuring social sign-in providers through the
[Ory Console](https://console.ory.com/login). Each flow is custom-tailored to accommodate configuration requirements of the
specific identity provider. Alternatively, you can use the [Ory CLI](../../guides/cli/01_installation.mdx).

:::note

When you export the configuration with `ory get identity-config`, the OIDC provider `client_secret` and the Apple
`apple_private_key` are returned empty even when a value is stored. See the
[stored secrets note](../../guides/cli/config-with-cli#stored-secrets) for the behavior when writing the configuration back.

:::
8 changes: 8 additions & 0 deletions docs/kratos/social-signin/30_apple.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,14 @@ middleware, as Apple uses a POST form request that does not include the CSRF coo
<TabItem value="cli" label="Ory CLI">
```

:::note

When you export the configuration with `ory get identity-config`, the `apple_private_key` is returned empty even when a value is
stored. See the [stored secrets note](../../guides/cli/config-with-cli#stored-secrets) for the behavior when writing the
configuration back.

:::

Follow these steps to add Apple as a social sign-in provider to your project using the Ory CLI:

1. Using an Apple Developer Account, create an app, a service, and a private key. Check the Ory Console guide for the concrete
Expand Down
Loading