Skip to content

Commit

Permalink
Add docs on where to get the API token (#14633)
Browse files Browse the repository at this point in the history
  • Loading branch information
harshach authored Jan 9, 2024
1 parent dbd9f13 commit 182a19f
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 1 deletion.
19 changes: 19 additions & 0 deletions openmetadata-docs/content/v1.2.x/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
29 changes: 28 additions & 1 deletion openmetadata-docs/content/v1.3.x-SNAPSHOT/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added openmetadata-docs/images/apis/bots/bots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 182a19f

Please sign in to comment.