Skip to content

Commit c5599f3

Browse files
authored
docs: update API authorization docs (#1717)
1 parent 1447dcb commit c5599f3

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

docs/concepts/personal-access-token.mdx

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,30 @@ title: Authorization with API Keys
44
sidebar_label: Authorization
55
---
66

7-
# Authorization with API Keys
7+
# Ory Network API Authorization
88

9-
API Keys are used to authorize privileged operations. For example, you must use an API Key to call the Admin API, which allows you
10-
to delete users.
9+
**Ory Network Project APIs** are separated into:
10+
11+
- **Ory Network Frontend APIs** are used to interact with Ory Network projects, such as register users or checking login state.
12+
- **Ory Network Admin APIs** are used to perform privileged operations on Ory Network projects, such as deleting users or creating
13+
permissions.
14+
15+
**Ory Network Management APIs** are used to manage Ory Network projects, such as creating a new project or changing settings.
16+
17+
## Authorizing Ory Network Project Frontend APIs
18+
19+
Frontend APIs are used to interact with Ory Network projects from your frontend application and do not require any special
20+
authorization.
21+
22+
## Authorizing Ory Network Project Admin APIs
23+
24+
API Keys are used to authorize privileged operations to Ory Network Project Admin APIs. For example, you must use an API Key to
25+
call the Admin API, which allows you to delete users.
1126

1227
API Keys work only in the context of the Project for which they were created. You create API Keys in the
1328
[Ory Console](https://console.ory.sh/).
1429

15-
## Creating API Keys
30+
### Creating API Keys
1631

1732
Follow these steps to create API Keys for your Project:
1833

@@ -33,7 +48,7 @@ secure and rotate them if necessary.
3348

3449
:::
3550

36-
## Usage
51+
### Usage
3752

3853
Use the API Key in API calls, SDK calls, or command-line interactions. Ory API Keys have a `ory_apikey_` or `ory_pat_`, which
3954
makes it easy to identify them when analyzing code.
@@ -47,3 +62,9 @@ Accept: application/json
4762
# highlight-next-line
4863
Authorization: Bearer {API-Key}
4964
```
65+
66+
## Authorizing Ory Network Management APIs
67+
68+
Ory Network Management APIs are used to manage Ory Network projects, such as creating a new project or changing settings. At this
69+
time the only way to authorize Management APIs is by using a session cookie issued to you by the Ory Network Console. Please reach
70+
out to your [support representative](https://console.ory.sh/support) if you need help with this process.

src/pages/http-api.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33

44
import React from "react"
55
import ApiDoc from "@theme/ApiDoc"
6-
import useBaseUrl from "@docusaurus/useBaseUrl"
76
import useSpecData from "@theme/useSpecData"
87

98
function CustomPage() {

0 commit comments

Comments
 (0)