diff --git a/openmetadata-docs/content/v1.2.x/sdk/index.md b/openmetadata-docs/content/v1.2.x/sdk/index.md index 618f75b7656..4fbef6e9a6a 100644 --- a/openmetadata-docs/content/v1.2.x/sdk/index.md +++ b/openmetadata-docs/content/v1.2.x/sdk/index.md @@ -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: diff --git a/openmetadata-docs/content/v1.3.x-SNAPSHOT/sdk/index.md b/openmetadata-docs/content/v1.3.x-SNAPSHOT/sdk/index.md index 618f75b7656..9b857adb2ba 100644 --- a/openmetadata-docs/content/v1.3.x-SNAPSHOT/sdk/index.md +++ b/openmetadata-docs/content/v1.3.x-SNAPSHOT/sdk/index.md @@ -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 %} \ No newline at end of file +{% /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. + + diff --git a/openmetadata-docs/images/apis/bots/bots-token.png b/openmetadata-docs/images/apis/bots/bots-token.png new file mode 100644 index 00000000000..fafdb5b25fd Binary files /dev/null and b/openmetadata-docs/images/apis/bots/bots-token.png differ diff --git a/openmetadata-docs/images/apis/bots/bots.png b/openmetadata-docs/images/apis/bots/bots.png new file mode 100644 index 00000000000..9fc8924af56 Binary files /dev/null and b/openmetadata-docs/images/apis/bots/bots.png differ diff --git a/openmetadata-docs/images/apis/users/user-profile-access-token.png b/openmetadata-docs/images/apis/users/user-profile-access-token.png new file mode 100644 index 00000000000..6eb26914d7e Binary files /dev/null and b/openmetadata-docs/images/apis/users/user-profile-access-token.png differ diff --git a/openmetadata-docs/images/apis/users/user-profile-page.png b/openmetadata-docs/images/apis/users/user-profile-page.png new file mode 100644 index 00000000000..44630e855a9 Binary files /dev/null and b/openmetadata-docs/images/apis/users/user-profile-page.png differ