IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Document plugin authentication in metadata schema (#32703)

Browse Source 
* Update plugin schema

* Fix review comments
This commit is contained in:
Marcus Olsson
2021-04-08 18:13:18 +02:00
committed by GitHub
parent 7a2ab93e7a
commit f345459441
3 changed files with 52 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/sources/developers/plugins/metadata.md
View File

@@ -197,23 +197,24 @@ For data source plugins. Token authentication section used with an JWT OAuth API
#### Properties #### Properties
| Property | Type | Required | Description | | Property | Type | Required | Description |
|----------|-------------------|----------|---------------------------------------------------------------------------| |----------|-------------------|----------|------------------------------------------------------|
| `params` | [object](#params) | No | For data source plugins. Parameters for the token authentication request. | | `params` | [object](#params) | No | Parameters for the JWT token authentication request. |
| `url` | string | No | For data source plugins. URL to fetch the JWT token. | | `scopes` | string | No | |
| `url` | string | No | URL to fetch the JWT token. |
#### params #### params
For data source plugins. Parameters for the token authentication request. Parameters for the JWT token authentication request.
##### Properties ##### Properties
| Property | Type | Required | Description | | Property | Type | Required | Description |
|-----------------|--------|----------|--------------------------------------------------------------------------------------------------------------------| |----------------|----------|----------|-------------|
| `client_id` | string | No | For data source plugins. OAuth client id. | | `client_email` | string | No | |
| `client_secret` | string | No | For data source plugins. OAuth client secret. Usually populated by decrypting the secret from the SecureJson blob. | | `private_key` | string | No | |
| `grant_type` | string | No | For data source plugins. OAuth grant type. | | `scopes` | string[] | No | |
| `resource` | string | No | For data source plugins. OAuth resource. | | `token_uri` | string | No | |
### tokenAuth ### tokenAuth
@@ -221,22 +222,23 @@ For data source plugins. Token authentication section used with an OAuth API.
#### Properties #### Properties
| Property | Type | Required | Description | | Property | Type | Required | Description |
|----------|-------------------|----------|---------------------------------------------------------------------------| |----------|-------------------|----------|--------------------------------------------------|
| `params` | [object](#params) | No | For data source plugins. Parameters for the token authentication request. | | `params` | [object](#params) | No | Parameters for the token authentication request. |
| `url` | string | No | For data source plugins. URL to fetch the authentication token. | | `scopes` | string | No | |
| `url` | string | No | URL to fetch the authentication token. |
#### params #### params
For data source plugins. Parameters for the token authentication request. Parameters for the token authentication request.
##### Properties ##### Properties
| Property | Type | Required | Description | | Property | Type | Required | Description |
|-----------------|--------|----------|--------------------------------------------------------------------------------------------------------------------| |-----------------|--------|----------|-------------------------------------------------------------------------------------------|
| `client_id` | string | No | For data source plugins. OAuth client id. | | `client_id` | string | No | OAuth client ID |
| `client_secret` | string | No | For data source plugins. OAuth client secret. Usually populated by decrypting the secret from the SecureJson blob. | | `client_secret` | string | No | OAuth client secret. Usually populated by decrypting the secret from the SecureJson blob. |
| `grant_type` | string | No | For data source plugins. OAuth grant type. | | `grant_type` | string | No | OAuth grant type |
| `resource` | string | No | For data source plugins. OAuth resource. | | `resource` | string | No | OAuth resource |

45
docs/sources/developers/plugins/plugin.schema.json
View File

@@ -361,28 +361,32 @@
"properties": { "properties": {
"url": { "url": {
"type": "string", "type": "string",
"description": "For data source plugins. URL to fetch the authentication token." "description": "URL to fetch the authentication token."
},
"scopes": {
"type": "string",
"description": ""
}, },
"params": { "params": {
"type": "object", "type": "object",
"description": "For data source plugins. Parameters for the token authentication request.", "description": "Parameters for the token authentication request.",
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"grant_type": { "grant_type": {
"type": "string", "type": "string",
"description": "For data source plugins. OAuth grant type." "description": "OAuth grant type"
}, },
"client_id": { "client_id": {
"type": "string", "type": "string",
"description": "For data source plugins. OAuth client id." "description": "OAuth client ID"
}, },
"client_secret": { "client_secret": {
"type": "string", "type": "string",
"description": "For data source plugins. OAuth client secret. Usually populated by decrypting the secret from the SecureJson blob." "description": "OAuth client secret. Usually populated by decrypting the secret from the SecureJson blob."
}, },
"resource": { "resource": {
"type": "string", "type": "string",
"description": "For data source plugins. OAuth resource." "description": "OAuth resource"
} }
} }
} }
@@ -395,29 +399,36 @@
"properties": { "properties": {
"url": { "url": {
"type": "string", "type": "string",
"description": "For data source plugins. URL to fetch the JWT token.", "description": "URL to fetch the JWT token.",
"format": "uri" "format": "uri"
}, },
"scopes": {
"type": "string",
"description": ""
},
"params": { "params": {
"type": "object", "type": "object",
"description": "For data source plugins. Parameters for the token authentication request.", "description": "Parameters for the JWT token authentication request.",
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"grant_type": { "scopes": {
"type": "string", "type": "array",
"description": "For data source plugins. OAuth grant type." "description": "",
"items": {
"type": "string"
}
}, },
"client_id": { "token_uri": {
"type": "string", "type": "string",
"description": "For data source plugins. OAuth client id." "description": ""
}, },
"client_secret": { "client_email": {
"type": "string", "type": "string",
"description": "For data source plugins. OAuth client secret. Usually populated by decrypting the secret from the SecureJson blob." "description": ""
}, },
"resource": { "private_key": {
"type": "string", "type": "string",
"description": "For data source plugins. OAuth resource." "description": ""
} }
} }
} }

0
metadata.md Normal file
View File