You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@drill.apache.org by dz...@apache.org on 2021/09/01 06:15:25 UTC

[drill-site] branch master updated: Add a section for HTTP API credentials provider

This is an automated email from the ASF dual-hosted git repository.

dzamo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/drill-site.git


The following commit(s) were added to refs/heads/master by this push:
     new b33da42  Add a section for HTTP API credentials provider
     new 197d3a8  Merge pull request #6 from vvysotskyi/http-credentials-provider
b33da42 is described below

commit b33da42e9bc7afb0ea34b15ca523764c6f9915d2
Author: Volodymyr Vysotskyi <vv...@gmail.com>
AuthorDate: Tue Aug 31 21:48:29 2021 +0300

    Add a section for HTTP API credentials provider
---
 .../plugins/125-http-storage-plugin.md             | 24 ++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/_docs/en/connect-a-data-source/plugins/125-http-storage-plugin.md b/_docs/en/connect-a-data-source/plugins/125-http-storage-plugin.md
index f49fd7c..22f143b 100644
--- a/_docs/en/connect-a-data-source/plugins/125-http-storage-plugin.md
+++ b/_docs/en/connect-a-data-source/plugins/125-http-storage-plugin.md
@@ -197,6 +197,30 @@ feature if the API is strict about parameter ordering.
 At present Drill does not enforce that parameters are provided in the query: Drill
 assumes parameters are optional.
 
+#### API connection credentials provider
+
+Starting from Drill 1.20.0, it is possible to use [Credentials Provider](https://github.com/apache/drill/blob/master/docs/dev/PluginCredentialsProvider.md#plugin-credentials-provider) for specifying
+API connection credentials.
+
+`credentialsProvider` property should be used to configure credentials provider, similar to the way
+how it is used for storage plugins:
+
+```json
+{
+   "credentialsProvider": {
+      "credentialsProviderType": "PlainCredentialsProvider",
+      "credentials": {
+         "username": "user1",
+         "password": "user1Pass"
+      }
+   }
+}
+```
+
+It is possible to use any available credential provider type for API connections, including custom implementations.
+Please refer to [Developer notes](https://github.com/apache/drill/blob/master/docs/dev/PluginCredentialsProvider.md#developer-notes)
+for more details for creating custom credential provider implementations without changing Drill's code.
+
 ### Data Path
 
 REST responses often have structure beyond the data you want to query. For example: