User Manager

Manage users and user settings — list, get, create, edit, delete.

Access via grocy.users.

# Current user
me = grocy.users.current()
print(f"Logged in as: {me.username}")

# All users
for user in grocy.users.list():
    print(f"{user.id}: {user.username}")

# User settings
settings = grocy.users.settings()
grocy.users.set_setting("my_key", "my_value")

Class Reference

UserManager(api_client)

Manage Grocy users, settings, and permissions.

Access via grocy.users.

list()

Get all users.

get(user_id)

Get a single user by ID.

Parameters:

Name	Type	Description	Default
user_id	int	The Grocy user ID.	required

current()

Get the currently authenticated user.

create(data)

Create a new user.

Parameters:

Name	Type	Description	Default
data	dict	User fields as a dictionary.	required

edit(user_id, data)

Edit an existing user.

Parameters:

Name	Type	Description	Default
user_id	int	The Grocy user ID.	required
data	dict	Fields to update.	required

delete(user_id)

Delete a user.

Parameters:

Name	Type	Description	Default
user_id	int	The Grocy user ID.	required

settings()

Get all settings for the current user.

get_setting(key)

Get a single user setting by key.

Parameters:

Name	Type	Description	Default
key	str	The setting key.	required

set_setting(key, value)

Set a user setting.

Parameters:

Name	Type	Description	Default
key	str	The setting key.	required
value		The setting value.	required

delete_setting(key)

Delete a user setting.

Parameters:

Name	Type	Description	Default
key	str	The setting key.	required