kobotoolbox / kpi
82%
master: 76%

LAST BUILD BRANCH: main
DEFAULT BRANCH: master
Repo Added
Files 891
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH main
branch: SELECT
CHANGE BRANCH
x

coverage: 82.067% (+0.04%) from 82.031%
22509946657

push

github

web-flow 
feat(scim): get/list api endpoints for the scim integration DEV-1665 (#6741)

### đŸ“Ŗ Summary
As part of the SSO deprovisioning project, this PR implements basic SCIM
v2 User `GET` (list and retrieve) endpoints, allowing external IdPs to
query user accounts via the SCIM protocol.

Features included in this PR:
* SCIM API endpoints exposed at `/api/scim/v2/{idp_slug}/Users/` and
`/api/scim/v2/{idp_slug}/Users/{user_id}`
* Authentication via a `Bearer` token validated against the respective
`IdentityProvider.scim_api_key`.
* Pagination following the standard specifications 
* Supported filtering usernames and emails (e.g. `?filter=userName eq
"test@test.com"`) to locate linked accounts for deprovisioning queries.


### 👀 Preview steps


1. ℹī¸ Create an active `IdentityProvider` using the Django shell (or
admin)
2. ℹī¸ Ensure you have a couple of users existing in your local test
databae
3. Open your terminal and attempt to fetch the SCIM users list without
authentication:
```
   curl -X GET http://kf.kobo.local/api/scim/v2/test-idp/Users/
```
🔴 It should fail.
4. Provide the Bearer token configured for your IdP:
```
curl -H "Authorization: Bearer my-secret-token" \
     -X GET http://kf.kobo.local/api/scim/v2/test-idp/Users/
```
đŸŸĸ [on PR] Notice that the endpoint returns a 200 OK response. The
response should follow the SCIM ListResponse standard, detailing
totalResults, pagination bounds (startIndex, itemsPerPage), and an array
of Kobo users formatted with the SCIM specs.
5. Retrieve a specific user by copying a user ID from the previous list
and querying it directly:
```
curl -H "Authorization: Bearer my-secret-token" \
     -X GET http://kf.kobo.local/api/scim/v2/test-idp/Users/{user_id}/
đŸŸĸ [on PR] Notice that the endpoint returns a single user matching the urn:ietf:params:scim:schemas:core:2.0:User schema

7469 of 11502 branches covered (64.94%)

95 of 101 new or added lines in 5 files covered. (94.06%)

114 existing lines in 8 files now uncovered.

28689 of 34958 relevant lines covered (82.07%)

1.62 hits per line

Relevant lines Covered
34958 RELEVANT LINES 28689 COVERED LINES
1.62 HITS PER LINE
Source Files on master

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
22509946657 main feat(scim): get/list api endpoints for the scim integration DEV-1665 (#6741) ### đŸ“Ŗ Summary As part of the SSO deprovisioning project, this PR implements basic SCIM v2 User `GET` (list and retrieve) endpoints, allowing external IdPs to query user ... push web-flow github
82.07
22508505542 update-minor-patch-python-deps Merge 2d8cbbf57 into 56a461b6c Pull #6773 web-flow github
82.03
22508031423 update-minor-patch-python-deps Merge 1dc74d7d0 into 56a461b6c Pull #6773 web-flow github
82.03
22507793823 update-minor-patch-python-deps Merge cede580ec into 56a461b6c Pull #6773 web-flow github
82.02
22503202998 dev-1666-deprovisioning-endpoint Merge 44836c59a into 9055af82c Pull #6756 web-flow github
82.08
22361967232 main feat(sso): IdP model and admin screen DEV-1664 (#6738) ### đŸ“Ŗ Summary This PR adds the Identity Provider model and admin screen to manage the SCIM providers. ### 👀 Preview steps 1. Go to the django admin 2. Search for the Identity Providers in t... push web-flow github
82.03
22359382588 beccagraber/DEV-1763-yoke-params Merge fae8d5365 into a205d86f6 Pull #6743 web-flow github
79.69
22359357794 beccagraber/DEV-1763-yoke-params Merge 688dbaa22 into a205d86f6 Pull #6743 web-flow github
81.97
22359145170 beccagraber/DEV-1763-yoke-params Merge 9a9b677f8 into a205d86f6 Pull #6743 web-flow github
79.69
22359031578 beccagraber/DEV-1763-yoke-params Merge 59e68955f into a205d86f6 Pull #6743 web-flow github
79.69
See All Builds (11307)