Search
K
Yuki Platform API Prod

Update Domain by ID

This endpoint allows the modification of an existing domain’s details by its ID. Ensure you have the necessary permissions before attempting to update a domain. You should have the openid scope together with one of yukiapi:domain:domains:write or yukiapi:domain:domains:update to access this endpoint. Returns domains:not_found (404) if this portal has no domain with that id, or domains:update_failed (500) if the domain was found but the back-office change could not be written.

Authorization

Called with a Portal User token - an employee of an accounting portal.

The caller must hold at least one role from each of the following groups:

  • In the portal: AccountantManagement, Accountant
  • BackofficeManager, BackofficeController, AccountantManagement - Enforced at the back-office security level and back-office functions layer.
put
https://apirest.yukiworks.be/api/v1/portals/{portal-id}/domains/{domain-id}

Path Parameters

portal-idstringrequired

The portal id

Example:3afb7b54-6144-4561-9a29-1148006f2375

domain-idstringrequired

The domain name

Example:3afb7b54-6144-4561-9a29-1148006f2375

Headers

Authorizationstringrequired

Bearer token for authentication

Body

application/json

UpdateDomain

Schema for updating an existing domain.

backofficeobjectrequired

Back office configuration settings for updating a domain. All fields are optional; only the fields that are supplied are updated.

Show Child Parameters

Response

Domain updated successfully.

 

Domain User

Operations related to users of domain

Get All Domain Users

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.

get
https://apirest.yukiworks.be/api/v1/domains/{domain-id}/users

Query Parameters

offsetinteger

Number of items to skip before collecting the result set. Defaults to 0; a negative value is rejected with 400.

Default:0

>= 0

limitinteger

Maximum number of items to return. Defaults to 20; a value outside 1-500 is rejected with 400.

Default:20

>= 1<= 500

Path Parameters

domain-idstringrequired

The domain name

Example:3afb7b54-6144-4561-9a29-1148006f2375

Headers

Authorizationstringrequired

Bearer token for authentication

Response

application/json

Paged result of domain users

totalItemsinteger

Total number of items available

Example:100

offsetinteger

Current offset in the list

Example:10

limitinteger

Maximum number of items returned

Example:20

itemsarray[object]
Show Child Parameters
 
application/json

Create Domain User

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.

post
https://apirest.yukiworks.be/api/v1/domains/{domain-id}/users

Path Parameters

domain-idstringrequired

The domain name

Example:3afb7b54-6144-4561-9a29-1148006f2375

Headers

Authorizationstringrequired

Bearer token for authentication

Body

application/json

CreateDomainUser

firstNamestringrequired

First name of the user

lastNamestringrequired

Last name of the user

emailstring(email)required

User email

Example:john.doe@yuki.nl

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

rolesarrayrequired

Roles to grant the user in the domain. At least one role is required; an empty array is rejected with 400.

>= 1 items

messagestring

Optional message included in the invitation email sent to the new user. Applies only to domains using the legacy invitation flow;

companiesIdsarray[string](uuid)

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"]

Response

application/json

Domain user successfully created

idstring

The unique identifier of the created domain user

Example:3afb7b54-6144-4561-9a29-1148006f2375

 
application/json

Search Domain Users

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.

get
https://apirest.yukiworks.be/api/v1/domains/{domain-id}/users/search

Query Parameters

emailstring(email)required

Email address to search for

Path Parameters

domain-idstringrequired

The domain name

Example:3afb7b54-6144-4561-9a29-1148006f2375

Headers

Authorizationstringrequired

Bearer token for authentication

Response

application/json

Successful domain user search response

DomainUser

userIdstringrequired

The unique identifier of the user

namestringrequired

Full name of the user

Example:John Doe

emailstring(email)required

User email

Example:john.doe@yuki.nl

rolesarray[string]

User roles for the domain

Allowed values:AccountantBackofficeBackofficeControllerFinAdminHRMManagementProcurementPurchaseSalesSecurityManagerReadOnlyUser

languageAny Of

The 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

 
application/json