Jack Baldry
cee5c1ca02
* Use relative aliases for all non-current Grafana aliases Prevents non-latest documentation "stealing" the page away from latest and through permanent redirects for latest pages that no longer exist. The redirected pages are indexed by search engines but our robots.txt forbids them crawling the non-latest page. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Remove all current page aliases find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \; find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/latest/[^\n]*\n#\n#' {} \; find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \; Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
344 lines
7.4 KiB
Markdown
344 lines
7.4 KiB
Markdown
---
|
|
aliases:
|
|
- ../../http_api/serviceaccount/
|
|
description: Grafana service account HTTP API
|
|
keywords:
|
|
- grafana
|
|
- http
|
|
- documentation
|
|
- api
|
|
- serviceaccount
|
|
title: Service account HTTP API
|
|
---
|
|
|
|
# Service account API
|
|
|
|
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/" >}}) for more information.
|
|
|
|
## Search service accounts with Paging
|
|
|
|
`GET /api/serviceaccounts/search?perpage=10&page=1&query=myserviceaccount`
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| -------------------- | ------------------------- |
|
|
| serviceaccounts:read | global:serviceaccounts:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
GET /api/serviceaccounts/search?perpage=10&page=1&query=mygraf HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Basic YWRtaW46YWRtaW4=
|
|
```
|
|
|
|
Default value for the `perpage` parameter is `1000` and for the `page` parameter is `1`. The `totalCount` field in the response can be used for pagination of the user list E.g. if `totalCount` is equal to 100 users and the `perpage` parameter is set to 10 then there are 10 pages of users. The `query` parameter is optional and it will return results where the query value is contained in one of the `name`. Query values with spaces need to be URL encoded e.g. `query=Jane%20Doe`.
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
{
|
|
"totalCount": 2,
|
|
"serviceAccounts": [
|
|
{
|
|
"id": 1,
|
|
"name": "grafana",
|
|
"login": "sa-grafana",
|
|
"orgId": 1,
|
|
"isDisabled": false,
|
|
"role": "Viewer",
|
|
"tokens": 0,
|
|
"avatarUrl": "/avatar/85ec38023d90823d3e5b43ef35646af9",
|
|
"accessControl": {
|
|
"serviceaccounts:delete": true,
|
|
"serviceaccounts:read": true,
|
|
"serviceaccounts:write": true
|
|
}
|
|
},
|
|
{
|
|
"id": 2,
|
|
"name": "test",
|
|
"login": "sa-test",
|
|
"orgId": 1,
|
|
"isDisabled": false,
|
|
"role": "Viewer",
|
|
"tokens": 0,
|
|
"avatarUrl": "/avatar/8ea890a677d6a223c591a1beea6ea9d2",
|
|
"accessControl": {
|
|
"serviceaccounts:delete": true,
|
|
"serviceaccounts:read": true,
|
|
"serviceaccounts:write": true
|
|
}
|
|
}
|
|
],
|
|
"page": 1,
|
|
"perPage": 10
|
|
}
|
|
```
|
|
|
|
## Create service account
|
|
|
|
`POST /api/serviceaccounts`
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| --------------------- | ------------------ |
|
|
| serviceaccounts:write | serviceaccounts:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
POST /api/serviceaccounts HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Basic YWRtaW46YWRtaW4=
|
|
|
|
{
|
|
"name": "grafana",
|
|
"role": "Admin",
|
|
}
|
|
```
|
|
|
|
Requires basic authentication and that the authenticated user is a Grafana Admin.
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
{
|
|
"id": 1,
|
|
"name": "test",
|
|
"login": "sa-test",
|
|
"orgId": 1,
|
|
"isDisabled": false,
|
|
"createdAt": "2022-03-21T14:35:33Z",
|
|
"updatedAt": "2022-03-21T14:35:33Z",
|
|
"avatarUrl": "/avatar/8ea890a677d6a223c591a1beea6ea9d2",
|
|
"role": "Viewer",
|
|
"teams": []
|
|
}
|
|
```
|
|
|
|
## Get single serviceaccount by Id
|
|
|
|
`GET /api/serviceaccounts/:id`
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| -------------------- | ------------------ |
|
|
| serviceaccounts:read | serviceaccounts:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
GET /api/serviceaccounts/1 HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Basic YWRtaW46YWRtaW4=
|
|
```
|
|
|
|
Requires basic authentication and that the authenticated user is a Grafana Admin.
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
{
|
|
"id": 1,
|
|
"name": "test",
|
|
"login": "sa-test",
|
|
"orgId": 1,
|
|
"isDisabled": false,
|
|
"createdAt": "2022-03-21T14:35:33Z",
|
|
"updatedAt": "2022-03-21T14:35:33Z",
|
|
"avatarUrl": "/avatar/8ea890a677d6a223c591a1beea6ea9d2",
|
|
"role": "Viewer",
|
|
"teams": []
|
|
}
|
|
```
|
|
|
|
## Update service account
|
|
|
|
`PATCH /api/serviceaccounts/:id`
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| --------------------- | ------------------ |
|
|
| serviceaccounts:write | serviceaccounts:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
PUT /api/serviceaccounts/2 HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Basic YWRtaW46YWRtaW4=
|
|
|
|
{
|
|
"name": "test",
|
|
"role": "Editor"
|
|
}
|
|
```
|
|
|
|
Requires basic authentication and that the authenticated user is a Grafana Admin.
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
{
|
|
"id": 2,
|
|
"name": "test",
|
|
"login": "sa-grafana",
|
|
"orgId": 1,
|
|
"isDisabled": false,
|
|
"createdAt": "2022-03-21T14:35:44Z",
|
|
"updatedAt": "2022-03-21T14:35:44Z",
|
|
"avatarUrl": "/avatar/8ea890a677d6a223c591a1beea6ea9d2",
|
|
"role": "Editor",
|
|
"teams": []
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Service account tokens
|
|
|
|
## Get service account tokens
|
|
|
|
`GET /api/serviceaccounts/:id/tokens`
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| -------------------- | ------------------ |
|
|
| serviceaccounts:read | serviceaccounts:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
GET /api/serviceaccounts/2/tokens HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Basic YWRtaW46YWRtaW4=
|
|
```
|
|
|
|
Requires basic authentication and that the authenticated user is a Grafana Admin.
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
[
|
|
{
|
|
"id": 1,
|
|
"name": "grafana",
|
|
"role": "Viewer",
|
|
"created": "2022-03-23T10:31:02Z",
|
|
"expiration": null,
|
|
"secondsUntilExpiration": 0,
|
|
"hasExpired": false
|
|
}
|
|
]
|
|
```
|
|
|
|
## Create service account tokens
|
|
|
|
`POST /api/serviceaccounts/:id/tokens`
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| --------------------- | ------------------ |
|
|
| serviceaccounts:write | serviceaccounts:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
POST /api/serviceaccounts/2/tokens HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Basic YWRtaW46YWRtaW4=
|
|
|
|
{
|
|
"name": "grafana",
|
|
"role": "Viewer"
|
|
}
|
|
```
|
|
|
|
Requires basic authentication and that the authenticated user is a Grafana Admin.
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
{
|
|
"id": 7,
|
|
"name": "grafana",
|
|
"key": "eyJrIjoiVjFxTHZ6dGdPSjg5Um92MjN1RlhjMkNqYkZUbm9jYkwiLCJuIjoiZ3JhZmFuYSIsImlkIjoxfQ=="
|
|
}
|
|
```
|
|
|
|
## Delete service account tokens
|
|
|
|
`DELETE /api/serviceaccounts/:id/tokens/:tokenId`
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| --------------------- | ------------------ |
|
|
| serviceaccounts:write | serviceaccounts:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
DELETE /api/serviceaccounts/2/tokens/1 HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Basic YWRtaW46YWRtaW4=
|
|
```
|
|
|
|
Requires basic authentication and that the authenticated user is a Grafana Admin.
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
{
|
|
"message": "API key deleted"
|
|
}
|
|
```
|