emailstring(email)required
Email address to search for
Search Portal Users
This endpoint allows searching for users within a specific portal by email address. Returns the user details if a match is found. Users attempting to perform this operation need to ensure they possess the necessary permissions. You should have the openid and yukiapi:portal:users:read scopes to access this endpoint. Returns portals:user_not_found (404) if no user in this portal carries that address.
Authorization
Called with a Portal User token - an employee of an accounting portal.
The caller must hold at least one of these roles in the portal: AccountantManagement, Accountant.
get
https://apirest.yukiworks.be/api/v1/portals/{portal-id}/users/search
Query Parameters
Path Parameters
portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Response
application/json
Response
application/json
Portal user object
PortalUser
idstring
The user’s ID
Example:3afb7b54-6144-4561-9a29-1148006f2375
namestring
Full name of the user
Example:John Doe
emailstring(email)
User email
Example:john.doe@yuki.nl
language
Any OfThe user’s locale. Empty string when the stored value has no ISO mapping (e.g. the user never chose a language).
Languagestring
The locale for the domain.
BE: nl-BE, en-US, fr-BE.
NL: en-US, nl-NL
Allowed values:nl-BEen-USfr-BEnl-NL
Example:en-US
rolesarray[string]
User roles for portal users
Allowed values:PortalAdministratorPortalBackofficePortalBackofficeControllerPortalDataEntry
application/json
Delete Portal User by Email
This endpoint allows deleting a user from a specific portal by their email address. Users attempting to perform this operation need to ensure they possess the necessary permissions. Once deleted, the user information cannot be recovered. You should have the openid and yukiapi:portal:users:delete scopes to access this endpoint. Returns portals:user_not_found (404) if no user in this portal carries that address, or portals:user_update_failed (500) if the user was found but the deletion could not be written.
Authorization
Called with a Portal User token - an employee of an accounting portal.
The caller must hold the AccountantManagement role in the portal.
delete
https://apirest.yukiworks.be/api/v1/portals/{portal-id}/users/byEmail
Query Parameters
emailstring(email)required
Email address to search for
Path Parameters
portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Response
Response
Portal user successfully deleted
Update Portal User
This endpoint allows updating a user’s information in the portal using the specified user email and portal ID. The update can modify the user’s name, language preference, and roles. Users attempting to perform this operation need to ensure they possess the necessary permissions. You should have the openid scope together with one of yukiapi:portal:users:write or yukiapi:portal:users:update to access this endpoint. Returns portals:user_not_found (404) if no user in this portal carries that address, portals:validation_failed (400) if the portal refuses the change, for instance removing the last portal manager, or portals:user_update_failed (500) if the user was found but the change could not be written.
Authorization
Called with a Portal User token - an employee of an accounting portal.
The caller must hold the AccountantManagement role in the portal.
put
https://apirest.yukiworks.be/api/v1/portals/{portal-id}/users/byEmail
Query Parameters
emailstring(email)required
Email address to search for
Path Parameters
portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Body
application/json
Body
application/json
UpdatePortalUser
firstNamestringrequired
First name of the user
lastNamestringrequired
Last name of the user
languagestringrequired
The locale for the domain.
BE: nl-BE, en-US, fr-BE.
NL: en-US, nl-NL
Allowed values:nl-BEen-USfr-BEnl-NL
Example:en-US
rolesarray[string]required
User roles for portal users
Allowed values:PortalAdministratorPortalBackofficePortalBackofficeControllerPortalDataEntry
Response
Response
User successfully updated
Get Portal User
This endpoint enables the retrieval of a single user’s information from the specified portal by the user’s id. Users need to confirm they have the required permissions before attempting to access this information. The operation helps in fetching critical user data for administrative or auditing purposes. You should have the openid and yukiapi:portal:users:read scopes to access this endpoint. Returns portals:user_not_found (404) if this portal has no user with that id.
Authorization
Called with a Portal User token - an employee of an accounting portal.
The caller must hold at least one of these roles in the portal: AccountantManagement, Accountant.
get
https://apirest.yukiworks.be/api/v1/portals/{portal-id}/users/{user-id}
Path Parameters
portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
user-idstringrequired
The user id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Response
application/json
Response
application/json
Portal user object
PortalUser
idstring
The user’s ID
Example:3afb7b54-6144-4561-9a29-1148006f2375
namestring
Full name of the user
Example:John Doe
emailstring(email)
User email
Example:john.doe@yuki.nl
language
Any OfThe user’s locale. Empty string when the stored value has no ISO mapping (e.g. the user never chose a language).
Languagestring
The locale for the domain.
BE: nl-BE, en-US, fr-BE.
NL: en-US, nl-NL
Allowed values:nl-BEen-USfr-BEnl-NL
Example:en-US
rolesarray[string]
User roles for portal users
Allowed values:PortalAdministratorPortalBackofficePortalBackofficeControllerPortalDataEntry
application/json