Skip to content

Commit b80511d

Browse files
committed
docs: final review comments
1 parent 6f448c2 commit b80511d

File tree

12 files changed

+233
-142
lines changed

12 files changed

+233
-142
lines changed

docs/migrate-to-ory/auth0.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,4 @@ Follow these steps to import Auth0 users to Ory:
145145

146146
```shell
147147
ory list identities --project <project-id> --workspace <workspace-id>
148-
```
149-
# FAQ
150-
TODO: Living section for specific questions/answers that Sales get asked but which don't neatly fit within the Auth0 migration process.
148+
```

docs/migrate-to-ory/migrate/create-project.mdx

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,17 @@ sidebar_label: Create an Ory Network project
55
sidebar_position: 3
66
---
77

8-
Now that you have chosen your migration strategy, you can begin the actual migration process by setting up your Ory Network
9-
projects in a development, staging, and production environment.
8+
Now that you have chosen your migration strategy, you can begin the actual migration process. Perform the migration in a
9+
development or staging environment before migrating to your production environment. This allows you to test and refine the
10+
process without affecting your live data or users.
1011

11-
You can create a new Ory Network project using the Ory CLI. The command `ory create project` allows you to specify the environment
12-
of the project, the output format, the name of the project, and the workspace to use. More details about creating a project can be
13-
found [here](../../cli/ory-create-project).
12+
1. Get an [Ory Network account](https://console.ory.sh/login?flow=c59cbae0-ea41-44e4-b46a-f9e1857be3a2).
13+
1. Install Ory CLI and [set up your local environment](https://www.ory.com/docs/getting-started/local-development) to start
14+
developing with Ory.
15+
1. Create an Ory project and get your Ory project ID.
16+
1. [Set up the necessary dependencies and configurations](https://www.ory.com/docs/identities/get-started/setup) to integrate
17+
Ory's features into your application.
18+
1. Review a [quick start](https://www.ory.com/docs/welcome) for your framework.
1419

15-
Before migrating to your production environment, perform the migration in a development or staging environment. This allows you to
16-
test and refine the process without affecting your live data or users.
20+
You can use the Ory CLI to specify the environment of the project, the output format, the name of the project, and the workspace to use.
21+
See the [Ory CLI Reference](../../cli/ory-create-project) for the `ory create project` command and additional options.

docs/migrate-to-ory/migrate/design-id-schema.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ To align identities from your current system with Ory, you can customize the ide
99
This ability to customize the identity schema means you can enhance and improve your old identity schema during the migration process.
1010

1111
The identity schema, which implements the JSON Schema standard, defines the types of data the system can store for users—such as
12-
names, email addresses, phone numbers, or birthdays—and controls business logic by specifying which fields serve as login
13-
identifiers and which are used for verification or recovery.
12+
names, email addresses, phone numbers, or birthdays. It also controls business logic by specifying which fields serve as login
13+
identifiers and which are used for verification or recovery.
1414

1515
Identities have two main data types: traits (attributes that users can modify themselves, such as username or email address)
1616
and metadata (attributes defined by system admins that can only be updated through admin APIs. Metadata is useful for storing

docs/migrate-to-ory/migrate/go-live.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@ live with Ory in your production environment.
1717
periods. Communicate the planned migration to your users in advance, including any expected downtime or changes they should be
1818
aware of.
1919
1. Monitor the transition: As you switch over to Ory, closely monitor the system for any issues, such as failed authentications,
20-
performance bottlenecks, or user complaints. Use live events to monitor the system under
20+
performance bottlenecks, or user complaints. To monitor the system, view live events at
2121
<ConsoleLink route="project.activity.events" />.
22-
1. Optimize and refine: After the go-live, continue to monitor the system and gather user feedback.
22+
1. Optimize and refine: After the go-live, continue to monitor the system, gather user feedback, and make adjustments as needed to
23+
improve performance and user experience.
2324

24-
Once your Ory integration is stable and users are successfully authenticating with the new system, your migration is complete.
25+
Once your Ory integration is stable and users are successfully authenticating with the new system, your migration is complete.
26+
Continue to leverage Ory's features to enhance your authentication and identity management over time.

docs/migrate-to-ory/migrate/index.mdx

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,29 @@ sidebar_position: 1
77
# Understand your current IAM system
88

99
Before you can migrate smoothly, you need a complete picture of how your identity management system works today. This step ensures
10-
nothing gets missedfrom everyday login flows to rare edge casesand sets the foundation for mapping existing functionality to
10+
nothing gets missedfrom everyday login flows to rare edge casesand sets the foundation for mapping existing functionality to
1111
Ory Network's equivalent capabilities.
1212

1313
:::info Why it matters
1414

15-
Not understanding your existing system’s behavior is the #1 cause of unexpected regressions during cutover. With Ory Network, you
16-
gain full control, and with it, the ability to shape your system’s flows exactly to your needs.
17-
15+
Mapping your full login lifecycle is the best way to de-risk migration. Your current IAM system may be abstracting away key
16+
functionality without you realizing it. With Ory Network, you gain full control to shape and optimize every flow to your needs.
1817
:::
1918

19+
## Identify your IAM scenario
2020
Below are example IAM scenarios supported by Ory Network. Use them to identify which scenario best fits your specific IAM needs and
2121
understand the unique requirements of each approach. Each scenario differs in complexity and implementation needs. Use these IAM
2222
scenarios to map the identity flows for your application.
2323

24-
## Identify your IAM scenario
25-
- [CIAM](#ciam-customer-identity-and-access-management)
26-
- [B2B](#b2b-business-to-business)
27-
- [Workforce](#workforce-business-to-enterprise)
28-
- [Agentic AI](#agentic-ai)
29-
24+
<Tabs
25+
defaultValue="CIAM"
26+
values={[
27+
{label: 'CIAM', value: 'CIAM'},
28+
{label: 'B2B', value: 'B2B'},
29+
{label: 'Workforce', value: 'Workforce'},
30+
{label: 'Agentic AI', value: 'Agentic AI'},
31+
]}>
32+
<TabItem value="CIAM">
3033

3134
### CIAM (Customer Identity and Access Management)
3235

@@ -38,6 +41,9 @@ Your company sells products or services directly to individual consumers.
3841
- Privacy compliance (GDPR, CCPA)
3942
- High-scale performance for millions of users
4043

44+
</TabItem>
45+
<TabItem value="B2B">
46+
4147
### B2B (Business-to-Business)
4248

4349
Your company sells products or services directly to other businesses rather than individual consumers. Your customers are organizations
@@ -51,6 +57,8 @@ that use these products or services to run their own operations.
5157
- Role-based permissions and API controls
5258
- Privacy compliance (GDPR, CCPA)
5359
- High-scale performance for millions of users
60+
</TabItem>
61+
<TabItem value="Workforce">
5462

5563
### Workforce (Business-to-Enterprise)
5664

@@ -67,6 +75,8 @@ existing enterprise identity providers and other 3rd party systems, and streamli
6775
- Zero-trust security, MFA, and SSO for enterprise applications
6876
- Privacy compliance (GDPR, CCPA)
6977
- High-scale performance for millions of users
78+
</TabItem>
79+
<TabItem value="Agentic AI">
7080

7181
### Agentic AI
7282

@@ -76,28 +86,30 @@ clients (AI applications) that discover and use those resources.
7686
#### Key IAM requirements
7787
- Standardized protocol that works across many tools and data sources
7888
- Built-in authentication and access control
89+
</TabItem>
90+
</Tabs>
7991

8092
## Map all identity flows in your application
8193

82-
Build a complete picture of every identity-related process in your system. Use your IAM scenario’s Key IAM requirements to identify
94+
Document every identity-related (authentication and authorization) process in your system. Use your IAM scenario’s Key IAM requirements to identify
8395
these flows. This ensures you don’t miss critical flows during migration.
8496

8597
1. Identify all entry points where an identity-related process occurs (e.g., web app login, mobile app sign-in, API tokens, social or enterprise sign-ins).
8698
1. Create a comprehensive inventory of flows, for example:
87-
- Registration/sign-up
88-
- Sign-in/sign-out
99+
- Registration
100+
- Sign-in and sign-out
89101
- Multi-Factor Authentication (MFA)
90102
- Password reset and account recovery
91103
- Account linking (social, enterprise logins)
92104
- User profile management
93105
- Token refresh and session handling
94106
- Recovery flows, consent screens, or partner-specific integrations
95107
1. Create flow diagrams (sequence diagrams or flow charts) to surface dependencies and hidden complexity.
96-
1. Note where identity-related (authentication and authorization) processes interact with other systems (databases, CRMs, partner apps, or external APIs).
108+
1. Note where identity-related processes interact with other systems (databases, CRMs, partner apps, or external APIs).
97109

98-
At the end of this process you should have a living document with diagrams that capture:
110+
At the end of this process you should have a living document (one that you'll update as you discover more) with diagrams that capture:
99111

100-
- All identity-related (authentication and authorization) flows
112+
- All identity-related flows
101113
- Your system's existing functionality
102114
- Any existing dependencies on external systems
103115
- Edge cases requiring special handling

docs/migrate-to-ory/migrate/integrate-backend.mdx

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ sidebar_position: 1
66
---
77

88
When the frontend makes an API call to your backend, it will include the necessary cookies. Your backend must then forward these
9-
cookies when calling the Ory API to validate the session. For example in a Go backend, you could use a
9+
cookies when calling the Ory API to validate the session. For example, in a Go backend, you could use a
1010
[middleware](../../getting-started/integrate-auth/go#validate-and-login) to intercept API requests and validate the session by
11-
calling Ory’s toSession() method. Ensure that the cookies received from the front end are forwarded in this call. Since backend
12-
calls to Ory’s API won’t automatically include cookies, you must manually attach the relevant cookies to these requests. This is
13-
important for the backend to be able to check the session.
11+
calling Ory’s `toSession()` method. Ensure that the cookies received from the frontend are forwarded in this call. Since backend
12+
calls to Ory’s API won’t automatically include cookies, you must manually attach the relevant cookies to these requests. This
13+
allows the backend to validate the session.
1414

1515
When using Ory to manage identities, it is best practice to store business logic in your application database and keep only
1616
authentication-relevant data in Ory. Here’s a general approach:
@@ -21,8 +21,9 @@ authentication-relevant data in Ory. Here’s a general approach:
2121
link Ory-managed identities with your business logic.
2222
1. Establish a connection between the Ory identity and the user record in your database by storing the `user.id` in
2323
`identity.metadata_public.id`. This ensures that subsequent API calls can easily map the Ory identity to the correct internal
24-
user. More about metadata in the [Identity metadata & traits ](../../kratos/manage-identities/managing-users-identities-metadata)
25-
documentation.
26-
1. Now when the frontend makes API calls containing the Ory cookie or token, the backend should verify the session using the
27-
whoami API endpoint. This endpoint returns the session details, including the identity, allowing the backend to authenticate
28-
the request and link it to the internal user record.
24+
user. See [Identity metadata & traits ](../../kratos/manage-identities/managing-users-identities-metadata) documentation for details.
25+
1. When the frontend makes API calls containing the Ory cookie or token, the backend should verify the session using the
26+
[`whoami`](https://www.ory.com/docs/kratos/reference/api#tag/frontend/operation/toSession) API endpoint. This endpoint returns the session details, including the identity, allowing the backend to authenticate
27+
the request and link it to the internal user record.
28+
29+

docs/migrate-to-ory/migrate/integrate-frontend.mdx

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,31 @@ To make authenticated API calls using Ory, start by properly configuring your do
99
is set to the root domain (e.g., example.org) when you add a custom domain. This ensures that cookies can be shared across all
1010
subdomains.
1111

12-
- Example subdomain structure:
13-
- Run Ory at auth.example.org.
14-
- Host your backend API at api.example.org.
15-
- Serve your frontend UI at www.example.org or another designated subdomain.
12+
Example subdomain structure:
13+
- Run Ory at auth.example.org.
14+
- Host your backend API at api.example.org.
15+
- Serve your frontend UI at www.example.org or another designated subdomain.
1616

17-
This setup allows both your front end and back end to access the authentication session cookies managed by Ory.
17+
This setup allows both your frontend and backend applications to access the authentication session cookies managed by Ory.
1818

19-
To begin integrating Ory into your frontend, it's helpful to start with the
19+
To begin integrating Ory into your frontend, start with the
2020
["protect a page with login" guides](../../getting-started/overview) that cover the basics of developing with Ory for various
2121
programming languages and frameworks, including SDK usage and essential setup steps.
2222

23+
## Account Experience
24+
2325
Ory Network has two types of user interfaces. We recommend starting with the built-in
2426
[Account Experience](../../account-experience/index.mdx), which offers a standard user interface, covering all self-service flows
25-
with the option to style branding to get you up and running. If you prefer a custom user interface that matches your current
26-
design 1:1, Ory allows you to create and style a custom UI that integrates seamlessly with your existing setup. You can do this
27-
using the API directly, the SDK for your language, or - if you are working in the React ecosystem - Ory Elements. Ory Elements is
28-
a component library designed to make building login, registration, and account pages for Ory easy. It is modular and customizable,
29-
allowing you to use only the components you need while tailoring them to fit your implementation's design. The UI created with Ory
30-
Elements changes dynamically to adapt to your Ory Network configuration. More details about customizing the user interface with
31-
Ory Elements can be found [here](../../elements/index.mdx).
27+
with the option to style branding to get you up and running.
28+
29+
## Custom user interface
30+
31+
If you prefer a custom user interface that matches your current design exactly, Ory allows you to create and style a custom UI that
32+
integrates seamlessly with your existing setup. You can do this using the API directly, the SDK for your language, or, if you are working
33+
in the React ecosystem, Ory Elements.
34+
35+
### Ory Elements
36+
37+
[Ory Elements](../../elements/index.mdx) is a component library designed to make building login, registration, and account
38+
pages for Ory easy. It is modular and customizable, allowing you to use only the components you need while tailoring them to fit your
39+
implementation's design. The UI created with Ory Elements changes dynamically to adapt to your Ory Network configuration.

docs/migrate-to-ory/migrate/map-to-orycap.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ sidebar_position: 1
66
---
77

88
Using your list of identity-related flows, create a side-by-side table to map existing functionality to Ory Network’s equivalent
9-
capabilities. While the majority of the time you'll find your existing functionality neatly maps to Ory's capabilities, now is the best time to
10-
identify when it does not. Some examples:
9+
capabilities. While most of the time you'll find your existing functionality neatly maps to Ory's capabilities, this is
10+
the best time to identify when it does not. Some examples:
1111

12-
- Not all vendors strickly comply with standards, whereas Ory does, so you might discover you need to
13-
change how you implement functionality to be compliant.
14-
- You might have a unique use case to solve that requires additional help from our support.
12+
13+
14+
- Not all vendors strictly comply with standards, whereas Ory does, so you might need to change how you implement functionality
15+
to be compliant with standards
16+
- You might have a unique use case that requires additional help from our support team
1517

1618
Table 1: An example of mapping functionality
1719

0 commit comments

Comments
 (0)