API Endpoints

All endpoints require authorisation using the standard HTTP header:

Authorization: Bearer (supplied JWT token)

/api/userinfo

User info.

/api/organisations

List of all organisations the user can act as (subordinate organisations).

/api/organisations/check?id=s51PlatformObjectId

Check whether the organisation identified by the id parameter is a subordinate organisation (i.e. is below the user's organisation in the LDAP tree). e.g.

curl -i -X GET \
   -H "Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0ODY3NDEzMTcsImV4cCI6MTUxODI5ODkxNywiYXVkIjoiZHVtYiBjcmVhdHVyZXMiLCJpc3MiOiJvcGVuaW1wX29hdXRoMiIsInN1YiI6ImFkcmlhbkBzdGF0ZTUxLmNvbSJ9.r8PC7D63emfCblrkjyqa8PQbZwlC599rV7DyOj2bDt8" \
 'http://localhost:3000/api/organisations/check?id=27052295850016'

Return values {true} or {false}

/api/user_uid

Simple endpoint to return the UID of the token holder.

/api/instance_login

Data for the instance login used by MSP.


Created: Thu May 28 2020 16:59:26 GMT+0000 (Coordinated Universal Time)
Build ID: 35931