mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 05:51:51 +08:00
Docs: Update the service account HTTP API documentation (#63235)
* doc: Add the service account deletion function * doc: Add new service account documentation
This commit is contained in:

committed by
GitHub

parent
6bd3d4bf61
commit
4aa207ed83
@ -217,8 +217,168 @@ Content-Type: application/json
|
|||||||
Authorization: Basic YWRtaW46YWRtaW4=
|
Authorization: Basic YWRtaW46YWRtaW4=
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Example Response**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
HTTP/1.1 200
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Get API key to service account migration status
|
||||||
|
|
||||||
|
`GET /api/serviceaccounts/migrationstatus`
|
||||||
|
|
||||||
|
**Required permissions**
|
||||||
|
|
||||||
|
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
||||||
|
|
||||||
|
| Action | Scope |
|
||||||
|
| -------------------- | ------------------ |
|
||||||
|
| serviceaccounts:read | serviceaccounts:\* |
|
||||||
|
|
||||||
|
**Example Request**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
POST /api/serviceaccounts/migrationstatus HTTP/1.1
|
||||||
|
Accept: application/json
|
||||||
|
Content-Type: application/json
|
||||||
|
Authorization: Basic YWRtaW46YWRtaW4=
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example Response**:
|
||||||
|
|
||||||
|
```http
|
||||||
HTTP/1.1 200
|
HTTP/1.1 200
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Hide the API keys tab
|
||||||
|
|
||||||
|
`GET /api/serviceaccounts/hideApiKeys`
|
||||||
|
|
||||||
|
**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/hideApiKeys HTTP/1.1
|
||||||
|
Accept: application/json
|
||||||
|
Content-Type: application/json
|
||||||
|
Authorization: Basic YWRtaW46YWRtaW4=
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example Response**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
HTTP/1.1 200
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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:id:\* |
|
||||||
|
|
||||||
|
**Example Request**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
GET /api/serviceaccounts/2/tokens HTTP/1.1
|
||||||
|
Accept: application/json
|
||||||
|
Content-Type: application/json
|
||||||
|
Authorization: Basic YWRtaW46YWRtaW4=
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example Response**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
HTTP/1.1 200
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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:id:\* |
|
||||||
|
|
||||||
|
**Example Request**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
POST /api/serviceaccounts/2/tokens HTTP/1.1
|
||||||
|
Accept: application/json
|
||||||
|
Content-Type: application/json
|
||||||
|
Authorization: Basic YWRtaW46YWRtaW4=
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example Response**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
HTTP/1.1 200
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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:id:\* |
|
||||||
|
|
||||||
|
**Example Request**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
DELETE /api/serviceaccounts/2/tokens/1 HTTP/1.1
|
||||||
|
Accept: application/json
|
||||||
|
Content-Type: application/json
|
||||||
|
Authorization: Basic YWRtaW46YWRtaW4=
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example Response**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
HTTP/1.1 200
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Revert service account token to API key
|
||||||
|
|
||||||
|
`DELETE /api/serviceaccounts/:serviceAccountId/revert/:keyId`
|
||||||
|
|
||||||
|
This operation will delete the service account and create a legacy API Key for the given `keyId`.
|
||||||
|
|
||||||
|
**Required permissions**
|
||||||
|
|
||||||
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
||||||
|
|
||||||
| Action | Scope |
|
| Action | Scope |
|
||||||
|
Reference in New Issue
Block a user