重要:这个文档是关于一个旧版本。有关只释放指出,许多特性和功能的更新或替换。请查看当前版本。

身份验证API

如果您正在运行Grafana企业,对于一些端点需要有相关权限。指基于角色的访问控制权限为更多的信息。

令牌

目前,您可以验证通过API的令牌或通过一个会话cookie(获得使用正则登录或OAuth)。

X-Grafana-Org-Id头

X-Grafana-Org-Id是一个可选属性,用于指定组织的行动。如果不设置,创建键属于当前上下文org。用这个头有关管理的所有请求除外。

示例请求:

POST HTTP / 1.1 / api /认证/键接受:application / json - type: application / json X-Grafana-Org-Id: 2授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk{“名称”:“mykey”,“角色”:“Admin”、“secondsToLive”: 86400}

基本认证

如果启用了基本认证(这是默认启用),那么你可以通过标准的基本认证验证你的HTTP请求。基本认证也将LDAP用户进行身份验证。

旋度的例子:

? curl http://admin: admin@localhost: 3000 / api / org {" id ": 1、“名称”:“主要组织。”}

创建API牌

打开sidemenu并单击组织下拉选择API密钥选择。

你使用的所有请求令牌授权头,像这样:

例子:

得到http://your.www.tubolov.com/api/dashboards/db/mydash HTTP / 1.1接受:application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

的授权头值应该是持票人< api键>。

API的令牌也可以作为一个基本的传递与特别授权密码用户名api_key:

旋度的例子:

? curl http://api_key: eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk@localhost: 3000 / api / org {" id ": 1、“名称”:“主要组织。”}

Auth HTTP资源/行动

Api密钥

GET / api /认证/钥匙

需要的权限

看到请注意介绍给一个解释。

行动	范围
apikey:阅读	apikey: *

示例请求:

得到HTTP / 1.1 / api /认证/键接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

查询参数:

• includeExpired:布尔。使清单过期的钥匙。可选的。

示例响应:

HTTP / 1.1 200 - type: application / json ({" id ": 3,“名字”:“API”,“角色”:“Admin”}, {" id ": 1、“名称”:“TestAdmin”、“角色”:“Admin”、“过期”:“2019 - 06 - 26 - t10:52:03 + 03:00 "})

创建API密钥

POST / api /认证/钥匙

需要的权限

看到请注意介绍给一个解释。

行动	范围
apikey:创建	n /一个

示例请求:

POST HTTP / 1.1 / api /认证/键接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk{“名称”:“mykey”,“角色”:“Admin”、“secondsToLive”: 86400}

JSON身体模式:

• 的名字——关键的名字
• 角色-设置访问级别/ Grafana作用的关键。可以是下列值之一:查看器,编辑器或管理。
• secondsToLive——设置关键过期在几秒钟内。它是可选的。如果它是一个正数的过期日期设置是关键。如果是零,零个或完全省略(除非api_key_max_seconds_to_live配置选项设置)的关键将永远不会过期。

错误状态:

• 400年- - - - - -api_key_max_seconds_to_live但没有设置secondsToLive指定或secondsToLive大于这个值。
• 500年——关键是无法存储在数据库中。

示例响应:

HTTP / 1.1 200 - type: application / json{“名称”:“mykey”,“关键”:“eyJrIjoiWHZiSWd3NzdCYUZnNUtibE9obUpESmE3bzJYNDRIc0UiLCJuIjoibXlrZXkiLCJpZCI6MX1 = ", " id ": 1}

删除API密匙

删除/ api /认证/键/:id

需要的权限

看到请注意介绍给一个解释。

行动	范围
apikey:删除	apikey: *

示例请求:

删除/ api /认证/键/ 3 HTTP / 1.1接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应:

HTTP / 1.1 200 - type: application / json{“消息”:“API键删除”}