User

class flow_api.user.User(select=None, init=None, by=name, **kwargs)

Base class: Identity

The User class represents a User. Functions from the User class allow interaction with User objects.

A user can be created with system.user('username').save() inside the handler function of a flow script using the system reference.

See the corresponding Resources class at User

Parameters

Name	Type	Description
**kwargs
by
init
select

Constants

RESOURCE = user

Methods

add_role (role, propagate=True)

add_tag (tag)

archive ()

clone (update=None, **kwargs)

delete (permanently=False)

exists ()

export ()

get (*fields, default=None)

get_dict (*fields, default=None)

get_identity_created_by ()

get_identity_modified_by ()

get_roles (limit=1000, offset=0, order=None)

get_tags (limit=1000, offset=0, order=None)

load (*fields)

remove_role (role)

remove_tag (tag)

restore ()

roles (*args, **kwargs)

save (update=None, **kwargs)

send_mail (subject, text=None, html=None)

set (key, value)