Users

class Users(session_kwargs, client, return_type='raw')

Civis API /users endpoint.

Methods

delete_2fa(id)	Wipes the user's current 2FA settings so that they must reset them upon next login
delete_api_keys(id, key_id)	Revoke the specified API key
delete_me_favorites(id)	Unfavorite an item
delete_sessions(id)	Terminate all of the user's active sessions (must be a team or org admin)
get(id)	Show info about a user
get_api_keys(id, key_id)	Show the specified API key
get_me()	Show info about the logged-in user
list(*[, feature_flag, account_status, ...])	List users
list_api_keys(id, *[, limit, page_num, ...])	Show API keys belonging to the specified user
list_me()	Show info about the logged-in user
list_me_activity(*[, status, author, order])	Get recent activity for logged-in user
list_me_favorites(*[, object_id, ...])	List Favorites
list_me_organization_admins()	Get list of organization admins for logged-in user
patch(id, *[, name, email, active, ...])	Update info about a user (must be a team or org admin)
patch_me(*[, preferences, ...])	Update info about the logged-in user
patch_me_favorites_ranking_bottom(id)	Move a favorite to the bottom of the list
patch_me_favorites_ranking_higher(id)	Move a favorite one position closer to the top of the list
patch_me_favorites_ranking_lower(id)	Move a favorite one position closer to the bottom of the list
patch_me_favorites_ranking_top(id)	Move a favorite to the top of the list
post(name, email, primary_group_id, user, *)	Create a new user (must be a team or org admin)
post_access_email(id)	Sends the target user a 'Reset Password' or 'Welcome to Platform' email depending on the their status - Only available to Org and Team Admins
post_api_keys(id, expires_in, name, *[, ...])	Create a new API key belonging to the logged-in user
post_me_favorites(object_id, object_type)	Favorite an item
post_unsuspend(id)	Unsuspends user