Users
Table of Contents
- create() : CreateResponse
- Create a new user.
- find() : UsersId
- Find by id
- list() : PaginateResponse<User, UsersListResponse>
- Retrieve a list of users according to visibility permissions and request filters.
Methods
create()
Create a new user.
public
create(UserCreation|array<string|int, mixed>|null $user) : CreateResponse
Parameters
- $user : UserCreation|array<string|int, mixed>|null
-
The user to create
Tags
Return values
CreateResponse —find()
Find by id
public
find(string $id) : UsersId
Parameters
- $id : string
-
The User identifier
Return values
UsersId —list()
Retrieve a list of users according to visibility permissions and request filters.
public
list([UsersList|array<string|int, mixed>|null $request = null ]) : PaginateResponse<User, UsersListResponse>
Parameters
- $request : UsersList|array<string|int, mixed>|null = null
-
The query and body parameters to pass
Tags
Return values
PaginateResponse<User, UsersListResponse> —First generic parameter is the item type and the second type is the original response type.