PHP Sigfox Client

ApiUsersList extends Request

Retrieve a list of API users according to visibility permissions and request filters.

Table of Contents

$authorizations  : bool|null
if true, return the list of actions and resources the user has access
$fields  : string|null
Defines the other available fields to be returned in the response.
$groupIds  : array<string|int, mixed>|null
Searches for API users who are attached to the given groups
$limit  : int|null
Defines the maximum number of items to return
$offset  : int|null
Defines the number of items to skip
$profileId  : string|null
Searches for API users with the given profile
from()  : static
Initializing a model from an array
jsonSerialize()  : array<string|int, mixed>
setAuthorizations()  : static
Setter for authorizations
setFields()  : static
Setter for fields
setGroupIds()  : static
Setter for groupIds
setLimit()  : static
Setter for limit
setOffset()  : static
Setter for offset
setProfileId()  : static
Setter for profileId

Properties

$authorizations

if true, return the list of actions and resources the user has access

protected bool|null $authorizations = null

$fields

Defines the other available fields to be returned in the response.

protected string|null $fields = null

$groupIds

Searches for API users who are attached to the given groups

protected array<string|int, mixed>|null $groupIds = null

$limit

Defines the maximum number of items to return

protected int|null $limit = null

$offset

Defines the number of items to skip

protected int|null $offset = null

$profileId

Searches for API users with the given profile

protected string|null $profileId = 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
throws
DeserializeException

If provided an invalid type to a property

Return values
static

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritdoc
Return values
array<string|int, mixed>

setAuthorizations()

Setter for authorizations

public setAuthorizations(bool $authorizations) : static
Parameters
$authorizations : bool

if true, return the list of actions and resources the user has access

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 API 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

Defines 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

Defines the number of items to skip

Return values
static

To use in method chains

setProfileId()

Setter for profileId

public setProfileId(string $profileId) : static
Parameters
$profileId : string

Searches for API users with the given profile

Return values
static

To use in method chains

Search results