[v10.0.x] Docs: Update the service account HTTP API documentation (#69189)
Docs: Update the service account HTTP API documentation (#63235)
* doc: Add the service account deletion function
* doc: Add new service account documentation
(cherry picked from commit 4aa207ed83)
Co-authored-by: Pascal Zimmermann <pascal.zimmermann@theiotstudio.com>
This commit is contained in:
co-authored by
Pascal Zimmermann
parent
a94a5bcf10
commit
2b9e4b0c15
@@ -217,8 +217,168 @@ Content-Type: application/json
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Delete service account
|
||||||
|
|
||||||
|
`DELETE /api/serviceaccounts/:id`
|
||||||
|
|
||||||
|
**Required permissions**
|
||||||
|
|
||||||
|
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
|
||||||
|
|
||||||
|
| Action | Scope |
|
||||||
|
| ---------------------- | --------------------- |
|
||||||
|
| serviceaccounts:delete | serviceaccounts:id:\* |
|
||||||
|
|
||||||
|
**Example Request**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
DELETE /api/serviceaccounts/2 HTTP/1.1
|
||||||
|
Accept: application/json
|
||||||
|
Content-Type: application/json
|
||||||
|
Authorization: Basic YWRtaW46YWRtaW4=
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example Response**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
HTTP/1.1 200
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"message": "Service account deleted"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Migrate API keys to service accounts
|
||||||
|
|
||||||
|
`POST /api/serviceaccounts/migrate`
|
||||||
|
|
||||||
|
**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/migrate HTTP/1.1
|
||||||
|
Accept: application/json
|
||||||
|
Content-Type: application/json
|
||||||
|
Authorization: Basic YWRtaW46YWRtaW4=
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example Response**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
HTTP/1.1 200
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"message": "API keys migrated to service accounts"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Migrate API key to service account
|
||||||
|
|
||||||
|
`POST /api/serviceaccounts/migrate/:keyId`
|
||||||
|
|
||||||
|
**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/migrate/4 HTTP/1.1
|
||||||
|
Accept: application/json
|
||||||
|
Content-Type: application/json
|
||||||
|
Authorization: Basic YWRtaW46YWRtaW4=
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example Response**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
HTTP/1.1 200
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"message": "Service accounts migrated"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"migrated": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
{
|
||||||
|
"message": "API keys hidden"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Get service account tokens
|
## Get service account tokens
|
||||||
|
|
||||||
`GET /api/serviceaccounts/:id/tokens`
|
`GET /api/serviceaccounts/:id/tokens`
|
||||||
|
|||||||
Reference in New Issue
Block a user