users

User management service

---

change_caller_password

Changes the password of the calling user. When the user is identified by the DQOps local API key, it is the user whose email is stored in the DQOps API Key.
Source code

PUT

http://localhost:8888/api/mypassword  

Request body

Description	Data type	Required
New Password	string

Usage examples

curl

curl -X PUT http://localhost:8888/api/mypassword^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "sample_string_value"

---

change_user_password

Changes the password of a user identified by the email.
Source code

PUT

http://localhost:8888/api/users/{email}/password  

Parameters of this method are described below

Property name	Description	Data type	Required
email	User's email	string

Request body

Description	Data type	Required
New Password	string

Usage examples

curl

curl -X PUT http://localhost:8888/api/users/sample_user@mail.com/password^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "sample_string_value"

---

create_user

Creates (adds) a new user to a multi-user account.
Source code

POST

http://localhost:8888/api/users  

Request body

Description	Data type	Required
User model	DqoCloudUserModel

Usage examples

curl

curl -X POST http://localhost:8888/api/users^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"email\":\"sample_user@mail.com\",\"accountRole\":\"operator\"}"

---

delete_user

Deletes a user from a multi-user account.
Source code

DELETE

http://localhost:8888/api/users/{email}  

Parameters of this method are described below

Property name	Description	Data type	Required
email	User's email	string

Usage examples

curl

curl -X DELETE http://localhost:8888/api/users/sample_user@mail.com^
    -H "Accept: application/json"

---

get_all_users

Returns a list of all users.
Source code

GET

http://localhost:8888/api/users  

Return value

Property name	Description	Data type
dqo_cloud_user_model		List[DqoCloudUserModel]

Usage examples

curl

curl http://localhost:8888/api/users^
    -H "Accept: application/json"

---

get_user

Returns the user model that describes the role of a user identified by an email
Source code

GET

http://localhost:8888/api/users/{email}  

Return value

Property name	Description	Data type
dqo_cloud_user_model		DqoCloudUserModel

Parameters of this method are described below

Property name	Description	Data type	Required
email	User's email	string

Usage examples

curl

curl http://localhost:8888/api/users/sample_user@mail.com^
    -H "Accept: application/json"

---

update_user

Updates a user in a multi-user account. The user's email cannot be changed.
Source code

PUT

http://localhost:8888/api/users/{email}  

Parameters of this method are described below

Property name	Description	Data type	Required
email	User's email	string

Request body

Description	Data type	Required
User model	DqoCloudUserModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/users/sample_user@mail.com^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"email\":\"sample_user@mail.com\",\"accountRole\":\"operator\"}"