Delete an App User.

Usage

app_user_delete(
  pid = get_default_pid(),
  id,
  url = get_default_url(),
  un = get_default_un(),
  pw = get_default_pw(),
  retries = get_retries()
)

Arguments

pid

The numeric ID of the project, e.g.: 2.

Default: get_default_pid.

Set default pid through ru_setup(pid="...").

See vignette("Setup", package = "ruODK").

id

(numeric) The integer ID of the App User.

url

The ODK Central base URL without trailing slash.

Default: get_default_url.

Set default url through ru_setup(url="...").

See vignette("Setup", package = "ruODK").

un

The ODK Central username (an email address). Default: get_default_un. Set default un through ru_setup(un="..."). See vignette("Setup", package = "ruODK").

pw

The ODK Central password. Default: get_default_pw. Set default pw through ru_setup(pw="..."). See vignette("Setup", package = "ruODK").

retries

The number of attempts to retrieve a web resource.

This parameter is given to RETRY(times = retries).

Default: 3.

Value

A list with a single element success (TRUE) as per the ODK Central API docs.

Details

Deleting an App User revokes its access.

See also

https://docs.getodk.org/central-api-accounts-and-users/#deleting-an-app-user

Other user-management: app_user_create(), app_user_list(), assignment_actors(), assignment_grant(), assignment_list(), assignment_revoke(), form_assignment_list(), project_assignment_list(), role_detail(), role_list(), user_create(), user_delete(), user_detail(), user_list(), user_preference_project_delete(), user_preference_project_set(), user_preference_site_delete(), user_preference_site_set(), user_reset_password(), user_update(), user_update_password()

Examples

if (FALSE) { # \dontrun{
# See vignette("setup") for setup and authentication options
# ruODK::ru_setup(svc = "....svc", un = "me@email.com", pw = "...")

au <- app_user_list()

app_user_delete(id = au$id[[1]])
# > $success
# > [1] TRUE
} # }