Improves README.
This commit is contained in:
parent
cc6f90b107
commit
e84ec15501
1 changed files with 29 additions and 2 deletions
31
README.md
31
README.md
|
@ -1,5 +1,19 @@
|
||||||
# SCIM Service Provider
|
# 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
|
## Running tests
|
||||||
|
|
||||||
To run the test, you can use [insomnia UI](https://docs.insomnia.rest).
|
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.
|
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
|
## Quick "Deploy" to test
|
||||||
|
|
||||||
|
@ -19,4 +42,8 @@ unzip nextcloud-scim-main.zip
|
||||||
rm nextcloud-scim-main.zip
|
rm nextcloud-scim-main.zip
|
||||||
rm -rf scimserviceprovider
|
rm -rf scimserviceprovider
|
||||||
mv nextcloud-scim-main scimserviceprovider
|
mv nextcloud-scim-main scimserviceprovider
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 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)!
|
Loading…
Reference in a new issue