Skip to content

Commit e1650cf

Browse files
committed
chore: format
1 parent b80511d commit e1650cf

14 files changed

+233
-214
lines changed

docs/migrate-to-ory/auth0.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,4 +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-
```
148+
```

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +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. 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.
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 process
10+
without affecting your live data or users.
1111

1212
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.
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.
1515
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.
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.
1818
1. Review a [quick start](https://www.ory.com/docs/welcome) for your framework.
1919

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.
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
21+
to use. 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: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,34 @@ sidebar_label: Design your identity schema
55
sidebar_position: 3
66
---
77

8-
To align identities from your current system with Ory, you can customize the identity schema to meet your specific requirements.
9-
This ability to customize the identity schema means you can enhance and improve your old identity schema during the migration process.
8+
To align identities from your current system with Ory, you can customize the identity schema to meet your specific requirements.
9+
This ability to customize the identity schema means you can enhance and improve your old identity schema during the migration
10+
process.
1011

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

15-
Identities have two main data types: traits (attributes that users can modify themselves, such as username or email address)
16-
and metadata (attributes defined by system admins that can only be updated through admin APIs. Metadata is useful for storing
17-
information like subscription status, legacy user IDs, or basic roles). Metadata comes in two forms: public (visible to
18-
users via session endpoints) and admin (only accessible through admin APIs).
16+
Identities have two main data types: traits (attributes that users can modify themselves, such as username or email address) and
17+
metadata (attributes defined by system admins that can only be updated through admin APIs. Metadata is useful for storing
18+
information like subscription status, legacy user IDs, or basic roles). Metadata comes in two forms: public (visible to users via
19+
session endpoints) and admin (only accessible through admin APIs).
1920

2021
## Best practices for identity schema design:
2122

2223
### Do:
2324

24-
- Use the identity schema for basic profile information that's used across your system, including usernames, email addresses,
25-
phone numbers, first names, and last names
25+
- Use the identity schema for basic profile information that's used across your system, including usernames, email addresses,
26+
phone numbers, first names, and last names
2627
- Store authentication-related data like login identifiers and verification addresses in traits
2728
- Use metadata fields for system-managed information like legacy user IDs, subscription status, or basic roles
2829

2930
### Don't:
3031

31-
- Store sensitive internal data or information that should be obfuscated from users in the identity schema, since users can
32-
see traits and other data (except credentials) using the `/sessions/whoami` endpoint
33-
- Store business logic or application-specific data like credit card information, shipping addresses, shopping cart items, or
34-
detailed user preferences—keep this in your application database instead
32+
- Store sensitive internal data or information that should be obfuscated from users in the identity schema, since users can see
33+
traits and other data (except credentials) using the `/sessions/whoami` endpoint
34+
- Store business logic or application-specific data like credit card information, shipping addresses, shopping cart items, or
35+
detailed user preferences—keep this in your application database instead
3536

36-
Ory provides preset schemas to help you get started quickly. For detailed guidance on customizing schemas, see the
37-
[identity schemas](../../kratos/manage-identities/identity-schema) documentation.
37+
Ory provides preset schemas to help you get started quickly. For detailed guidance on customizing schemas, see the
38+
[identity schemas](../../kratos/manage-identities/identity-schema) documentation.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ sidebar_label: Migration FAQ
55
sidebar_position: 1
66
---
77

8-
TODO: Living section for specific questions/answers that Sales get asked but which don't neatly fit within the migration process.
8+
TODO: Living section for specific questions/answers that Sales get asked but which don't neatly fit within the migration process.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +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. To monitor the system, view live events at
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, gather user feedback, and make adjustments as needed to
23-
improve performance and user experience.
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.
2424

2525
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.
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: 38 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,24 @@ title: Understand your current IAM system
44
sidebar_label: Understand your current IAM system
55
sidebar_position: 1
66
---
7+
78
# Understand your current IAM system
89

9-
Before you can migrate smoothly, you need a complete picture of how your identity management system works today. This step ensures
10-
nothing gets missed—from everyday login flows to rare edge cases—and sets the foundation for mapping existing functionality to
11-
Ory Network's equivalent capabilities.
10+
Before you can migrate smoothly, you need a complete picture of how your identity management system works today. This step ensures
11+
nothing gets missed—from everyday login flows to rare edge cases—and sets the foundation for mapping existing functionality to Ory
12+
Network's equivalent capabilities.
1213

1314
:::info Why it matters
1415

15-
Mapping your full login lifecycle is the best way to de-risk migration. Your current IAM system may be abstracting away key
16+
Mapping your full login lifecycle is the best way to de-risk migration. Your current IAM system may be abstracting away key
1617
functionality without you realizing it. With Ory Network, you gain full control to shape and optimize every flow to your needs.
1718
:::
1819

1920
## Identify your IAM scenario
20-
Below are example IAM scenarios supported by Ory Network. Use them to identify which scenario best fits your specific IAM needs and
21-
understand the unique requirements of each approach. Each scenario differs in complexity and implementation needs. Use these IAM
22-
scenarios to map the identity flows for your application.
21+
22+
Below are example IAM scenarios supported by Ory Network. Use them to identify which scenario best fits your specific IAM needs
23+
and understand the unique requirements of each approach. Each scenario differs in complexity and implementation needs. Use these
24+
IAM scenarios to map the identity flows for your application.
2325

2426
<Tabs
2527
defaultValue="CIAM"
@@ -36,6 +38,7 @@ scenarios to map the identity flows for your application.
3638
Your company sells products or services directly to individual consumers.
3739

3840
#### Key IAM requirements
41+
3942
- Self-service registration, login, and profile management for end users
4043
- Social login, multi-factor passwordless options, and robust account recovery
4144
- Privacy compliance (GDPR, CCPA)
@@ -46,8 +49,8 @@ Your company sells products or services directly to individual consumers.
4649

4750
### B2B (Business-to-Business)
4851

49-
Your company sells products or services directly to other businesses rather than individual consumers. Your customers are organizations
50-
that use these products or services to run their own operations.
52+
Your company sells products or services directly to other businesses rather than individual consumers. Your customers are
53+
organizations that use these products or services to run their own operations.
5154

5255
#### Key IAM requirements
5356

@@ -57,16 +60,18 @@ that use these products or services to run their own operations.
5760
- Role-based permissions and API controls
5861
- Privacy compliance (GDPR, CCPA)
5962
- High-scale performance for millions of users
60-
</TabItem>
63+
</TabItem>
6164
<TabItem value="Workforce">
6265

6366
### Workforce (Business-to-Enterprise)
6467

65-
Your company provides products or services. Your company wants to manage access for a single organization's extended workforce. You want to
66-
consolidate employee user accounts and identities across multi-tenant brands, applications and systems. You need to seamlessly connect with
67-
existing enterprise identity providers and other 3rd party systems, and streamline user onboarding, offboarding, and permission management.
68+
Your company provides products or services. Your company wants to manage access for a single organization's extended workforce.
69+
You want to consolidate employee user accounts and identities across multi-tenant brands, applications and systems. You need to
70+
seamlessly connect with existing enterprise identity providers and other 3rd party systems, and streamline user onboarding,
71+
offboarding, and permission management.
6872

6973
#### Key IAM requirements
74+
7075
- Streamline onboarding/offboarding of employee, contractor, and temporary workers
7176
- Role-based access aligned with organizational hierarchy
7277
- HR system integration with flexible identity schemas
@@ -75,39 +80,42 @@ existing enterprise identity providers and other 3rd party systems, and streamli
7580
- Zero-trust security, MFA, and SSO for enterprise applications
7681
- Privacy compliance (GDPR, CCPA)
7782
- High-scale performance for millions of users
78-
</TabItem>
83+
</TabItem>
7984
<TabItem value="Agentic AI">
8085

8186
### Agentic AI
8287

83-
Your company wants to enable AI applications to securely connect to data sources and tools. For example, servers that host resources and
84-
clients (AI applications) that discover and use those resources.
88+
Your company wants to enable AI applications to securely connect to data sources and tools. For example, servers that host
89+
resources and clients (AI applications) that discover and use those resources.
8590

8691
#### Key IAM requirements
92+
8793
- Standardized protocol that works across many tools and data sources
8894
- Built-in authentication and access control
89-
</TabItem>
95+
</TabItem>
9096
</Tabs>
9197

9298
## Map all identity flows in your application
9399

94-
Document every identity-related (authentication and authorization) process in your system. Use your IAM scenario’s Key IAM requirements to identify
95-
these flows. This ensures you don’t miss critical flows during migration.
100+
Document every identity-related (authentication and authorization) process in your system. Use your IAM scenario’s Key IAM
101+
requirements to identify these flows. This ensures you don’t miss critical flows during migration.
96102

97-
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).
103+
1. Identify all entry points where an identity-related process occurs (e.g., web app login, mobile app sign-in, API tokens, social
104+
or enterprise sign-ins).
98105
1. Create a comprehensive inventory of flows, for example:
99-
- Registration
100-
- Sign-in and sign-out
101-
- Multi-Factor Authentication (MFA)
102-
- Password reset and account recovery
103-
- Account linking (social, enterprise logins)
104-
- User profile management
105-
- Token refresh and session handling
106-
- Recovery flows, consent screens, or partner-specific integrations
106+
- Registration
107+
- Sign-in and sign-out
108+
- Multi-Factor Authentication (MFA)
109+
- Password reset and account recovery
110+
- Account linking (social, enterprise logins)
111+
- User profile management
112+
- Token refresh and session handling
113+
- Recovery flows, consent screens, or partner-specific integrations
107114
1. Create flow diagrams (sequence diagrams or flow charts) to surface dependencies and hidden complexity.
108115
1. Note where identity-related processes interact with other systems (databases, CRMs, partner apps, or external APIs).
109116

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:
117+
At the end of this process you should have a living document (one that you'll update as you discover more) with diagrams that
118+
capture:
111119

112120
- All identity-related flows
113121
- Your system's existing functionality
@@ -120,4 +128,4 @@ This will serve as your blueprint for planning, designing, testing, and validati
120128
import Help from '@site/docs/_common/need-help.mdx'
121129
122130
<Help/>
123-
```
131+
```

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ When the frontend makes an API call to your backend, it will include the necessa
99
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
1111
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
12+
calls to Ory’s API won’t automatically include cookies, you must manually attach the relevant cookies to these requests. This
1313
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
@@ -21,9 +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. See [Identity metadata & traits ](../../kratos/manage-identities/managing-users-identities-metadata) documentation for details.
24+
user. See [Identity metadata & traits ](../../kratos/manage-identities/managing-users-identities-metadata) documentation for
25+
details.
2526
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-
27+
[`whoami`](https://www.ory.com/docs/kratos/reference/api#tag/frontend/operation/toSession) API endpoint. This endpoint returns
28+
the session details, including the identity, allowing the backend to authenticate the request and link it to the internal user
29+
record.

0 commit comments

Comments
 (0)