How to add user using api

Developer Experience Developer Questions
1

I am writing application for xibo.
My problem is to add user using API, it always return http 500 error.
Please someone advice me.
auth header is no problems,
endpoint: /api/user
Request method: POST
Content-Type: application/x-www-form-urlencoded

userName=test2_1746776248122&userTypeId=3&homePageId=1&password=********&groupId=1&newUserWizard=0&hideNavigation=0&email=test2%40oesf.jp

{“success”:false,“error”:500,“message”:“Unexpected Error, please contact support.”}
CMS-version 4.2.1

2

Hi @MarkMiura

It looks like the homePageId value might be causing the issue. Try setting it to icondashboard.view instead of 1. If that still doesn’t work, try including homeFolderId=1 in your POST body as well.

Let me know if it works!

3

Thanks for the advice.

https://xibosignage.com/manual/api/#/user/userAdd
According to the information provided above, homePageId is an Integer, which is a string, correct?
There is no description for homeFolderId, is it a required parameter?

I will test and get back to you.

Thanks.

4

Hi, Nadz-san

Thanks to the great suggestions, the user registration process is now working.
I get an error if I don’t specify homeFolderId. homeFolderId seems to be required.
I specified icondashboard.view and it worked.

Other than icondashboard.view, what else is possible to know?

Thank you for your help.

1 Like
5

Hi, @Nadz

Although the xibo-API specification states that various data is to be returned, there was actually no data at all.
The process is fine, but please update the data in the openapi swagger when you have a chance.

Thanks

6

That’s great! I’m glad that worked out for you.

Here are the other accepted values for homePageId:

  • statusdashboard.view
  • icondashboard.view
  • mediamanager.view
  • playlistdashboard.view

These correspond to the options in the Homepage dropdown in the User form, each with a short description shown in the image below:

image
image836×1018 34.3 KB

As for the response, I tested this in Postman and the API returned data as expected on my end, as shown below:

image
image1311×1227 59.1 KB

I’ll review the Add User endpoint and the Swagger spec when I get a moment, as it’s still unclear whether the issue lies with the required parameters or the implementation.

7

Hi, @Nadz-san

I appreciate you taking the time to check out the transfer.
Regarding the return data not being retrieved, my program was incorrect.
The schema listed in the api spec was large and there was a problem with the validation process.
I made the fix and all problems are now resolved.

Thank you so much.

1 Like