Skip to Content
IDMUsers with Access

Active Users of an App

Eduplaces differentiates between users and people. Which people are available are configured explicitly by the school, whereas users are defined to have access to the app, i.e. they can perform single-sign on with the app.

You can use the users endpoints to update your user’s properties.

Eduplaces API

GET /schools/:id/users

PathAuthenticationRequired Scope
/idm/ep/v1/schools/:id/usersAccess Token in the apps context (Client Credentials)urn:eduplaces:idm:v1:users:read

Provides a list of users of a specific school.

HTTP/1.1 200 Content-Type: application/json [ { "id": "1d020d46-57c8-4be5-9423-b10e3e6f85e7", "name": { "firstFull": "Maximilian", "firstCall": "Max", "last": "Mustermann" }, "status": "ACTIVE", "role": "STUDENT", "groups": [ { "id": "2cf2f091-c545-473d-99c7-7a854243d0d3", "name": "Klasse 10a", "status": "ACTIVE" } ] } ]

GET /users/:id

PathAuthenticationRequired Scope
/idm/ep/v1/users/:idAccess Token in the apps context (Client Credentials)urn:eduplaces:idm:v1:users:read

Gets a specific user by its ID.

HTTP/1.1 200 Content-Type: application/json { "id": "1d020d46-57c8-4be5-9423-b10e3e6f85e7", "name": { "firstFull": "Maximilian", "firstCall": "Max", "last": "Mustermann" }, "status": "ACTIVE", "role": "STUDENT", "groups": [ { "id": "2cf2f091-c545-473d-99c7-7a854243d0d3", "name": "Klasse 10a", "status": "ACTIVE" } ] }