Met scopes geef je aan tot welke gegevens van een lid je toegang wilt. Je kunt kiezen uit:
openid profile email address phone bank profile_custom groups
Je app mag alleen de scopes vragen die bij Maximum access scope van je app staan; een nieuwe app mag alleen openid. Noem je geen scopes, dan vragen we openid profile. Hieronder staat wat je met elke scope krijgt via /oauth/userinfo.
openid
Nodig voor het ID token en voor /oauth/userinfo. Je krijgt altijd:
subenuser_id: het ID van het lid in Congressus.is_active: of het lid actief is.
profile
De basisgegevens van het lid:
preferred_usernameenusername: de gebruikersnaam van het lid in Congressus Manager.name: de volledige naam.given_name,family_nameennickname: de voornaam, de achternaam en de roepnaam.picture: het adres van de profielfoto, of leeg als het lid er geen heeft.gender: het geslacht.birthdateenbirthday: de geboortedatum, in ISO-formaat.member_statusenmember_status_id: de naam en het ID van de huidige lidstatus.member_status_since: sinds wanneer het lid deze lidstatus heeft.member_since: wanneer het lid zijn of haar eerste lidstatus kreeg.
email: het e-mailadres van het lid.
address
Het primaire adres van het lid, onder address:
formatted: het volledige adres.street_address: de straat en het huisnummer.locality: de plaats.region: de provincie, als die bekend is.postal_code: de postcode.country: het land.
phone
Het mobiele nummer van het lid:
phone_number: met plus en landcode, zoals+31612345678.phone: zonder plus, zoals31612345678.
bank
IBAN: het rekeningnummer van het lid.BIC: de BIC van die rekening.
profile_custom
De eigen velden van je vereniging, onder custom, als paren van de referentie van het veld en de waarde. Hier staat vaak gevoelige informatie in, dus geef deze scope alleen aan een app die hem echt nodig heeft.
groups
De gepubliceerde groepen van het lid, onder groups. Per groep zie je onder de slug van de groep of het lid nog actief is (active) en de naam (name).
Voorbeeld met alle scopes
{
"sub": "1234",
"user_id": 1234,
"is_active": true,
"preferred_username": "jdevries",
"given_name": "Jan",
"family_name": "de Vries",
"nickname": "Jan",
"birthdate": "2001-04-12",
"username": "jdevries",
"name": "Jan de Vries",
"picture": "https://...",
"gender": "...",
"birthday": "2001-04-12",
"member_status": "Lid",
"member_status_id": 12,
"member_status_since": "2022-09-01T00:00:00",
"member_since": "2020-09-01T00:00:00",
"email": "jan@example.nl",
"address": {
"formatted": "...",
"street_address": "Dorpsstraat 1",
"locality": "Utrecht",
"region": "Utrecht",
"postal_code": "1234 AB",
"country": "Nederland"
},
"phone_number": "+31612345678",
"phone": "31612345678",
"IBAN": "NL91ABNA0417164300",
"BIC": "ABNANL2A",
"custom": {
"field_reference_1": "waarde"
},
"groups": {
"bestuur": {"active": true, "name": "Bestuur"}
}
}