Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

Add missing sso 4.71.0 api change (#31656)

Browse Source 
We missed adding the API changes (new HTTP cookie added for security
hardening) for the SSO APIs in v4.71.0.

PS: Also took the chance at fixing a couple of typos.
This commit is contained in:
Lucas Manuel Rodriguez
2025-08-07 16:30:08 -05:00
committed by GitHub
parent 4b24d38abd
commit ca17e88db0
2 changed files with 50 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/REST API/rest-api.md
+28 -12
View File
@@ -406,6 +406,8 @@ Gets the current SSO configuration.
`POST /api/v1/fleet/sso`
A successful response contains an HTTP cookie `__Host-FLEETSSOSESSIONID` that needs to be sent on the `POST /api/v1/fleet/sso/callback` request (this HTTP cookie is used to identify the SSO login session).
#### Parameters
| Name | Type | In | Description |
@@ -428,6 +430,11 @@ Gets the current SSO configuration.
`Status: 200`
Example response cookie in the HTTP `Set-Cookie` header:
```
Set-Cookie: __Host-FLEETSSOSESSIONID=slI727JZ+j0FvyBRLyD/gri1rxtwpaZT; Path=/; Max-Age=300; HttpOnly; Secure
```
##### Unknown error
`Status: 500`
@@ -450,11 +457,15 @@ This is the callback endpoint that the identity provider will use to send securi
`POST /api/v1/fleet/sso/callback`
The `__Host-FLEETSSOSESSIONID` HTTP cookie must be set for non-IdP initiated SSO login requests. The value for this cookie is returned in the `POST /api/v1/fleet/sso` request.
For IdP-initiated SSO logins the cookie doesn't need to be set.
#### Parameters
| Name | Type | In | Description |
| ------------ | ------ | ---- | ----------------------------------------------------------- |
| SAMLResponse | string | body | **Required**. The SAML response from the identity provider. |
| Name | Type | In | Description |
| ------------------------ | ------ | ------ | ------------------------------------------------------------------------------------------------------------------- |
| SAMLResponse | string | body | **Required**. The SAML response from the identity provider. |
| __Host-FLEETSSOSESSIONID | string | cookie | HTTP Cookie returned in the `POST /api/v1/fleet/sso` request. This is not set/required for IdP initiated SSO logins |
#### Example
@@ -468,6 +479,11 @@ This is the callback endpoint that the identity provider will use to send securi
}
```
Example session cookie set in the `Cookie` request header:
```
Cookie: __Host-FLEETSSOSESSIONID=slI727JZ+j0FvyBRLyD/gri1rxtwpaZT
```
##### Default response
`Status: 200`
@@ -489,7 +505,7 @@ Returns a list of the activities that have been performed in Fleet. For a compre
|:--------------- |:------- |:----- |:------------------------------------------------------------|
| page | integer | query | Page number of the results to fetch. |
| per_page | integer | query | Results per page. |
| order_key | string | query | What to order results by. Can be any column in the `activites` table. |
| order_key | string | query | What to order results by. Can be any column in the `activities` table. |
| order_direction | string | query | **Requires `order_key`**. The direction of the order given the order key. Options include `"asc"` and `"desc"`. Default is `"asc"`. |
#### Example
@@ -6330,7 +6346,7 @@ List software that can or will be automatically installed during macOS setup. If
"id": 12,
"name": "Firefox.app",
"software_package": {
"name": "FirefoxInsall.pkg",
"name": "FirefoxInstall.pkg",
"platform": "darwin",
"version": "125.6",
"self_service": true,
@@ -6555,11 +6571,11 @@ Note that the `EraseDevice` and `DeviceLock` commands are _available in Fleet Pr
### Get MDM command results
> `GET /api/v1/fleet/mdm/apple/commandresults` API endpoint is deprecated as of Fleet 4.40. It is maintained for backward compatibility. Please use the new API endpoint below. [[Archived docuemntation](https://github.com/fleetdm/fleet/blob/fleet-v4.39.0/docs/REST%20API/rest-api.md#get-custom-mdm-command-results) is available for the deprecated endpoint.
> `GET /api/v1/fleet/mdm/apple/commandresults` API endpoint is deprecated as of Fleet 4.40. It is maintained for backward compatibility. Please use the new API endpoint below. [[Archived documentation](https://github.com/fleetdm/fleet/blob/fleet-v4.39.0/docs/REST%20API/rest-api.md#get-custom-mdm-command-results) is available for the deprecated endpoint.
This endpoint returns the results for a specific custom MDM command.
In the reponse, the possible `status` values for macOS, iOS, and iPadOS hosts are the following:
In the response, the possible `status` values for macOS, iOS, and iPadOS hosts are the following:
* Pending: the command has yet to run on the host. The host will run the command the next time it comes online.
* NotNow: the host responded with "NotNow" status via the MDM protocol: the host received the command, but couldn’t execute it. The host will try to run the command the next time it comes online.
@@ -7954,7 +7970,7 @@ Returns the query report specified by ID.
"host_name": "bar",
"last_fetched": "2021-01-19T17:20:00Z",
"columns": {
"model": "USB Reciever",
"model": "USB Receiver",
"vendor": "Logitech"
}
},
@@ -7963,7 +7979,7 @@ Returns the query report specified by ID.
"host_name": "bar",
"last_fetched": "2021-01-19T17:20:00Z",
"columns": {
"model": "USB Reciever",
"model": "USB Receiver",
"vendor": "Logitech"
}
},
@@ -8034,7 +8050,7 @@ Returns a query report for a single host.
},
{
"columns": {
"model": "USB Reciever",
"model": "USB Receiver",
"vendor": "Logitech"
}
}
@@ -8622,7 +8638,7 @@ This allows you to easily configure scheduled queries that will impact a whole t
| id | integer | path | **Required**. The team's ID. |
| page | integer | query | Page number of the results to fetch. |
| per_page | integer | query | Results per page. |
| order_key | string | query | What to order results by. Can be any column in the `activites` table. |
| order_key | string | query | What to order results by. Can be any column in the `activities` table. |
| order_direction | string | query | **Requires `order_key`**. The direction of the order given the order key. Options include `"asc"` and `"desc"`. Default is `"asc"`. |
#### Example
@@ -9420,7 +9436,7 @@ Get a list of all software.
"software_package": {
"platform": "darwin",
"fleet_maintained_app_id": 42,
"name": "FirefoxInsall.pkg",
"name": "FirefoxInstall.pkg",
"version": "125.6",
"self_service": true,
"automatic_install_policies": [