offsetinteger
The number of items to skip before starting to collect the result set
limitinteger
The numbers of items to return
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 yukiapi:domain:users:read scope to access this endpoint.
get
https://apirest.yukiworks.com/api/v1/domains/{domain-id}/users
Query Parameters
Path Parameters
domain-idstringrequired
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Content-Typestringrequired
Content type of the request body
Default:application/json
Response
application/json
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 yukiapi:domain:users:write scope to access this endpoint.
post
https://apirest.yukiworks.com/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
Content-Typestringrequired
Content type of the request body
Default:application/json
Body
application/json
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
rolesarray[string]required
User roles for the domain
Allowed values:AccountantBackofficeBackofficeControllerFinAdminHRMManagementProcurementPurchaseSalesSecurityManagerReadOnlyUser
messagestring
Additional message from the user
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
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 yukiapi:domain:users:read scope to access this endpoint.
get
https://apirest.yukiworks.com/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
Content-Typestringrequired
Content type of the request body
Default:application/json
Response
application/json
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
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
Delete Domain User
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 yukiapi:domain:users:delete scope to access this endpoint.
delete
https://apirest.yukiworks.com/api/v1/domains/{domain-id}/users/byEmail
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
Content-Typestringrequired
Content type of the request body
Default:application/json
Response
Response
Domain user successfully deleted
Portal
Operations related to portals