Zitadel PHP API

SMS
in package

Set up an OTP SMS for a user.

Table of Contents

Properties

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

Methods

__construct()  : mixed
Initialize the SMS OTP setup
add()  : void
Add the OTP SMS method. The phone number has to be verified to add this second factor.
remove()  : void
Remove the OTP SMS method from the user
setUserId()  : void
Set the userid
request()  : void

Properties

$settings

private array<string|int, mixed> $settings

$userid

private int $userid

Methods

__construct()

Initialize the SMS OTP setup

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

array The settings array

add()

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

public add() : void
Tags
throws
Exception

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

remove()

Remove the OTP SMS method from the user

public remove() : void
Tags
throws
Exception

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

setUserId()

Set the userid

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

int User id

request()

private request() : void
Tags
throws
Exception

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


        
On this page

Search results