Zitadel PHP Client 1.3.6 PHP Client for Zitadel

Loading...
Searching...
No Matches
Public Member Functions
Delete Class Reference

## Public Member Functions
| __construct (array $settings)
| setUserId (int $userid)
| delete ()

## Detailed Description

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'

Definition at line 13 of file Delete.php.

## Constructor & Destructor Documentation

## ◆ __construct()

__construct | ( | array | $settings | ) |

Initialize the user deletion

Parameters

  $settings | array The settings array

Definition at line 20 of file Delete.php.

## Member Function Documentation

## ◆ delete()

delete | ( |  | ) |

Deletes the user and sends the request to Zitadel

Returns
  void

Exceptions

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

Definition at line 37 of file Delete.php.

## ◆ setUserId()

setUserId | ( | int | $userid | ) |

Set the user ID of the user you want to delete

Parameters

  $userid | int The id of the user

Returns
  void

Definition at line 29 of file Delete.php.

The documentation for this class was generated from the following file:

- src/User/Delete.php