Add api/v1/status/ endpoints and api/v1/sso/callback endpoint to REST API docs (#671)

This PR concludes the Complete API documentation project #43

Add documentation for the following endpoints:
- api/v1/status/live_query
- api/v1/status/result_store
- api/v1/sso/callback
This commit is contained in:
noahtalerman 2021-04-29 10:45:43 -04:00 committed by GitHub
parent 9a6235d38e
commit dbfbde37b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -63,6 +63,7 @@ All of these objects are put together and distributed to the appropriate osquery
- [Me](#me)
- [SSO config](#sso-config)
- [Initiate SSO](#initiate-sso)
- [SSO callback](#sso-callback)
All API requests to the Fleet server require API token authentication unless noted in the documentation.
@ -436,6 +437,38 @@ Gets the current SSO configuration.
}
```
### SSO callback
This is the callback endpoint that the identity provider will use to send security assertions to Fleet. This is where Fleet receives and processes the response from the identify provider.
`POST /api/v1/fleet/sso/callback`
#### Parameters
| Name | Type | In | Description |
| --------- | ------ | ---- | -------------------------------------------------------------------------- |
| SAMLResponse | string | body | **Required**. The SAML response from the identity provider. |
#### Example
`POST /api/v1/fleet/sso/callback`
##### Request body
```
{
"SAMLResponse": "<SAML response from IdP>"
}
```
##### Default response
`Status: 200`
```
{}
```
---
## Hosts
@ -1914,6 +1947,8 @@ Deletes the session specified by ID. When the user associated with the session n
- [Get queries specs](#get-queries-specs)
- [Get query spec](#get-query-spec)
- [Apply queries specs](#apply-queries-specs)
- [Check live query status](#check-live-query-status)
- [Check result store status](#check-result-store-status)
- [Run live query](#run-live-query)
- [Run live query by name](#run-live-query-by-name)
- [Retrieve live query results (standard WebSocket API)](#retrieve-live-query-results-standard-websocket-api)
@ -2367,6 +2402,50 @@ Creates and/or modifies the queries included in the specs list. To modify an exi
{}
```
### Check live query status
Checks the status of the Fleet's ability to run a live query. If an error is present in the response, Fleet won't be able to successfully run a live query. This endpoint is used by the Fleet UI to make sure that the Fleet instance is correctly configured to run live queries.
`GET /api/v1/fleet/status/live_query`
#### Parameters
None.
#### Example
`GET /api/v1/fleet/status/live_query`
##### Default response
`Status: 200`
```
{}
```
### Check result store status
Checks the status of the Fleet's result store. If an error is present in the response, Fleet won't be able to successfully run a live query. This endpoint is used by the Fleet UI to make sure that the Fleet instance is correctly configured to run live queries.
`GET /api/v1/fleet/status/result_store`
#### Parameters
None.
#### Example
`GET /api/v1/fleet/status/result_store`
##### Default response
`Status: 200`
```
{}
```
### Run live query
Runs the specified query as a live query on the specified hosts or group of hosts. Returns a new live query campaign. Individual hosts must be specified with the host's ID. Groups of hosts are specified by label ID.