Roles

class Roles(session_kwargs, client, return_type='raw')

Examples

>>> import civis
>>> client = civis.APIClient()
>>> client.roles.list(...)

Methods

list(*[, limit, page_num, order, order_dir, ...])

List Roles

list(*, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None)

List Roles

Parameters:

limitint, optional: Number of results to return. Defaults to 50. Maximum allowed is 1000.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to id. Must be one of: id.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.
iteratorbool, optional: If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.

Returns:

civis.response.PaginatedResponse