Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-23 08:58:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 111

Fix and clarify API auth documentation (#109)

Browse source 
- Fix header name.
- Add note about SSO auth.
This commit is contained in:
Zach Wasserman 2020-12-08 17:44:26 -08:00 committed by GitHub
parent 523d596c77
commit 30a0dfc1e1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/api/rest-endpoints.md
View file

@ -4,11 +4,11 @@
Making authenticated requests to the Fleet server requires that you are granted permission to access data. The Fleet Authentication API enables you to receive an authorization token.
All Fleet API requests are authenticated unless noted in the documentation. This means that almost all Fleet API requests will require sending the authentication token in the request header.
All Fleet API requests are authenticated unless noted in the documentation. This means that almost all Fleet API requests will require sending the auth token in the request header.
The typical steps to making an authenticated API request are outlined below.
First, utilize the `/login` endpoint to receive an authentication token.
First, utilize the `/login` endpoint to receive an authentication token. For SSO users, username/password login is disabled and the API token can be retrieved from the "Settings" page in the UI.
`POST /api/v1/kolide/login`
@ -51,9 +51,7 @@ Then, use the token returned from the `/login` endpoint to authenticate further
Request header
```
{
"authentication": "Bearer {your token}"
}
Authorization: Bearer <your token>
```
Default response