v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Administering user profiles

Find all users.

Returns an array containing all users matching the query.<br />User roles: admin

get/user-profile/v1/users

Query parameters

external-idstring email

The unique external identifier of the user (e.g. BlueID).

privacy-noticestring

Parameter which must be set if the users privacy notice should be returned

offsetstring int32

The index of the first item to be included in the response

limitstring int32

The maximum number of items to be included in the response

includestring

Include additional information sections

Response

Returns a (sub-)list of all available users. At most [limit] items are returned.

offsetinteger required

Number of skipped items, the first item in this sublist list will be (offset)

limitinteger required

Maximum number of items in the current sublist