Add docs on where to get the API token (#14633)

This commit is contained in:
Sriharsha Chintalapani 2024-01-09 07:55:40 -08:00 committed by GitHub
parent dbd9f1381a
commit 182a19f3cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 47 additions and 1 deletions

View File

@ -3,6 +3,25 @@ title: OpenMetadata SDK
slug: /sdk
---
# OpenMetadata API
To access OpenMetadata APIs, one needs a token to authenticate and authorize API calls.
## How to get the JWT Token
### Bot Token
1. Go to the settings page from the navbar and then scroll down to the Integrations Section. Click on the Bots and you will see the list of bots, then click on the ingestion-bot. {% image src="/images/v1.2/cli-ingestion-with-basic-auth/bot-list.png" alt="bot-list" /%}
2. You will be redirected to the ingestion-bot details page. there you will get the JWT token, click on the copy button and copy the JWT token. {% image src="/images/v1.2/cli-ingestion-with-basic-auth/bot-token.png" alt="bot-token" /%}
3. Optionally, You can create your own bot for specific use case.
Alright, now you have the JWT token, let see how to add that into the workflow config.
# OpenMetadata SDK
Here are the articles in this section:

View File

@ -22,4 +22,31 @@ Here are the articles in this section:
href="/sdk/java" %}
Provision, manage, and use OpenMetadata resources directly from your Java applications.
{% /inlineCallout %}
{% /inlineCalloutContainer %}
{% /inlineCalloutContainer %}
# OpenMetadata API
To access OpenMetadata APIs, one needs a token to authenticate and authorize API calls.
## How to get the JWT Token
### Bot Token
1. Go to the settings page from the navbar and then scroll down to the Integrations Section. Click on the Bots and you will see the list of bots, then click on the ingestion-bot. {% image src="/images/apis/bots/bots.png" alt="bot-list" /%}
2. You will be redirected to the ingestion-bot details page. there you will get the JWT token, click on the copy button and copy the JWT token. {% image src="/images/apis/bots/bot-token.png" alt="bot-token" /%}
3. Optionally, You can create your own bot for specific use case.
### User Token
1. From 1.3.0 release onwards, we support User's personal access token
2. Go to logged in user profile by clicking on User's profile image on top right corner. {% image src="/images/apis/users/user-profile-page.png" alt="user-profile" /%}
3. Click on Access Token tab, Generate a New token. {% image src="/images/apis/users/user-profile-access-token.png" alt="user-profile" /%}
Alright, now you have the JWT token to use it with the SDKs below.

Binary file not shown.

After

Width:  |  Height:  |  Size: 261 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 361 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 398 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 708 KiB