banks2ff/firefly-iii-api/docs/UsersApi.md

\UsersApi

All URIs are relative to https://demo.firefly-iii.org/api

Method	HTTP request	Description
delete_user	DELETE /v1/users/{id}	Delete a user.
get_user	GET /v1/users/{id}	Get a single user.
list_user	GET /v1/users	List all users.
store_user	POST /v1/users	Store a new user
update_user	PUT /v1/users/{id}	Update an existing user's information.

delete_user

delete_user(id, x_trace_id) Delete a user.

Delete a user. You cannot delete the user you're authenticated with. This cannot be undone. Be careful!

Parameters

Name	Type	Description	Required	Notes
id	String	The user ID.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

(empty response body)

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user

models::UserSingle get_user(id, x_trace_id) Get a single user.

Gets all info of a single user.

Parameters

Name	Type	Description	Required	Notes
id	String	The user ID.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::UserSingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_user

models::UserArray list_user(x_trace_id, limit, page) List all users.

List all the users in this instance of Firefly III.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.

Return type

models::UserArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

store_user

models::UserSingle store_user(user, x_trace_id) Store a new user

Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the "forgot password" function.

Parameters

Name	Type	Description	Required	Notes
user	User	JSON array or key=value pairs with the necessary user information. See the model for the exact specifications.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::UserSingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded
• Accept: application/json, application/vnd.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_user

models::UserSingle update_user(id, user, x_trace_id) Update an existing user's information.

Update existing user.

Parameters

Name	Type	Description	Required	Notes
id	String	The user ID.	[required]
user	User	JSON array with updated user information. See the model for the exact specifications.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::UserSingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded
• Accept: application/vnd.api+json, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]