Operations related to portal users
This endpoint retrieves basic information about users by Portal id. You should have the openid and yukiapi:portal:users:read scopes to access this endpoint.
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.
Number of items to skip before collecting the result set. Defaults to 0; a negative value is rejected with 400.
Default:0
>= 0
Maximum number of items to return. Defaults to 20; a value outside 1-500 is rejected with 400.
Default:20
>= 1<= 500
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Paged result of portal users
Total number of items available
Example:100
Current offset in the list
Example:10
Maximum number of items returned
Example:20
This endpoint allows the creation of a user in the portal. Ensure the user has the necessary permissions before attempting to create a user. You should have the openid and yukiapi:portal:users:write scopes to access this endpoint. Returns portals:user_already_exists (409) if that address is already a user of this portal, or portals:validation_failed (400) if the portal refuses the user for another reason.
Authorization
Called with a Portal User token - an employee of an accounting portal.
The caller must hold the AccountantManagement role in the portal.
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
First name of the user
Last name of the user
User email
Example:john.doe@yuki.nl
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
Role of the user
Allowed values:PortalAdministratorPortalBackofficePortalDataEntry
User message
Portal user created successfully
The ID of the created user
Example:3afb7b54-6144-4561-9a29-1148006f2375
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.
Email address to search for
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Portal user object
The user’s ID
Example:3afb7b54-6144-4561-9a29-1148006f2375
Full name of the user
Example:John Doe
User email
Example:john.doe@yuki.nl
Any OfThe user’s locale. Empty string when the stored value has no ISO mapping (e.g. the user never chose a language).
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
User roles for portal users
Allowed values:PortalAdministratorPortalBackofficePortalBackofficeControllerPortalDataEntry
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.
Email address to search for
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Portal user successfully deleted