Skip to main content
Do your clients already sign in to a portal of yours? Then that portal can decide who gets access to aiGust, and to which administrations. Your software creates the client users in aiGust through the API, gives them access to their administrations, and deactivates them again when their access ends. Your clients then open the aiGust client portal from your portal. You need an access token for every call. In the examples, {API} stands for https://api.prod.ai-gust.io/api/v01, and {TENANT_ID} for the ID of the firm. The integration needs the role Office key user: only key users may manage client users. See Create an integration.

How it works

Each client user signs in with their email address. Store the ID aiGust returns for each client user: you need it in the later calls.

Find an administration

To give access, you need the aiGust ID of each administration. Search on its VAT number:
You normally get one result, or none when aiGust doesn’t know the administration:
To look up many VAT numbers in one call, see POST /tenants/{tenant_id}/administrations/vat-numbers in the API reference.

Create a client user

The response holds the new client user, with its id:
A new client user has access to no administrations yet: accessible_administrations is empty.

Choose the role

When your portal manages the access, use client:read_only. Otherwise your clients could also add users in aiGust, outside your portal. See Should clients manage users?

Give access to administrations

Post the IDs of the administrations to the client user’s access list:
aiGust ignores administrations that are already on the list. So you can send only the new ones, or the whole list again.

Take access away

Send the IDs of the administrations to remove:
The endpoint ends in /whitelist, not /whitelist/administrations: it also removes administration groups. For client users that your portal manages, give access per administration, not per group.

Deactivate a client user

aiGust doesn’t delete the client user, but deactivates them. They can no longer sign in.

See who has access to an administration

The same endpoint also gives and takes access from the side of the administration. See the API reference.

Send your clients to aiGust

Add a link or a tile to aiGust in your portal. When your clients sign in to your portal with Microsoft or Google, send them to the sign-in link of that provider: On development, use https://app-dev.ai-gust.io/sso?idp=.... aiGust sends your client straight to the sign-in of that provider. Because your client is already signed in there, they don’t sign in a second time, and land on their own client user in aiGust. The email address of their Microsoft or Google account must be the email address of the client user.

Open a specific page

Add parameters to the link to open a specific administration or meeting: For example, to open the dashboard of one administration in the client portal: