get_user_roles: Polished API - Get User Role(s)

View source: R/api_05_user_roles.R

get_user_rolesR Documentation

Polished API - Get User Role(s)

Description

Polished API - Get User Role(s)

Usage

get_user_roles(user_uid = NULL, role_uid = NULL, api_key = get_api_key())

Arguments

user_uid

an optional user uid.

role_uid

an optional role uid.

api_key

your Polished API key. Set your polished api key using set_api_key() so that you do not need to supply this argument with each function call.

Value

an object of class polished_api_res. The "content" of the object is a tibble of users(s) with the following columns:

  • role_uid

  • role_name,

  • user_uid,

  • user_name,

  • created_at

See Also

add_user_role() delete_user_role()


polished documentation built on Feb. 16, 2023, 8:02 p.m.