Users API

About the Users API

CloudWisdom’s Users API can be used to list and create users. You can also update your own user password and profile through the API, as well as monitor an account’s setup status. You can test these endpoints by visiting our Swagger page and by clicking the interactive buttons below.

GET from /users

Use this endpoint to get a list of all users.

View method details.

POST to /users

Use this endpoint to create a user.

View method details.

GET from /users/current

Use this endpoint to get information about the current user.

View method details.

DELETE to /users/{id}

Use this endpoint to delete a user.

View method details.

GET from /users/{id}

Use this endpoint to get information about another user.

View method details.

PUT to /users/{id}

Use this endpoint to update your own user or to manage the roles of other users if you are an administrator.

View method details.

GET from /users/{id}/featureusage

Use this endpoint to check the setup status and feature usage of a user account.

View method details.

POST to /users/{id}/password

Use this endpoint to update the password for your user.

View method details.

How to Preconfigure a New User

Admins can create new users through the User API by sending a POST call to /users. In addition to basic setup, admins can use properties to define config such as the user’s landing page, theme, and even set them up with a favorite dashboard. Follow this walkthrough to learn how to preconfigure a user.

View Walkthrough.