\CpaasSdk\ResourcesTwofactor

CPaaS provides Authentication API where a two-factor authentication (2FA) flow can be implemented by using that.

Summary

Methods

Properties

Constants

send_code()
verify_code()
resend_code()
delete_code()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: Resources/Twofactor.php
Package: Default
Class hierarchy: \CpaasSdk\Resources\Twofactor

Methods

send_code()

send_code(array  $params = null)

Create a new authentication code

Parameters

array

$params

Single parameter to hold all options.


$params['destination_address']        string Destination address of the authentication code being sent. For sms type authentication codes, it should contain a E164 phone number.
$params['message']                    string Message text sent to the destination, containing the placeholder for the code within the text. CPaaS requires to have *{code}* string within the text in order to generate a code and inject into the text. For email type code, one usage is to have the *{code}* string located within the link in order to get a unique link.
$params['method']                     string optional Type of the authentication code delivery method, sms and email are supported types. Possible values: sms, email
$params['expiry']                     int    optional Lifetime duration of the code sent in seconds. This can contain values between 30 and 3600 seconds.
$params['subject']                    string optional When the method is passed as email then subject becomes a mandatory field to pass. The value passed becomes the subject line of the 2FA code email that is sent out to the destinationAddress.
$params['length']                     int    optional Length of the authentication code tha CPaaS should generate for this request. It can contain values between 4 and 10.
$params['type']                       string optional Type of the code that is generated. If not provided, default value is numeric. Possible values: numeric, alphanumeric, alphabetic

verify_code()

verify_code(array  $params)

Create a new authentication code

Parameters

array

$params

Single parameter to hold all options.


$params['code_id']            string     ID of the authentication code.
$params['verification_code']  string     Code that is being verified.

resend_code()

resend_code(array  $params = null)

Resending the authentication code via same code resource, invalidating the previously sent code.

Parameters

array

$params

Single parameter to hold all options.

$params['code_id'] string Id of the authentication code.
$params['destination_address'] string Destination address of the authentication code being sent. For sms type authentication codes, it should contain a E164 phone number.
$params['message'] string Message text sent to the destination, containing the placeholder for the code within the text. CPaaS requires to have *{code}* string within the text in order to generate a code and inject into the text. For email type code, one usage is to have the *{code}* string located within the link in order to get a unique link.
$params['method'] string optional Type of the authentication code delivery method, sms and email are supported types. Possible values: sms, email
$params['expiry'] int optional Lifetime duration of the code sent in seconds. This can contain values between 30 and 3600 seconds.
$params['subject'] string optional When the method is passed as email then subject becomes a mandatory field to pass. The value passed becomes the subject line of the 2FA code email that is sent out to the destinationAddress.
$params['length'] int optional Length of the authentication code tha CPaaS should generate for this request. It can contain values between 4 and 10.
$params['type'] string optional Type of the code that is generated. If not provided, default value is numeric. Possible values: numeric, alphanumeric, alphabetic

delete_code()

delete_code(array  $params = null)

Delete authentication code resource.

Parameters

array

$params

Single parameter to hold all options.


$params['code_id']   string  ID of the authentication code.