Skip to content

Commit da49619

Browse files
committed
Update SCIM documentation
1 parent 0076e68 commit da49619

1 file changed

Lines changed: 26 additions & 13 deletions

File tree

docs/SCIM/index.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,15 @@ Er zijn meerdere attributen die een gebruiker of groep identificeren:
3434
- **id** : De identifier voor een gebruiker of groep bij de Service Provider
3535
- **externalId** : De identifier binnen de gastenapplicatie
3636
- **userName** : De identifier voor een gebruiker bij de Service Provider,
37-
in het SCIM protocol de inlognaam voor de gebruiker als deze bij de Service Provider in gaat loggen.
37+
in het SCIM protocol de inlognaam voor de gebruiker als deze bij de Service
38+
Provider in gaat loggen.
3839

3940
Voor de gebruikers die via de invite-applicatie beheerd worden, gebruiken we de
40-
eduPersonPrincipalName (eppn) of het eduID pseudoniem voor de indentifiers, zodat ze ook bij een SAML
41-
of oidc authenticatie herkend kunnen worden.
41+
eduPersonPrincipalName (eppn) of het eduID pseudoniem voor de indentifiers,
42+
zodat ze ook bij een SAML of oidc authenticatie herkend kunnen worden. Voor
43+
gestgebruik met eduID heeft
44+
[de eduID identifier](https://servicedesk.surf.nl/wiki/spaces/IAM/pages/128910006/Attributes+in+SURFconext#AttributesinSURFconext-eduIDeduID)
45+
de voorkeur.
4246

4347
## Gebruikers
4448

@@ -58,8 +62,8 @@ Content-Length: ...
5862
Content-Type: application/json
5963
{
6064
"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],
61-
"externalId":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806@eduid.nl",
62-
"userName":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806@eduid.nl",
65+
"externalId":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806",
66+
"userName":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806",
6367
"name":{
6468
"familyName":"Havekes",
6569
"givenName":"Peter"
@@ -97,7 +101,7 @@ Location: https://example.com/v1/Users/{UserID at SP}
97101
"givenName":"Peter"
98102
},
99103
"id": "{UserID at SP}",
100-
"userName":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806@eduid.nl",
104+
"userName":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806",
101105
"emails":[
102106
{
103107
"type":"other",
@@ -107,7 +111,14 @@ Location: https://example.com/v1/Users/{UserID at SP}
107111
}
108112
```
109113

110-
De **{UserID at SP}** uit het antwoord wordt in de Invite-applicatie opgeslagen bij de user, voor toekomstige updates van de gebruiker.
114+
De **{UserID at SP}** uit het antwoord wordt in de Invite-applicatie opgeslagen
115+
bij de user, voor toekomstige updates van de gebruiker.
116+
117+
Als bij het aanmaken van de uitnodiging [via de API](https://invite.test.surfconext.nl/ui/swagger-ui/index.html#/invitation-controller/newInvitation)
118+
gebruik is gemaakt van `invitesWithInternalPlaceholderIdentifiers`, dan zal de
119+
waarde van `internalPlaceholderIdentifier` worden doorgevenen als
120+
`"id": "{internalPlaceholderIdentifier}"` bij het POST bericht om een gebruiker
121+
aan te maken.
111122

112123
### Update gebruiker
113124

@@ -125,8 +136,8 @@ Content-Length: ...
125136
Content-Type: application/json
126137
{
127138
"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],
128-
"externalId":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806@eduid.nl",
129-
"userName":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806@eduid.nl",
139+
"externalId":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806",
140+
"userName":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806",
130141
"name":{
131142
"familyName":"Havekes-Nieuwenaam",
132143
"givenName":"Peter"
@@ -165,7 +176,7 @@ Location: https://example.com/v1/Users/{UserID at SP}
165176
"resourceType": "User"
166177
},
167178
"id": "{UserID at SP}",
168-
"userName":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806@eduid.nl",
179+
"userName":"c2cd7d6e-63fc-493a-8746-62fb2d3f8806",
169180
"emails":[
170181
{
171182
"type":"other",
@@ -177,7 +188,9 @@ Location: https://example.com/v1/Users/{UserID at SP}
177188

178189
### Verwijder gebruiker
179190

180-
Niet actieve gebruikers worden na X dagen verwijderd uit de invite applicatie, en ook bij alle service providers waar de gebruiker is aangemaakt.
191+
Gebruikers worden na het verlopen van hun laatste rol bij een applicatie
192+
verwijderd uit SURConext Invite, en ook bij alle service providers waar de
193+
gebruiker is aangemaakt.
181194

182195
#### Request
183196

@@ -196,7 +209,7 @@ HTTP/1.1 200 OK
196209

197210
## Groepen
198211

199-
De rollen in de invite applicatie worden als rollen gepubliceerd naar de Service Provider.
212+
De rollen in de invite applicatie worden als groepen gepubliceerd naar de Service Provider.
200213

201214
### Aanmaken groep
202215

@@ -227,7 +240,7 @@ Content-Type: application/json
227240
}
228241
```
229242

230-
Bij het aanmaken van een groep zal de lijst met `members` leeg zijn.
243+
Bij het initieel aanmaken van een groep zal de lijst met `members` leeg zijn.
231244

232245
#### Response
233246

0 commit comments

Comments
 (0)