From e84ec1550175b1574ce965007b4373da448db9a9 Mon Sep 17 00:00:00 2001 From: Pierre Ozoux Date: Mon, 2 May 2022 15:52:56 +0200 Subject: [PATCH] Improves README. --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0e188da..2bc1d04 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # SCIM Service Provider +This app allows to provision users and groups in Nextcloud from a scim client. + +You can see the video that shows how it works. + +![video presentation](https://hot-objects.liiib.re/meet-liiib-re-recordings/pair_2022-05-02-15-40-37.mp4) + +## How to use + +We plan to publish on the Nextcloud app store, but in the mean time, you can use instructions at the bottom. + +## Use with Keycloak + +You can use with the [SCIM plugin we developped for keycloak](https://lab.libreho.st/libre.sh/scim/keycloak-scim). + ## Running tests To run the test, you can use [insomnia UI](https://docs.insomnia.rest). @@ -8,7 +22,16 @@ To run the test, you can use [insomnia UI](https://docs.insomnia.rest). For CI, there is still [a bug](https://github.com/Kong/insomnia/issues/4747) we need to find a fix. -## TODO +## Todo + + - ExternalID + - json exceptions + - Meta -> + - createdAt + - lastModified + - if no emails in user, return nice array + - pagination + - group member removal ## Quick "Deploy" to test @@ -19,4 +42,8 @@ unzip nextcloud-scim-main.zip rm nextcloud-scim-main.zip rm -rf scimserviceprovider mv nextcloud-scim-main scimserviceprovider -``` \ No newline at end of file +``` + +## NextGov Hackathon + +This app was started during the [Nextgov hackathon](https://eventornado.com/submission/automatic-sso-saml-sync-from-identity-provider-keycloak-through-a-well-known-protocol-scim?s=1#idea)! \ No newline at end of file