Skip to content

Commit 9228a21

Browse files
chore: documentation cleanup (#853)
Co-authored-by: hackerman <[email protected]>
1 parent d952713 commit 9228a21

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+608
-1719
lines changed

docs/concepts/managed-ui.mdx

Lines changed: 0 additions & 71 deletions
This file was deleted.

docs/concepts/personal-access-token.mdx

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,35 @@ id: personal-access-token
33
title: Personal Access Tokens
44
---
55

6-
You need to access the Ory administrative APIs if you want to:
6+
A Personal Access Token (PAT) is a means of authentication you can use when directly calling the Ory APIs. The PAT is bound to the
7+
Ory Cloud project where it was created. A PAT created for an administrator in project `A` won't be valid in project `B` in any
8+
capacity.
79

8-
- [list](../cli/ory-identities-list.md),
9-
- [update](../cli/ory-identities-get.md) or
10-
- [delete](../cli/ory-identities-delete.md) identities,
11-
- use the [Ory CLI](../guides/cli/10_config-with-cli.mdx) to manage your project
10+
For example, when calling Ory administrative APIs to [list](../cli/ory-identities-list.md), [update](../cli/ory-identities-get.md),
11+
or [delete](../cli/ory-identities-delete.md) identities, you must authenticate as an administrator. You can do that by passing
12+
a PAT in the request's `Authorization` header. The PAT must be generated for a user with administrative rights in the Ory Cloud
13+
Project in which you want to manage identities.
1214

13-
To access administrative APIs at Ory you need to authenticate as an administrator. Ory offers Personal Access Tokens to make this
14-
process easier for development. You can use PATs to access the admin API from the command line or via scripts.
15+
:::tip
1516

16-
:::note
17-
18-
Ory's Personal Access Tokens are always prefixed with `ory_pat_`, making them easier to identify in code analysis.
17+
You can use PATs to call APIs from the command line or through scripts. Ory PATs are always prefixed with `ory_pat_`, which makes
18+
it easy to identify them when analyzing code.
1919

2020
:::
2121

22-
Personal Access Tokens are bound to a project. They don't work for other projects than the one they have been created for.
22+
## Creating a Personal Access Token
23+
24+
Follow these steps to create a Personal Access Token (PAT):
2325

24-
Every member can create many, but not unlimited, personal access tokens. When creating a token you must give it a description to
25-
help you remember what you created the token for. It helps to name the token after the function it performs or after the person
26-
that uses it, but the name can be freely chosen.
26+
1. Open the [Ory Console](https://console.ory.sh/) and sign in.
27+
2. Select **Connect** from the left navigation bar.
28+
3. Scroll to the bottom of the page to the **Personal Access Token** section.
29+
4. Click the **+** icon.
30+
5. Define the name of the generated token. This name is used for identification purposes only.
31+
6. Copy the created PAT and store it in a safe place.
32+
33+
:::warning
2734

28-
The token is only displayed once upon creation. If you lose the token you will have to create a new one.
35+
The PAT is displayed only once. If you lose the token, you must generate a new one.
2936

30-
To see detailed instructions how to create and use Personal Access Tokens, refer to the
31-
[Create Personal Access Tokens Guide](../guides/create-personal-access-token.mdx).
37+
:::

docs/concepts/project-invite-membership.mdx

Lines changed: 0 additions & 74 deletions
This file was deleted.

docs/concepts/project.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Internally, Ory Cloud Projects run our popular open source projects in a multi-t
1010
low-latency, and reliable way. Ory Cloud Projects include additional services (such as dashboards, endpoint security, SLAs, ...)
1111
which aren't available in the open source.
1212

13-
For a step-by-step guide please visit the [Create Ory Cloud Project](../guides/console/create-project.mdx) document.
14-
1513
## Project Services
1614

1715
Each Ory Cloud Project consists of the following services :

docs/concepts/redirects.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@ id: redirects
33
title: Browser Redirects and Flow Completion
44
---
55

6-
This document covers browser redirects for Server Side Applications (NodeJs, PHP, Golang etc.) and how to configure them. To learn
7-
more about the SDK for Single Page Applications, check out the [SDK](./services-api.mdx) documentation.
6+
This document covers browser redirects for Server Side Applications (NodeJs, PHP, Golang etc.) and how to configure them.
87

98
## Allow List
109

11-
Set dynamic redirects using the `?return_to=` query parameter on [Self-Service Flows](./self-service.mdx). For example: a user
10+
Set dynamic redirects using the `?return_to=` query parameter on self-service flows. For example: a user
1211
opens a sharable link to go to `https://myapp.com/posts`. This URL requires the user to have an active session and redirects the
1312
user back to the login page. To return the user back to the original URL, append `?return_to=https://myapp.com/posts` when
1413
starting the [self-service login flow](https://www.ory.sh/docs/reference/api#operation/initializeSelfServiceLoginFlowForBrowsers):
@@ -34,7 +33,7 @@ Ory Cloud has a total of six flows, **Login**, **Registration**, **Verification*
3433
can be configured to redirect back to any URL. A common use case would be to redirect the user to your application home screen
3534
after a logout or to a specific URL on a sub-domain after a settings password update.
3635

37-
On project creation the redirect flows are set to the default [Managed User Interface](./managed-ui.mdx).
36+
On project creation the redirect flows are set to the default Managed User Interface.
3837

3938
### Login, Registration, and Settings
4039

@@ -123,7 +122,7 @@ Default Redirect URL can be an FQDN or a path.
123122

124123
Update or delete a redirect by either changing the current redirects value or deleting the entry and clicking the **Update**
125124
button. Reset all flows at once with the **Reset Flows** button which will prompt a confirmation box. Resetting all flows will
126-
reset all the fields back to the default value which is the Ory Cloud [Managed User Interface](./managed-ui.mdx).
125+
reset all the fields back to the default value which is the Ory Cloud Managed User Interface.
127126

128127
Updates to flows will take effect on **new** flows. It will have no effect on old flows that haven't expired yet.
129128

docs/concepts/self-service.mdx

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/concepts/services-api.mdx

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/concepts/terminology.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ section of your Ory Cloud Console.
3131

3232
#### Identity Schema
3333

34-
The JSON Schema that defines an identity in an Ory Cloud Project. Learn more about [Identity Schemas](./identity.mdx).
34+
The JSON Schema that defines an identity in an Ory Cloud Project.
3535

3636
#### Ory Login Session
3737

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Before you start make sure to either
22

3-
1. have a running [Ory Cloud Project](../console/create-project.mdx);
3+
1. have a running Ory Cloud Project
44
2. or are running Ory's Identity service (Ory Kratos) on your machine.

docs/guides/bring-your-user-interface.mdx

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,6 @@ other screens implemented yet? Your configuration would look as follows:
2121

2222
![Customize UI Endpoints in the Ory Cloud Console](_static/bring-your-user-interface/login-ui.png)
2323

24-
:::note
25-
26-
If you are unsure how to set up your Ory Cloud Project to be connected to your domain (such as `example.org`), head over to
27-
[Get Ready for Production](../start-building/deploy-auth-production.mdx).
28-
29-
:::
30-
3124
All other flows (registration, settings, verification, recovery, error) would still use Ory Cloud's managed UI!
3225

3326
## Reference Implementations and Guided Examples

0 commit comments

Comments
 (0)