User API

Users high-level API.

class user_api.UserAPI(sdk)

API for the User entities.

Supports all of the CRUD operations.

Example usage:

api = UserAPI(...)

# Get one user by UUID
user = api.get_user('some-user-uuid')

# Get all users
users = api.get_users()

# Get page number 1 (each page having 10 users) of users
# containing the "foo" string, sorted by the UUID attribute in the
# ascending order
users = api.get_users(q='foo', page=1, size=10, sort='uuid,asc')

# Create user
user = api.create_user(first_name='John', ...)

# Delete user
api.delete_user(user.uuid)

# Delete list of users
api.delete_users(['some-user-uuid', 'another-user-123'])

model_class

alias of dsw_sdk.high_level_api.models.user.User

get_user(uuid)

Retrieves one user, identified by it’s UUID. Also loading all his/her related questionnaires and documents.

Parameters

uuid (str) – user identifier

Returns

object representing a user

Return type

dsw_sdk.high_level_api.models.user.User

get_users(**query_params)

Retrieves list of users. Also loading all related questionnaires and documents.

Parameters

query_params – optional query params: q, size, page and sort

Returns

list of objects, each representing a user

Return type

List[dsw_sdk.high_level_api.models.user.User]

create_user(**kwargs)

Creates a user with given data on the DSW server.

Parameters

kwargs – all the data needed for the user creation

Returns

object representing the new user

Return type

dsw_sdk.high_level_api.models.user.User

delete_user(uuid)

Deletes a user from the DSW server.

Parameters

uuid (str) – UUID of the user to delete

delete_users(uuids)

Deletes multiple users on the DSW server, identified by UUIDs.

Parameters

uuids (List[str]) – UUIDs of users to delete