Skip to content
This repository was archived by the owner on Feb 16, 2026. It is now read-only.

Commit 2fb9187

Browse files
RounakDhillon“RounakPrajwal214Copilot
authored
Docs: Personal Access Token Doc Updation (#647)
* Docs: Personal Access Token Doc Updation * Update content/v1.12.x-SNAPSHOT/how-to-guides/user-guide-data-users/personal-access-token.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update content/v1.11.x/how-to-guides/user-guide-data-users/personal-access-token.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update content/v1.10.x/how-to-guides/user-guide-data-users/personal-access-token.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: “Rounak <“rounakpreet.d@deuexsolutions.com”> Co-authored-by: Prajwal214 <167504578+Prajwal214@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent bf0409e commit 2fb9187

File tree

21 files changed

+249
-0
lines changed

21 files changed

+249
-0
lines changed

‎content/v1.10.x/how-to-guides/user-guide-data-users/personal-access-token.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: How to Create a Personal Access Token | Official Documentation
3+
description: Create personal access tokens to authenticate API requests to OpenMetadata.
4+
slug: /how-to-guides/guide-for-data-users/personal-access-token
5+
---
6+
7+
# How to Create a Personal Access Token
8+
9+
Personal Access Tokens (PATs) in OpenMetadata let you authenticate and interact with the OpenMetadata API securely. Follow the steps below to generate a new personal access token.
10+
11+
## Prerequisites
12+
13+
- You have a valid OpenMetadata user account.
14+
- You have access to the OpenMetadata UI.
15+
16+
## Steps to Create a Personal Access Token
17+
18+
1. **Log in to the OpenMetadata UI**
19+
- Navigate to your OpenMetadata instance.
20+
- Enter your credentials to log in.
21+
22+
2. **Access your profile**
23+
- Click your profile icon in the top-right corner of the UI.
24+
- Select **View Profile** from the dropdown menu.
25+
26+
{% image
27+
src="/images/v1.10/how-to-guides/user-guide-for-data-stewards/access-token1.png"
28+
alt="Access your profile"
29+
caption="Access your profile"
30+
/%}
31+
32+
3. **Open the Access Tokens tab**
33+
- In your profile page, click the **Access Tokens** tab.
34+
35+
{% image
36+
src="/images/v1.10/how-to-guides/user-guide-for-data-stewards/access-token2.png"
37+
alt="Open the Access Tokens tab"
38+
caption="Open the Access Tokens tab"
39+
/%}
40+
41+
4. **Generate a new token**
42+
- Click **Generate New Token**.
43+
44+
{% image
45+
src="/images/v1.10/how-to-guides/user-guide-for-data-stewards/access-token3.png"
46+
alt="Generate a new token"
47+
caption="Generate a new token"
48+
/%}
49+
50+
5. **Set token expiration**
51+
- Choose an expiration period for the token. Available options typically include:
52+
- 1 hour
53+
- 1 day
54+
- 7 days
55+
- 30 days
56+
- 60 days
57+
58+
{% image
59+
src="/images/v1.10/how-to-guides/user-guide-for-data-stewards/access-token4.png"
60+
alt="Set token expiration"
61+
caption="Set token expiration"
62+
/%}
63+
64+
6. **Copy your token**
65+
- After generation, the personal access token is displayed.
66+
- You can revoke a token at any time by selecting `Revoke Token`.
67+
- Copy and securely store the token, as you will not be able to view it again later.
68+
69+
{% image
70+
src="/images/v1.10/how-to-guides/user-guide-for-data-stewards/access-token5.png"
71+
alt="Copy your token"
72+
caption="Copy your token"
73+
/%}
74+
75+
## Usage
76+
77+
Use the generated token to authenticate API requests to OpenMetadata. Include it in the Authorization header as follows:
78+
79+
```bash
80+
Authorization: Bearer <your_personal_access_token>
81+
```

‎content/v1.10.x/menu.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -951,6 +951,8 @@ site_menu:
951951
url: /how-to-guides/guide-for-data-users/follow-data-asset
952952
- category: How-to Guides / Guide for Data Users / How to Add Tags
953953
url: /how-to-guides/guide-for-data-users/tags
954+
- category: How-to Guides / Guide for Data Users / How to Create a Personal Access Token
955+
url: /how-to-guides/guide-for-data-users/personal-access-token
954956
- category: How-to Guides / Guide for Data Users / How to Request for Tags
955957
url: /how-to-guides/guide-for-data-users/request-tags
956958
- category: How-to Guides / Guide for Data Users / How to Add Glossary Terms

‎content/v1.11.x/how-to-guides/user-guide-data-users/personal-access-token.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: How to Create a Personal Access Token | Official Documentation
3+
description: Create personal access tokens to authenticate API requests to OpenMetadata.
4+
slug: /how-to-guides/guide-for-data-users/personal-access-token
5+
---
6+
7+
# How to Create a Personal Access Token
8+
9+
Personal Access Tokens (PATs) in OpenMetadata let you authenticate and interact with the OpenMetadata API securely. Follow the steps below to generate a new personal access token.
10+
11+
## Prerequisites
12+
13+
- You have a valid OpenMetadata user account.
14+
- You have access to the OpenMetadata UI.
15+
16+
## Steps to Create a Personal Access Token
17+
18+
1. **Log in to the OpenMetadata UI**
19+
- Navigate to your OpenMetadata instance.
20+
- Enter your credentials to log in.
21+
22+
2. **Access your profile**
23+
- Click your profile icon in the top-right corner of the UI.
24+
- Select **View Profile** from the dropdown menu.
25+
26+
{% image
27+
src="/images/v1.11/how-to-guides/user-guide-for-data-stewards/access-token1.png"
28+
alt="Access your profile"
29+
caption="Access your profile"
30+
/%}
31+
32+
3. **Open the Access Tokens tab**
33+
- In your profile page, click the **Access Tokens** tab.
34+
35+
{% image
36+
src="/images/v1.11/how-to-guides/user-guide-for-data-stewards/access-token2.png"
37+
alt="Open the Access Tokens tab"
38+
caption="Open the Access Tokens tab"
39+
/%}
40+
41+
4. **Generate a new token**
42+
- Click **Generate New Token**.
43+
44+
{% image
45+
src="/images/v1.11/how-to-guides/user-guide-for-data-stewards/access-token3.png"
46+
alt="Generate a new token"
47+
caption="Generate a new token"
48+
/%}
49+
50+
5. **Set token expiration**
51+
- Choose an expiration period for the token. Available options typically include:
52+
- 1 hour
53+
- 1 day
54+
- 7 days
55+
- 30 days
56+
- 60 days
57+
58+
{% image
59+
src="/images/v1.11/how-to-guides/user-guide-for-data-stewards/access-token4.png"
60+
alt="Set token expiration"
61+
caption="Set token expiration"
62+
/%}
63+
64+
6. **Copy your token**
65+
- After generation, the personal access token is displayed.
66+
- You can revoke a token at any time by selecting `Revoke Token`.
67+
- Copy and securely store the token, as you will not be able to view it again later.
68+
69+
{% image
70+
src="/images/v1.11/how-to-guides/user-guide-for-data-stewards/access-token5.png"
71+
alt="Copy your token"
72+
caption="Copy your token"
73+
/%}
74+
75+
## Usage
76+
77+
Use the generated token to authenticate API requests to OpenMetadata. Include it in the Authorization header as follows:
78+
79+
```bash
80+
Authorization: Bearer <your_personal_access_token>
81+
```

‎content/v1.11.x/menu.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -955,6 +955,8 @@ site_menu:
955955
url: /how-to-guides/guide-for-data-users/follow-data-asset
956956
- category: How-to Guides / Guide for Data Users / How to Add Tags
957957
url: /how-to-guides/guide-for-data-users/tags
958+
- category: How-to Guides / Guide for Data Users / How to Create a Personal Access Token
959+
url: /how-to-guides/guide-for-data-users/personal-access-token
958960
- category: How-to Guides / Guide for Data Users / How to Request for Tags
959961
url: /how-to-guides/guide-for-data-users/request-tags
960962
- category: How-to Guides / Guide for Data Users / How to Add Glossary Terms

‎content/v1.12.x-SNAPSHOT/how-to-guides/user-guide-data-users/personal-access-token.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: How to Create a Personal Access Token | Official Documentation
3+
description: Create personal access tokens to authenticate API requests to OpenMetadata.
4+
slug: /how-to-guides/guide-for-data-users/personal-access-token
5+
---
6+
7+
# How to Create a Personal Access Token
8+
9+
Personal Access Tokens (PATs) in OpenMetadata let you authenticate and interact with the OpenMetadata API securely. Follow the steps below to generate a new personal access token.
10+
11+
## Prerequisites
12+
13+
- You have a valid OpenMetadata user account.
14+
- You have access to the OpenMetadata UI.
15+
16+
## Steps to Create a Personal Access Token
17+
18+
1. **Log in to the OpenMetadata UI**
19+
- Navigate to your OpenMetadata instance.
20+
- Enter your credentials to log in.
21+
22+
2. **Access your profile**
23+
- Click your profile icon in the top-right corner of the UI.
24+
- Select **View Profile** from the dropdown menu.
25+
26+
{% image
27+
src="/images/v1.12/how-to-guides/user-guide-for-data-stewards/access-token1.png"
28+
alt="Access your profile"
29+
caption="Access your profile"
30+
/%}
31+
32+
3. **Open the Access Tokens tab**
33+
- In your profile page, click the **Access Tokens** tab.
34+
35+
{% image
36+
src="/images/v1.12/how-to-guides/user-guide-for-data-stewards/access-token2.png"
37+
alt="Open the Access Tokens tab"
38+
caption="Open the Access Tokens tab"
39+
/%}
40+
41+
4. **Generate a new token**
42+
- Click **Generate New Token**.
43+
44+
{% image
45+
src="/images/v1.12/how-to-guides/user-guide-for-data-stewards/access-token3.png"
46+
alt="Generate a new token"
47+
caption="Generate a new token"
48+
/%}
49+
50+
5. **Set token expiration**
51+
- Choose an expiration period for the token. Available options typically include:
52+
- 1 hour
53+
- 1 day
54+
- 7 days
55+
- 30 days
56+
- 60 days
57+
58+
{% image
59+
src="/images/v1.12/how-to-guides/user-guide-for-data-stewards/access-token4.png"
60+
alt="Set token expiration"
61+
caption="Set token expiration"
62+
/%}
63+
64+
6. **Copy your token**
65+
- After generation, the personal access token is displayed.
66+
- You can revoke a token at any time by selecting `Revoke Token`.
67+
- Copy and securely store the token, as you will not be able to view it again later.
68+
69+
{% image
70+
src="/images/v1.12/how-to-guides/user-guide-for-data-stewards/access-token5.png"
71+
alt="Copy your token"
72+
caption="Copy your token"
73+
/%}
74+
75+
## Usage
76+
77+
Use the generated token to authenticate API requests to OpenMetadata. Include it in the Authorization header as follows:
78+
79+
```bash
80+
Authorization: Bearer <your_personal_access_token>
81+
```

‎content/v1.12.x-SNAPSHOT/menu.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -955,6 +955,8 @@ site_menu:
955955
url: /how-to-guides/guide-for-data-users/follow-data-asset
956956
- category: How-to Guides / Guide for Data Users / How to Add Tags
957957
url: /how-to-guides/guide-for-data-users/tags
958+
- category: How-to Guides / Guide for Data Users / How to Create a Personal Access Token
959+
url: /how-to-guides/guide-for-data-users/personal-access-token
958960
- category: How-to Guides / Guide for Data Users / How to Request for Tags
959961
url: /how-to-guides/guide-for-data-users/request-tags
960962
- category: How-to Guides / Guide for Data Users / How to Add Glossary Terms

‎public/images/v1.10/how-to-guides/user-guide-for-data-stewards/access-token1.png‎

339 KB
Loading

‎public/images/v1.10/how-to-guides/user-guide-for-data-stewards/access-token2.png‎

174 KB
Loading

‎public/images/v1.10/how-to-guides/user-guide-for-data-stewards/access-token3.png‎

101 KB
Loading

‎public/images/v1.10/how-to-guides/user-guide-for-data-stewards/access-token4.png‎

101 KB
Loading

0 commit comments

Comments
 (0)