delete_user_role {polished}

Polished API - Delete a User Role

Description

Polished API - Delete a User Role

Usage

delete_user_role(role_uid, user_uid, api_key = get_api_key())

Arguments

role_uid

the role uid of the role to be deleted.

user_uid

the user uid that the role should be removed from.

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. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_user_roles() add_user_role()