Zitadel PHP API

Delete
in package

Class to delete a user.

The state of the user will be changed to 'deleted'. The user will not be able to log in anymore. Endpoints requesting this user will return an error 'User not found'

Table of Contents

Properties

$settings  : array<string|int, mixed>
$userid  : int

Methods

__construct()  : mixed
Initialize the user deletion
delete()  : void
Deletes the user and sends the request to Zitadel
setUserId()  : void
Set the user ID of the user you want to delete

Properties

$settings

private array<string|int, mixed> $settings

Methods

__construct()

Initialize the user deletion

public __construct(mixed $settings) : mixed
Parameters
$settings : mixed

array The settings array

delete()

Deletes the user and sends the request to Zitadel

public delete() : void
Tags
throws
Exception

Returns an exception with an error code and a message if the communication with Zitadel fails

setUserId()

Set the user ID of the user you want to delete

public setUserId(mixed $userid) : void
Parameters
$userid : mixed

int The id of the user


        
On this page

Search results