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.

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.

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.

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.

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.