empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 08:55:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update 3-REST-API.md (#1052)

Browse Source
This commit is contained in:
Mike McNeil 2021-06-10 12:54:12 -05:00 committed by GitHub
parent 2ae4002935
commit fccc58536b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/1-Using-Fleet/3-REST-API.md
View File

@ -64,28 +64,9 @@ All of these objects are put together and distributed to the appropriate osquery
- [Initiate SSO](#initiate-sso)
- [SSO callback](#sso-callback)
All API requests to the Fleet server require API token authentication unless noted in the documentation.
All API requests to the Fleet server require API token authentication unless noted in the documentation. API tokens are tied to your Fleet user account.
To get an API token, send a request to the [login endpoint](#log-in):
```
{
"token": "<your token>",
"user": {
"created_at": "2020-11-13T22:57:12Z",
"updated_at": "2020-11-13T22:57:12Z",
"id": 1,
"username": "jane",
"name": "",
"email": "janedoe@example.com",
"admin": true,
"enabled": true,
"force_password_reset": false,
"gravatar_url": "",
"sso_enabled": false
}
}
```
To get an API token, retrieve it from the "Account settings" > "Get API token" in the Fleet UI (`/profile`). Or, you can send a request to the [login API endpoint](#log-in) to get your token.
Then, use that API token to authenticate all subsequent API requests by sending it in the "Authorization" request header, prefixed with "Bearer ":
@ -93,7 +74,6 @@ Then, use that API token to authenticate all subsequent API requests by sending
Authorization: Bearer <your token>
```
> For SSO users, username/password login is disabled. The API token can instead be retrieved from the "Account settings" page in the UI (/profile). Choose "Get API token".
### Log in
@ -101,6 +81,8 @@ Authenticates the user with the specified credentials. Use the token returned fr
`POST /api/v1/fleet/login`
> This API endpoint is not available to SSO users, since username/password login is disabled for SSO users. To get an API token for an SSO user, you can use the Fleet UI.
#### Parameters
| Name | Type | In | Description |