fleet/docs/Contributing
Victor Lyuboslavsky 2198fd8d65
Add SCIM Users (#27551)
For #27287

Video explaining the PR: https://www.youtube.com/watch?v=ZHgFUAvrPEI

This PR adds SCIM Users support for Okta. The goal is to first add
Users/Groups support so that the remaining backend SCIM work can be done
in parallel.

This PR does not include the following, which will be added in later PRs
- Changes file
- Groups support for Okta
- Full support for Entra ID
- Integration tests

# Checklist for submitter

- [x] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [x] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [x] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [x] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-04-01 11:02:24 -05:00
..
research/mdm Docs v4.58.0 (#22769) 2024-10-17 17:51:52 -05:00
Adding-new-endpoints.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
API-for-contributors.md Updating DigiCert/SCEP contributor docs. (#27625) 2025-03-31 13:50:05 -05:00
API-Versioning.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Audit-logs.md fix: report a failure in setup experience if a VPP app installation fails due to lack of licenses (#27163) 2025-03-17 09:43:51 -04:00
Automatically-generating-UI-component-boilerplate.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Building-Fleet.md Bump Node version to 20.18.1 (#25591) 2025-01-20 15:50:28 -06:00
Committing-Changes.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Configuration-for-contributors.md Add detail_query_overrides to contributor docs (#24589) 2024-12-10 15:46:59 -05:00
Deploying-chrome-test-ext.md Enroll hosts docs improvements (#14862) 2023-11-20 19:39:41 +01:00
design-qa-considerations.md Create design-qa-considerations.md (#26774) 2025-03-07 15:32:41 -06:00
Enroll-hosts-with-plain-osquery.md Enroll hosts docs improvements (#14862) 2023-11-20 19:39:41 +01:00
FAQ.md List paths used by Fleet desktop (#23891) 2024-12-13 17:47:50 -06:00
File-carving.md Add docs for --dev default MinIO buckets (#21721) 2024-08-30 16:12:43 -05:00
Fleet-UI-Testing.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
fleetctl-apply.md Agent configuration reference docs (#26999) 2025-03-10 13:36:44 -05:00
fleetd-development-and-release-strategy.md Docs: Replace Orbit with Fleetd (#12443) 2023-07-21 19:33:31 -05:00
high-level-architecture.md Docs: Add pageOrderInSection meta tag to high-level-architecture.md (#15090) 2023-11-10 11:10:28 -06:00
Infrastructure.md Handbook/company/leadership#structure-of-departmental-handbook-pages (#14811) 2023-11-21 13:55:46 -06:00
MDM-Android.md Update MDM-Android.md -- improve class diagram display (#27538) 2025-03-26 13:09:49 -05:00
MDM-custom-configuration-web-url Add page to contributor docs for custom configuration web URL (#17081) 2024-02-27 09:06:35 -05:00
MDM-Custom-SCEP-Integration.md Updating DigiCert/SCEP contributor docs. (#27625) 2025-03-31 13:50:05 -05:00
MDM-DigiCert-Integration.md Updating DigiCert/SCEP contributor docs. (#27625) 2025-03-31 13:50:05 -05:00
MDM-SCIM-integration.md Add SCIM Users (#27551) 2025-04-01 11:02:24 -05:00
MDM.md mdm docs index (#22716) 2024-10-11 16:42:45 -03:00
Migrations.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
README.md Docs: Replace Orbit with Fleetd (#12443) 2023-07-21 19:33:31 -05:00
Releasing-Fleet.md Terraform cleanup (#26379) 2025-02-24 17:35:50 -05:00
Run-Locally-Built-Fleetd.md Docs: add syntax highlighting keywords to code blocks (#13963) 2023-09-22 16:57:40 -05:00
Seeding-Data.md Docs: add syntax highlighting keywords to code blocks (#13963) 2023-09-22 16:57:40 -05:00
set-up-custom-end-user-email.md add internal docs to set end user email (#16573) 2024-02-02 18:13:07 -03:00
Simulate-slow-network.md Remove unused toxiproxy service (#21554) 2024-08-26 13:28:51 -03:00
Teams.md Add contributor docs to document the teams/no team conventions (#24569) 2024-12-10 10:19:28 -05:00
Testing-and-local-development.md Update to Go 1.24.1 (#27506) 2025-03-31 11:14:09 -05:00
Troubleshooting-live-queries.md Move "Troubleshooting live queries" page to contributors docs (#16775) 2024-02-19 16:39:12 +01:00
Understanding-host-vitals.md Revise discovery queries for Python software inventory to be compatible with earlier versions of osquery (#27130) 2025-03-13 17:32:06 -06:00
Upcoming-activities.md Add contributor doc explaining the upcoming activities queue (#27071) 2025-03-12 11:55:56 -04:00
Vulnerability-processing.md Update vulnerability processing docs to reference goval-dictionary (#21536) 2024-08-26 21:38:03 -05:00
windows-mdm-glossary-and-protocol.md Windows MDM Fix Manual Detection (#17721) 2024-03-21 15:09:05 -04:00

Contributing

Building Fleet

Learn about building the code, development infrastructure, and database migrations.

Build and run Fleetd from local code

Building and running your modified code.

Testing

Look at Fleet's full test suite and integration tests.

Migrations

Learn about creating and updating database migrations.

Committing changes

Learn how to merge changes into the codebase.

Releasing Fleet

Learn the process for how to release Fleet.

Seeding data

Learn how to add fake data to your development instance.

API for contributors

Get to grips with Fleet API routes. This documentation is helpful for developing or contributing to Fleet.

Deploying ChromeOS test extensions

Learn how to deploy a test version of the fleetd Chrome extension for debug purposes.

FAQ

Find commonly asked questions and answers about contributing to Fleet as part of our community.