Email address to search for
Delete Portal User by Email
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 yukiapi:portal:users:delete scope to access this endpoint.
Query Parameters
Path Parameters
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Bearer token for authentication
Content type of the request body
Default:application/json
Response
Response
Portal user successfully deleted
Update Portal User
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 yukiapi:portal:users:write and yukiapi:portal:users:update scopes to access this endpoint.
Query Parameters
Email address to search for
Path Parameters
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Bearer token for authentication
Content type of the request body
Default:application/json
Body
application/json
Body
UpdatePortalUser
First name of the user
Last name of the user
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
Response
Response
User successfully updated
Get Portal User
This endpoint enables the retrieval of user information from the portal utilizing the specific portalID based on UserId. 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 yukiapi:portal:users:read scope to access this endpoint.
Path Parameters
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
The user id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Bearer token for authentication
Content type of the request body
Default:application/json
Response
application/json
Response
Portal user object
PortalUser
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
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