ApiUsers
Table of Contents
- create() : string
- Create a new API user.
- find() : ApiUsersId
- Find by id
- list() : PaginateResponse<ApiUser, ApiUsersListResponse>
- Retrieve a list of API users according to visibility permissions and request filters.
Methods
create()
Create a new API user.
public
create(ApiUserCreation|array<string|int, mixed>|null $apiUser) : string
Parameters
- $apiUser : ApiUserCreation|array<string|int, mixed>|null
Tags
Return values
string —The newly created API user identifier
find()
Find by id
public
find(string $id) : ApiUsersId
Parameters
- $id : string
-
The API user identifier
Return values
ApiUsersId —list()
Retrieve a list of API users according to visibility permissions and request filters.
public
list([ApiUsersList|array<string|int, mixed>|null $request = null ]) : PaginateResponse<ApiUser, ApiUsersListResponse>
Parameters
- $request : ApiUsersList|array<string|int, mixed>|null = null
-
The query and body parameters to pass
Tags
Return values
PaginateResponse<ApiUser, ApiUsersListResponse> —First generic parameter is the item type and the second type is the original response type.