Flow and User Update Using the API

Updating a Flow Using the API

A flow can be updated using the API following the below logic. The data coming from the API will always overwrite the data existing on the flow, if the data differs. This is also the case, if the data on the flow has been manually changed by an administrator.  

Updating a User Using the API

Users can be updated with basic information, emails, user data, and roles using the API. There are GET, POST, PATCH and DELETE endpoints available that enables a full user-management experience from the API. How to update user data is described in this article.

Using the API for user management, you must take the different meta types that exist on the licence into account. These are set up when your licence is created and are used to identify the user. There are different cases for each type:

Meta type Singular/Multiple Unique Description
External User Id Singular Yes A unique ID used internally at the institution. The External User ID is usually an attribute coming from SIS and added through the API.
Personal Unique Id Multiple Yes This could be a nationalId. This is ID is not unique per institution and thus can be used to identify a user in e.g., governmental systems. 
Personal Organisation Id Multiple Yes eduPersonPrincipalName. This is the mandatory unique identifier used by various identity providers.
Student Number Multiple No Usually a student number but could be any non-unique value used to identify the user. This meta type can also be used to store additional information, e.g., a department.
User Alias Singular No Similar to Student Number. The main difference being that User Alias is singular.
UNIC ID Multiple Yes

Primarily used by Danish public schools




Was this article helpful?
0 out of 0 found this helpful

Articles in this section