Hive Documentations 1.0 Help

User

Retrieve the authenticated user

GET method/user

Request parameters

Responses

Update the authenticated user

PUT method/user

Request parameters

{ "identifier": "ben", "name": "Benjamin Zhang", "email": "z@benwk.com" }

Responses

Retrieve a list of users

GET method/users

Fuzzy Match via id, username, name and email

Request parameters

Responses

Create a new user

POST method/users

Request parameters

{ "identifier": "ben", "name": "Benjamin Zhang", "email": "z@benwk.com", "user_type": "saas_user", "password": "example" }

Responses

Retrieve a user by id or identifier

GET method/users/{id_or_identifier}

Request parameters

Responses

Update a user by id or identifier

PUT method/users/{id_or_identifier}

Request parameters

{ "identifier": "ben", "name": "Benjamin Zhang", "email": "z@benwk.com" }

Responses

Delete a user by id or identifier

DELETE method/users/{id_or_identifier}

Request parameters

Responses

Change the status of a user

PATCH method/users/{id_or_identifier}

Request parameters

{ "status": "inactive", "review_comment": "User is suspended due to abuse of the system." }

Responses

Last modified: 18 April 2024