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
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
Return values
ApiUser —profiles()
public
profiles() : ApiUsersIdProfiles
Return values
ApiUsersIdProfiles —renewCredential()
Generate a new password for a given API user.
public
renewCredential() : string
Tags
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