Last updated: July 22, 2025

DQOps REST API users operations

Operations for managing access for DQOps users in a multi-user installations. User management is supported in the TEAM and ENTERPRISE licences.

---

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.

Follow the link to see the source code on GitHub.

PUT

http://localhost:8888/api/mypassword

Request body

Description	Data type	Required
New Password	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Execution

from dqops import client
from dqops.client.api.users import change_caller_password

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = 'sample_string_value'

call_result = change_caller_password.sync(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import change_caller_password

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = 'sample_string_value'

call_result = await change_caller_password.asyncio(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import change_caller_password

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = 'sample_string_value'

call_result = change_caller_password.sync(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import change_caller_password

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = 'sample_string_value'

call_result = await change_caller_password.asyncio(
    client=dqops_client,
    json_body=request_body
)

---

change_user_password

Changes the password of a user identified by the email.

Follow the link to see the source code on GitHub.

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

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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\""

Execution

from dqops import client
from dqops.client.api.users import change_user_password

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = 'sample_string_value'

call_result = change_user_password.sync(
    'sample_user@mail.com',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import change_user_password

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = 'sample_string_value'

call_result = await change_user_password.asyncio(
    'sample_user@mail.com',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import change_user_password

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = 'sample_string_value'

call_result = change_user_password.sync(
    'sample_user@mail.com',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import change_user_password

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = 'sample_string_value'

call_result = await change_user_password.asyncio(
    'sample_user@mail.com',
    client=dqops_client,
    json_body=request_body
)

---

create_user

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

Follow the link to see the source code on GitHub.

POST

http://localhost:8888/api/users

Request body

Description	Data type	Required
User model	DqoUserRolesModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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\",\"dataDomainRoles\":{\"(default)\":\"editor\",\"datalake\":\"editor\"}}"

Execution

from dqops import client
from dqops.client.api.users import create_user
from dqops.client.models import DqoUserRole, \
                                DqoUserRolesModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

call_result = create_user.sync(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import create_user
from dqops.client.models import DqoUserRole, \
                                DqoUserRolesModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

call_result = await create_user.asyncio(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import create_user
from dqops.client.models import DqoUserRole, \
                                DqoUserRolesModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

call_result = create_user.sync(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import create_user
from dqops.client.models import DqoUserRole, \
                                DqoUserRolesModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

call_result = await create_user.asyncio(
    client=dqops_client,
    json_body=request_body
)

---

delete_user

Deletes a user from a multi-user account.

Follow the link to see the source code on GitHub.

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

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Execution

from dqops import client
from dqops.client.api.users import delete_user

dqops_client = client.Client(
    'http://localhost:8888/'
)

call_result = delete_user.sync(
    'sample_user@mail.com',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.users import delete_user

dqops_client = client.Client(
    'http://localhost:8888/'
)

call_result = await delete_user.asyncio(
    'sample_user@mail.com',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.users import delete_user

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

call_result = delete_user.sync(
    'sample_user@mail.com',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.users import delete_user

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

call_result = await delete_user.asyncio(
    'sample_user@mail.com',
    client=dqops_client
)

---

get_all_users

Returns a list of all users.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/users

Return value

Property name	Description	Data type
dqo_user_roles_model		List[DqoUserRolesModel]

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

[ {
  "email" : "sample_user@mail.com",
  "accountRole" : "operator",
  "dataDomainRoles" : {
    "(default)" : "editor",
    "datalake" : "editor"
  }
}, {
  "email" : "sample_user@mail.com",
  "accountRole" : "operator",
  "dataDomainRoles" : {
    "(default)" : "editor",
    "datalake" : "editor"
  }
}, {
  "email" : "sample_user@mail.com",
  "accountRole" : "operator",
  "dataDomainRoles" : {
    "(default)" : "editor",
    "datalake" : "editor"
  }
} ]

Execution

from dqops import client
from dqops.client.api.users import get_all_users

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_all_users.sync(
    client=dqops_client
)

Expand to see the returned result

[
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    ),
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    ),
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    )
]

Execution

from dqops import client
from dqops.client.api.users import get_all_users

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_all_users.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    ),
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    ),
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    )
]

Execution

from dqops import client
from dqops.client.api.users import get_all_users

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_all_users.sync(
    client=dqops_client
)

Expand to see the returned result

[
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    ),
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    ),
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    )
]

Execution

from dqops import client
from dqops.client.api.users import get_all_users

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_all_users.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    ),
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    ),
    DqoUserRolesModel(
        email='sample_user@mail.com',
        account_role=DqoUserRole.OPERATOR,
        data_domain_roles=LinkedHashMap()
    )
]

---

get_user

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

Follow the link to see the source code on GitHub.

GET

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

Return value

Property name	Description	Data type
dqo_user_roles_model		DqoUserRolesModel

Parameters of this method are described below

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

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

{
  "email" : "sample_user@mail.com",
  "accountRole" : "operator",
  "dataDomainRoles" : {
    "(default)" : "editor",
    "datalake" : "editor"
  }
}

Execution

from dqops import client
from dqops.client.api.users import get_user

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_user.sync(
    'sample_user@mail.com',
    client=dqops_client
)

Expand to see the returned result

DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

Execution

from dqops import client
from dqops.client.api.users import get_user

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_user.asyncio(
    'sample_user@mail.com',
    client=dqops_client
)

Expand to see the returned result

DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

Execution

from dqops import client
from dqops.client.api.users import get_user

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_user.sync(
    'sample_user@mail.com',
    client=dqops_client
)

Expand to see the returned result

DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

Execution

from dqops import client
from dqops.client.api.users import get_user

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_user.asyncio(
    'sample_user@mail.com',
    client=dqops_client
)

Expand to see the returned result

DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

---

update_user

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

Follow the link to see the source code on GitHub.

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	DqoUserRolesModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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\",\"dataDomainRoles\":{\"(default)\":\"editor\",\"datalake\":\"editor\"}}"

Execution

from dqops import client
from dqops.client.api.users import update_user
from dqops.client.models import DqoUserRole, \
                                DqoUserRolesModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

call_result = update_user.sync(
    'sample_user@mail.com',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import update_user
from dqops.client.models import DqoUserRole, \
                                DqoUserRolesModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

call_result = await update_user.asyncio(
    'sample_user@mail.com',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import update_user
from dqops.client.models import DqoUserRole, \
                                DqoUserRolesModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

call_result = update_user.sync(
    'sample_user@mail.com',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.users import update_user
from dqops.client.models import DqoUserRole, \
                                DqoUserRolesModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = DqoUserRolesModel(
    email='sample_user@mail.com',
    account_role=DqoUserRole.OPERATOR,
    data_domain_roles=LinkedHashMap()
)

call_result = await update_user.asyncio(
    'sample_user@mail.com',
    client=dqops_client,
    json_body=request_body
)