REST API - CustomerID

Last reviewed: 2019-08-12

If you want to interact with Ubisecure CustomerID through 3^rd party applications, such as portals or identity management systems, it is possible to establish connections through the REST interface. It is important to properly secure access to the REST service using the restriction possibilities in network equipment and proxies. For example any desired source IP restrictions need to be defined outside of the Ubisecure CustomerID application during service integration.

Since there are multiple versions of our REST APIs available we have created a table below to easier understand which use cases are supported in which version in order for you to choose the one that fits your use cases.

Note: The term Remove used in in the APIs is exactly the same as the Delete function. Calling any API with the Remove term will result in the associated data being deleted from the database. There is no recovery function for these Remove calls.

Use case	1.0	1.2	2.0	2.1
Create Organization	X		X	X
Create Role	X
Create Role Invitation		X
Create User	X
Create Pending User		X
Create Mandate		X
Create Mandate Template		X
List Organizations	X		X	X
Query Organization	X		X	X
List Roles			X	X
List User's Roles				X
Query Role	X		X	X
List Role Invitations			X	X
Query Role Invitation		X
List Role Invitations (for user)			X	X
List Role Invitations (for organization)		X
List Users	X		X	X
Query User	X		X	X
List Organization's Users				X
List Registrations		X
List Registration		X
Query Registration		X
List Mandates		X	X	X
Query Mandate		X	X	X
List Mandate Templates		X
Query Mandate Template		X
List Organization's Given Mandates				X
List Organization's Received Mandates				X
List User's Given Mandates				X
List User's Received Mandates				X
List User's Received Mandate Delegations				X
List Received Mandate Role Delegations (for user)				X
Query Mandate Role Delegation				X
Update Organization	X		X	X
Assign Role	X
Deassign Role	X
Update User	X		X	X
Update Users	X
Update Mandate		X
Update Mandate Template		X
Delegate Mandate		X
Delegate Mandate Role		X
Assign Mandate Template		X
Remove Organization	X
Remove Role	X
Delete User	X		X	X
Remove Mandate		X
Remove Mandate Template		X
Remove Mandate Delegation		X
Remove Mandate Role Delegation		X