@@ -3,29 +3,35 @@ id: personal-access-token
3
3
title : Personal Access Tokens
4
4
---
5
5
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.
7
9
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.
12
14
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
15
16
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.
19
19
20
20
:::
21
21
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):
23
25
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
27
34
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.
29
36
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
+ :::
0 commit comments