UsersList extends Request
Retrieve a list of users according to visibility permissions and request filters.
Table of Contents
- $authorizations : bool|null
- if true, we return the list of actions and resources the user has access
- $deep : bool|null
- Deep search in the sub group hierarchy
- $fields : string|null
- Defines the other available fields to be returned in the response.
- $groupIds : array<string|int, mixed>|null
- Searches for users who are attached to the given groups
- $limit : int|null
- The maximum number of items to return
- $offset : int|null
- The number of items to skip
- $pageId : string|null
- Token representing the page to retrieve
- $profileId : string|null
- Searches for users who have the given profile affected
- $sort : string|null
- The field on which the list will be sorted. (field to sort ascending or -field to sort descending) sort by name will sort on lowercase and ascii string version of "<firstName> <lastName>"
- $text : string|null
- Searches for users containing the given text in their name or email
- from() : static
- Initializing a model from an array
- jsonSerialize() : array<string|int, mixed>
- setAuthorizations() : static
- Setter for authorizations
- setDeep() : static
- Setter for deep
- setFields() : static
- Setter for fields
- setGroupIds() : static
- Setter for groupIds
- setLimit() : static
- Setter for limit
- setOffset() : static
- Setter for offset
- setPageId() : static
- Setter for pageId
- setProfileId() : static
- Setter for profileId
- setSort() : static
- Setter for sort
- setText() : static
- Setter for text
Properties
$authorizations
if true, we return the list of actions and resources the user has access
protected
bool|null
$authorizations
= null
$deep
Deep search in the sub group hierarchy
protected
bool|null
$deep
= null
$fields
Defines the other available fields to be returned in the response.
protected
string|null
$fields
= null
$groupIds
Searches for users who are attached to the given groups
protected
array<string|int, mixed>|null
$groupIds
= null
$limit
The maximum number of items to return
protected
int|null
$limit
= null
$offset
The number of items to skip
protected
int|null
$offset
= null
$pageId
Token representing the page to retrieve
protected
string|null
$pageId
= null
$profileId
Searches for users who have the given profile affected
protected
string|null
$profileId
= null
$sort
The field on which the list will be sorted. (field to sort ascending or -field to sort descending) sort by name will sort on lowercase and ascii string version of "<firstName> <lastName>"
protected
string|null
$sort
= null
$text
Searches for users containing the given text in their name or email
protected
string|null
$text
= null
Methods
from()
Initializing a model from an array
public
static from(array<string|int, mixed> $params) : static
Parameters
- $params : array<string|int, mixed>
-
Pass this parameter if you want to initial property value from an array. See API reference for all property names and types
Tags
Return values
static —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setAuthorizations()
Setter for authorizations
public
setAuthorizations(bool $authorizations) : static
Parameters
- $authorizations : bool
-
if true, we return the list of actions and resources the user has access
Return values
static —To use in method chains
setDeep()
Setter for deep
public
setDeep(bool $deep) : static
Parameters
- $deep : bool
-
Deep search in the sub group hierarchy
Return values
static —To use in method chains
setFields()
Setter for fields
public
setFields(string $fields) : static
Parameters
- $fields : string
-
Defines the other available fields to be returned in the response.
Return values
static —To use in method chains
setGroupIds()
Setter for groupIds
public
setGroupIds(array<string|int, string> $groupIds) : static
Parameters
- $groupIds : array<string|int, string>
-
Searches for users who are attached to the given groups
Return values
static —To use in method chains
setLimit()
Setter for limit
public
setLimit(int $limit) : static
Parameters
- $limit : int
-
The maximum number of items to return
Return values
static —To use in method chains
setOffset()
Setter for offset
public
setOffset(int $offset) : static
Parameters
- $offset : int
-
The number of items to skip
Return values
static —To use in method chains
setPageId()
Setter for pageId
public
setPageId(string $pageId) : static
Parameters
- $pageId : string
-
Token representing the page to retrieve
Return values
static —To use in method chains
setProfileId()
Setter for profileId
public
setProfileId(string $profileId) : static
Parameters
- $profileId : string
-
Searches for users who have the given profile affected
Return values
static —To use in method chains
setSort()
Setter for sort
public
setSort(string $sort) : static
Parameters
- $sort : string
-
The field on which the list will be sorted. (field to sort ascending or -field to sort descending) sort by name will sort on lowercase and ascii string version of "
"
Return values
static —To use in method chains
setText()
Setter for text
public
setText(string $text) : static
Parameters
- $text : string
-
Searches for users containing the given text in their name or email
Return values
static —To use in method chains