Search
K
Yuki Platform API Prod

Create Portal User

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 yukiapi:portal:users:write scope to access this endpoint.

post
https://apirest.yukiworks.com/api/v1/portals/{portal-id}/users

Path Parameters

portal-idstringrequired

The portal id

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

Headers

Authorizationstringrequired

Bearer token for authentication

Content-Typestringrequired

Content type, must be application/json

Allowed values:application/json

Body

application/json

CreatePortalUser

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

rolestringrequired

Role of the user

Allowed values:PortalAdministratorPortalBackofficePortalDataEntry

messagestring

User message

Response

application/json

Portal user created successfully

idstring

The ID of the created user

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

  
curl --request POST \
  --url https://apirest.yukiworks.com/api/v1/portals/3afb7b54-6144-4561-9a29-1148006f2375/users \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Content-Type: application/json' \
  --data '{
  "firstName": "firstName",
  "lastName": "lastName",
  "email": "john.doe@yuki.nl",
  "language": "en-US",
  "role": "PortalAdministrator"
}'
application/json
{
  "id": "3afb7b54-6144-4561-9a29-1148006f2375"
}