apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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

Browse Source 
* Update plugin schema

* Fix review comments
pull/32809/head
Marcus Olsson 4 years ago committed by GitHub
parent 7a2ab93e7a
commit f345459441
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 52 additions and 39 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 46
      docs/sources/developers/plugins/metadata.md
  2. 45
      docs/sources/developers/plugins/plugin.schema.json
  3. 0
      metadata.md

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

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

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

@ -361,28 +361,32 @@
"properties": {
"url": {
"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": {
"type": "object",
"description": "For data source plugins. Parameters for the token authentication request.",
"description": "Parameters for the token authentication request.",
"additionalProperties": false,
"properties": {
"grant_type": {
"type": "string",
"description": "For data source plugins. OAuth grant type."
"description": "OAuth grant type"
},
"client_id": {
"type": "string",
"description": "For data source plugins. OAuth client id."
"description": "OAuth client ID"
},
"client_secret": {
"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": {
"type": "string",
"description": "For data source plugins. OAuth resource."
"description": "OAuth resource"
}
}
}
@ -395,29 +399,36 @@
"properties": {
"url": {
"type": "string",
"description": "For data source plugins. URL to fetch the JWT token.",
"description": "URL to fetch the JWT token.",
"format": "uri"
},
"scopes": {
"type": "string",
"description": ""
},
"params": {
"type": "object",
"description": "For data source plugins. Parameters for the token authentication request.",
"description": "Parameters for the JWT token authentication request.",
"additionalProperties": false,
"properties": {
"grant_type": {
"type": "string",
"description": "For data source plugins. OAuth grant type."
"scopes": {
"type": "array",
"description": "",
"items": {
"type": "string"
}
},
"client_id": {
"token_uri": {
"type": "string",
"description": "For data source plugins. OAuth client id."
"description": ""
},
"client_secret": {
"client_email": {
"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",
"description": "For data source plugins. OAuth resource."
"description": ""
}
}
}

0
metadata.md
Unescape View File

Write Preview
Loading…
Cancel
Save