Operations related to users of domain
This endpoint allows retrieving all users within a specific domain. Returns a list of all users with their details including name, email, roles, and language preferences. Users attempting to perform this operation need to ensure they possess the necessary permissions. You should have the openid and yukiapi:domain: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 domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Paged result of domain 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 creating a new user for a specific domain. The user can be added with basic information including name, email, language preference, roles, and an optional message. Users attempting to perform this operation need to ensure they possess the necessary permissions. You should have the openid and yukiapi:domain:users:write scopes to access this endpoint. Returns domains:user_already_exists (409) if a user with the given email already has access to the domain, or domains:validation_failed (400) if a companiesIds entry is not on the domain, no role could be resolved, or the invitation could not be sent. A domain id the caller’s portal does not own — whether unknown or belonging to another portal — answers 403.
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.
The domain name
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
Roles to grant the user in the domain. At least one role is required; an empty array is rejected with 400.
>= 1 items
Optional message included in the invitation email sent to the new user. Applies only to domains using the legacy invitation flow;
List of company identifiers to grant access to.
If not provided or empty, the user will be granted access to all companies in the domain.
Example:["123e4567-e89b-12d3-a456-426614174000","987fcdeb-51a2-3bc4-d567-890123456789"]
Domain user successfully created
The unique identifier of the created domain user
Example:3afb7b54-6144-4561-9a29-1148006f2375
This endpoint allows searching for users within a specific domain 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:domain:users:read scopes to access this endpoint. Returns domains:user_not_found (404) if no user on this domain 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 domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Successful domain user search response
The unique identifier of the user
Full name of the user
Example:John Doe
User email
Example:john.doe@yuki.nl
User roles for the domain
Allowed values:AccountantBackofficeBackofficeControllerFinAdminHRMManagementProcurementPurchaseSalesSecurityManagerReadOnlyUser
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
This endpoint allows deleting a user from a specific domain by email. 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:domain:users:delete scopes to access this endpoint. Returns domains:user_not_found (404) if no user on this domain 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 domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Domain user successfully deleted