Zitadel PHP Client 1.3.6 PHP Client for Zitadel

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

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

## Detailed Description

Set up an OTP SMS for a user.

Definition at line 10 of file SMS.php.

## Constructor & Destructor Documentation

## ◆ __construct()

__construct | ( | array | $settings | ) |

Initialize the SMS OTP setup

Parameters

  $settings | array The settings array

Definition at line 18 of file SMS.php.

## Member Function Documentation

## ◆ add()

add | ( |  | ) |

Add the OTP SMS method. The phone number has to be verified to add this second factor.

Returns
  void

Exceptions

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

Definition at line 34 of file SMS.php.

## ◆ remove()

remove | ( |  | ) |

Remove the OTP SMS method from the user

Returns
  void

Exceptions

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

Definition at line 42 of file SMS.php.

## ◆ setUserId()

setUserId | ( | int | $userid | ) |

Set the userid

Parameters

  $userid | int User id

Returns
  void

Definition at line 26 of file SMS.php.

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

- src/User/SetupTwoFactorAuth/SMS.php