get_roles: Polished API - Get Role(s)

View source: R/api_04_roles.R

get_rolesR Documentation

Polished API - Get Role(s)

Description

Polished API - Get Role(s)

Usage

get_roles(role_uid = NULL, api_key = get_api_key())

Arguments

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 user(s) with the following columns:

  • uid

  • role_name

  • created_at

See Also

add_role() delete_role()


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