Skip to content

Commit 3727d9b

Browse files
michielschokphavekes
authored andcommitted
Update scimgateway.md
Remove detailed instructions
1 parent e0d627a commit 3727d9b

File tree

1 file changed

+9
-79
lines changed

1 file changed

+9
-79
lines changed

docs/scimgateway.md

Lines changed: 9 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -9,94 +9,24 @@ gebruikt worden. **Deze software wordt niet gemaakt of ondersteund door SURF**.*
99

1010
[Scimgateway](https://github.com/jelhub/scimgateway) is een open source
1111
applicatie die SCIM berichten over personen en groepen kan ontvangen en
12-
verwerken naar endpoints. Standaard ondersteunde endpoint zijn:
13-
14-
- Loki (NoSQL Document-Oriented Database)
15-
- MongoDB (NoSQL Document-Oriented Database)
16-
- SCIM (REST Webservice)
17-
- Soap (SOAP Webservice)
18-
- MSSQL (MSSQL Database)
19-
- SAP HANA (SAP HANA Database)
20-
- Entra ID (REST Webservices)
21-
- LDAP (Directory)
22-
- API (REST Webservices)
23-
24-
Nieuwe endpoints zijn relatief makkelijk te ontwikkelen.
12+
verwerken naar endpoints. Scimgateway ondersteunt standaard verschillende
13+
soorten endpoints.
2514

2615
## SURFconext Invite
2716

28-
Voor SURFconect Invite kan deze applicatie gebruikt worden om:
17+
Voor SURFconext Invite kan deze applicatie gebruikt worden om:
2918

30-
- Te testen met rollenbeheer vanuit SURFConext Invite zonder een echte
19+
- Te testen met rollenbeheer vanuit SURFconext Invite zonder een echte
3120
applicatie te koppelen
32-
- Eenvoudig een SCIM koppeling naar een applicatie te realiseren, door een
33-
eigen endpoint te maken specifiek voor de applicatie. Dit kan door de API's van
21+
- Een SCIM koppeling naar een applicatie te realiseren, door een eigen
22+
endpoint te maken specifiek voor de applicatie. Dit kan door de API's van
3423
de applicatie aan te roepen of rechtstreeks gebruikers in de applicatiedatabase
3524
aan te maken.
3625
- Een SCIM koppelinhg te maken voor een legacy Identity Management systeem.
3726
Door de gebruikers in een standaard database of LDAP te schrijven, kan een
3827
niet-realtime IdM deze database periodiek uitlezen en verwerken.
3928

40-
## Installatie
41-
42-
### Docker
43-
44-
```bash
45-
git clone https://github.com/jelhub/scimgateway.git
46-
cd scimgateway/config/docker/
47-
docker compose up
48-
```
49-
50-
### Linux
51-
52-
Zorg dat node (18 of later) en npm geinstaleerd zijn op de server. [Zie de node.js website](https://nodejs.org/en/download/package-manager)
53-
54-
```bash
55-
mkdir my-scimgateway
56-
cd my-scimgateway
57-
npm init -y
58-
npm install scimgateway
59-
node ./
60-
```
61-
62-
### Windows
63-
64-
[Zie hier voor details](https://github.com/jelhub/scimgateway?tab=readme-ov-file#installation)
65-
66-
## Configuratie
67-
68-
In `index.js` staan alle beschikbare endpoints. Standaard staat alleen het loki
69-
endpoint ingeschakeld, en is de rest uitgeschakeld met "//". Schakel de gewenste
70-
optie in door de "//" re verwijderen, bijvoorbeeld voor Microsoft SQL:
71-
72-
```javascript
73-
// const loki = require('./lib/plugin-loki')
74-
// const mongodb = require('./lib/plugin-mongodb')
75-
// const scim = require('./lib/plugin-scim')
76-
// const soap = require('./lib/plugin-soap') // prereq: npm install soap
77-
const mssql = require('./lib/plugin-mssql')
78-
// const saphana = require('./lib/plugin-saphana') // prereq: npm install hdb
79-
// const entra = require('./lib/plugin-entra-id')
80-
// const ldap = require('./lib/plugin-ldap')
81-
// const api = require('./lib/plugin-api')
82-
```
83-
84-
Daarna moet de config van het endpoint worden aangepast. Daarvoor vind je in de
85-
config directory een bestand met dezelfde naam als de plugin. In het geval van
86-
bijvoorbeeld Microsoft SQL is dat `config\plugin-mssql.json`.
87-
88-
Deze configuratie bestaat uit twee delen. Het eerste deel (scimgateway) gaat
89-
over het SCIM endpoint. Hier zijn belangrijk:
90-
91-
- port: De http-poort waarop de service luistert
92-
- auth.basic : de inlognaam en wachtwoord die moet worden gebruikt om berichten
93-
aan de scim-gateway te sturen
94-
- certificate : de gegevens van het ssl-certificaat om de service beveiligd te
95-
laten communiceren (https)
96-
97-
Het tweede deel (endpoint) gaat over het endpoint wat de gebruikers en groepen
98-
gaat ontvangen. De configuratie verschilt per endpoint. Voor bijvoorbeeld het
99-
Microsoft SQL endpoint moeten de hostname van de server en de
100-
authenticatiegegevens worden ingevuld.
29+
## Installatie en configuratie
10130

102-
[Zie hier voor details](https://github.com/jelhub/scimgateway?tab=readme-ov-file#configuration)
31+
Scimgateway biedt [instructies](https://github.com/jelhub/scimgateway?tab=readme-ov-file#installation) die ondersteunen bij
32+
de installatie en [configuratie](https://github.com/jelhub/scimgateway?tab=readme-ov-file#configuration) van het product. SURF kan hier geen ondersteuning op bieden.

0 commit comments

Comments
 (0)