api_search_users: Search for users, by name

View source: R/api_users.R

api_search_usersR Documentation

Search for users, by name

Description

Search for users, by name

Usage

api_search_users(name)

Arguments

name

string to look for in the user name

Value

A list of users or a single user, each containing

  • id: the unique numeric id of this user;

  • email: email address, as text;

  • name: name, as text;

  • organisation: organisation name, as text;

  • active: whether the user is still active;

  • country: the country name, as text (but chosen in a consistent list);

  • usercreationdate: the date of creation of the user, as text formatted according to the ISO 8601 standard; parse it with lubridate::ymd_hms();

  • usercreationreason: paragraph describing the usage of EcoTaxa made by the user.

See Also

Other users: api_get_me(), api_get_user(), api_user_preferences

Examples

api_search_users("api")

jiho/ecotaxar documentation built on Jan. 16, 2024, 12:26 a.m.