PHP Sigfox Client

ApiUsersId

Table of Contents

delete()  : void
Delete a given API user.
get()  : ApiUser
Retrieve information about a given API user.
profiles()  : ApiUsersIdProfiles
renewCredential()  : string
Generate a new password for a given API user.
update()  : void
Update information about a given API user.

Methods

delete()

Delete a given API user.

public delete() : void
Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

Return values
void

get()

Retrieve information about a given API user.

public get([ApiUsersIdGet|array<string|int, mixed>|null $request = null ]) : ApiUser
Parameters
$request : ApiUsersIdGet|array<string|int, mixed>|null = null

The query and body parameters to pass

Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
ApiUser

renewCredential()

Generate a new password for a given API user.

public renewCredential() : string
Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
NotFoundException

If server returned a HTTP 404 error.

throws
MethodNotAllowedException

If server returned a HTTP 405 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
string

The new API user's acces token (password)

update()

Update information about a given API user.

public update(ApiUserEdition|array<string|int, mixed>|null $apiUser) : void
Parameters
$apiUser : ApiUserEdition|array<string|int, mixed>|null

The information to update

Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

Return values
void

Search results