permission_sets_list: List Permission Sets

In civis: R Client for the 'Civis Platform API'

List Permission Sets

Description

List Permission Sets

Usage

permission_sets_list(
  archived = NULL,
  author = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

archived	string optional. The archival status of the requested item(s).
author	string optional. If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.
limit	integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.
page_num	integer optional. Page number of the results to return. Defaults to the first page, 1.
order	string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.
order_dir	string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.

Value

An array containing the following fields:

id	integer, The ID for this permission set.
name	string, The name of this permission set.
description	string, A description of this permission set.
author	list, A list containing the following elements: id integer, The ID of this user. name string, This user's name. username string, This user's username. initials string, This user's initials. online boolean, Whether this user is online.
createdAt	string,
updatedAt	string,
archived	string, The archival status of the requested item(s).

civis documentation built on April 1, 2023, 12:01 a.m.