User

Voor het selecteren van een gehele lijst, of een enkele accounthouder, dient de volgende url gebruikt te worden:

/api/v1.0/user/select/[hash]

Aanvullend kan een extensie worden meegegeven, of XML of JSON response af te dwingen, bijvoorbeeld:
/api/v1.0/user/select/123_abc.xml

Indien er geen [hash] wordt meegegeven, zal er een gehele lijst van gebruikers binnen de eigen organisatie geretourneerd worden. Bijvoorbeeld via:

/api/v1.0/user/select.xml


permalink

Voor het bijwerken van een specifieke register, dient de volgende url gebruikt te worden:

/api/v1.0/user/update/[hash]

Aanvullend kan een extensie worden meegegeven, of XML of JSON response af te dwingen, bijvoorbeeld:
/api/v1.0/user/update/123_abc.xml

De te wijzigen data, dient via de POST methode verstuurd te worden, in een vast structuur. Het volgende kan gewijzigd worden:

  • firstname
  • lastname
  • emailaddress

permalink

Aan de hand van de hash van de user, kan Single Sign On (SSO) tot stand worden gebracht:

/api/v1.0/user/sso/[hash]

Aanvullend kan een extensie worden meegegeven, of XML of JSON response af te dwingen, bijvoorbeeld:
/api/v1.0/user/sso/123_abc.xml

De gebruiker dient de mogelijkheid tot SSO te activeren via het bijbehorend profiel. Middels de response die bovenstaande API-aanroep terug zal geven, wordt informatie verkregen om SSO tot stand te kunnen laten brengen.

Hiervoor is het van belang dat de verkregen informatie naar de persoonlijke inlogpagina van de bijbehorende organisatie wordt gestuurd. In te stellen / te activeren via "Organisatie -> Branding".

Dit dient te gebeuren middels een POST request. Een POST request voorkomt dat verstuurde gegevens (door bijvoorbeeld tracking software) abusievelijk gelogd worden.

Verkregen tokens hebben een beperkte houdbaarheid, waarbij er slechts één geldigde token per keer in omloop kan zijn.


permalink