Strip a server-wide Role Assignment from an Actor.

Usage

assignment_revoke(
  role_id,
  actor_id,
  url = get_default_url(),
  un = get_default_un(),
  pw = get_default_pw(),
  retries = get_retries(),
  odkc_version = get_default_odkc_version()
)

Arguments

role_id

(character or numeric) The Role ID, typically the integer ID of the Role. A Role system name can also be supplied if the Role has one.

actor_id

(numeric) The integer ID of the Actor.

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.

odkc_version

The ODK Central version as a semantic version string (year.minor.patch), e.g. "2023.5.1". The version is shown on ODK Central's version page /version.txt. Discard the "v". ruODK uses this parameter to adjust for breaking changes in ODK Central.

Default: get_default_odkc_version or "2023.5.1" if unset.

Set default get_default_odkc_version through ru_setup(odkc_version="2023.5.1").

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

Value

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

Details

Given a Role and an Actor, this endpoint unassigns that Role from that Actor upon all system objects. This endpoint requires ODK Central v0.5 or later.

See also

https://docs.getodk.org/central-api-accounts-and-users/#stripping-an-role-assignment-from-an-actor

Other user-management: app_user_create(), app_user_delete(), app_user_list(), assignment_actors(), assignment_grant(), assignment_list(), 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 = "...")

assignment_revoke(role_id = "admin", actor_id = 14)
# > $success
# > [1] TRUE
} # }