kobotoolbox / kpi / 22509946657

82%

master: 76%

Build Type

push

github

Committed by web-flow

Commit Message

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

Run Details

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