Overview

Namespaces

  • LoginRadiusSDK
    • Advance
    • Clients
    • CustomerRegistration
      • Account
      • Authentication
      • Social
    • Utility

Classes

  • AccountAPI
  • CustomObjectAPI
  • CustomRegistrationDataAPI
  • RoleAPI
  • Overview
  • Namespace
  • Class

Class AccountAPI

Account API

This is the main class to communicate with LoginRadius Customer Registration Account API.

Namespace: LoginRadiusSDK\CustomerRegistration\Account
Located at LoginRadiusSDK/CustomerRegistration/Account/AccountAPI.php
Methods summary
public
# __construct( type $apikey = '', type $apisecret = '', type $options = array() )

Parameters

$apikey
$apisecret
$options
public type
# create( $payload, $fields = '*' )

This API is create account.

This API is create account.

Parameters

$payload

'{ "FirstName":"", "LastName":"", "Password" : "*********", "Email":[ { "Type":"Primary", "Value":"[email protected]" } ]}';

$fields

Returns

type
Object
public
# getEmailVerificationToken( $email, $fields = '*' )

This API Returns an Email Verification token.

This API Returns an Email Verification token.

Parameters

$email
$fields

Returns
public
# getForgotPasswordToken( $email, $fields = '*' )

This API Returns a forgot password token.

This API Returns a forgot password token.

Parameters

$email
$fields

Returns
public array
# getIdentitiesByEmail( $email, $fields = '*' )

This API is used to Get Identities by Email Id.

This API is used to Get Identities by Email Id.

Parameters

$email
$fields

Returns

array
public
# getAccessTokenByUid( $uid, $fields = '*' )

This API is used to retrieve Access Token based on UID or user impersonation API.

This API is used to retrieve Access Token based on UID or user impersonation API.

Parameters

$uid

'xxxxxxxxxx' //UID, the unified identifier for each user account.

return Array of user profile

$fields
public
# getHashPassword( $uid, $fields = '*' )

This API is used to get the password field of an account.

This API is used to get the password field of an account.

Parameters

$uid

'xxxxxxxxxx' //UID, the unified identifier for each user account.

return {passwordHash : passwordhash}

$fields
public
# getProfileByEmail( $email, $fields = '*' )

This API retrieves the profile data associated with the specific user using the passing in email address.

This API retrieves the profile data associated with the specific user using the passing in email address.

Parameters

$email

'[email protected]';

return all user profile

$fields
public
# getProfileByUsername( $username, $fields = '*' )

This API retrieves the profile data associated with the specific user using the passing in username.

This API retrieves the profile data associated with the specific user using the passing in username.

Parameters

$username

'example';

return all user profile

$fields
public
# getProfileByPhone( $phone, $fields = '*' )

This API retrieves the profile data associated with the specific user using the passing in phone number.

This API retrieves the profile data associated with the specific user using the passing in phone number.

Parameters

$phone

'example';

return all user profile

$fields
public
# getProfileByUid( $uid, $fields = '*' )

This API is used to retrieve all of the profile data from each of the linked social provider accounts associated with the account. For ex: A user has linked facebook and google account then this api will retrieve both profile data.

This API is used to retrieve all of the profile data from each of the linked social provider accounts associated with the account. For ex: A user has linked facebook and google account then this api will retrieve both profile data.

Parameters

$uid

'xxxxxxxxxx' //UID, the unified identifier for each user account.

return Array of user profile

$fields
public
# setPassword( $uid, $password, $fields = '*' )

This API is used to set a password for an account. It does not require to know the previous(old) password.

This API is used to set a password for an account. It does not require to know the previous(old) password.

Parameters

$uid
'xxxxxxxxxx' //UID, the unified identifier for each user account.
$password

'xxxxxxxxxx';

return {PasswordHash : passwordhash}

$fields
public type
# update( $uid, $payload, $is_null_support = 'false', $fields = '*' )

This API is used to Modify/Update details of an existing user.

This API is used to Modify/Update details of an existing user.

Parameters

$uid
'xxxxxxxxxx' //UID, the unified identifier for each user account.
$payload

'{ "Prefix":"", "FirstName":"", "MiddleName":null, "LastName":"", "Suffix":null, "FullName":"", "NickName":null, "ProfileName":null, "BirthDate":"10-12-1985", "Gender":"M", "Website":null }';

$is_null_support
$fields

Returns

type
Object
public type
# updateSecurityQuestionByUid( $uid, $payload, $fields = '*' )

This API is used to update security questions configuration using uid.

This API is used to update security questions configuration using uid.

Parameters

$uid
'xxxxxxxxxx' //UID, the unified identifier for each user account.
$payload

{ "securityquestionanswer": { "MiddleName": "value1", "PetName": "value1" } }

$fields

Returns

type
object
public array
# invalidateEmail( $uid, $data, $fields = '*' )

This API is used to invalidate the account.

This API is used to invalidate the account.

Parameters

$uid
'xxxxxxxxxx' //UID, the unified identifier for each user account.
$data
true(boolean type) if have you no body parameters
$fields

Returns

array
public type
# removeEmailByUidAndEmail( $uid, $email, $fields = '*' )

This API is used to remove email using uid.

This API is used to remove email using uid.

Parameters

$uid
'xxxxxxxxxx' //UID, the unified identifier for each user account.
$email
'[email protected]'
$fields

Returns

type
object
public
# delete( $uid, $fields = '*' )

Delete an account from your LoginRadius app.

Delete an account from your LoginRadius app.

Parameters

$uid

'xxxxxxxxxx' //UID, the unified identifier for each user account.

return {"IsDeleted": "true"}

$fields
public type
# updateOrInsertEmailByUid( $uid, $payload, $fields = '*' )

This API is used to update or insert email using uid.

This API is used to update or insert email using uid.

Parameters

$uid
$payload

'{ "Email" : [ { "Type" : "Primary", "Value" : "[email protected]" } ] }';

$fields

Returns

type
object
public type
# mfaGetBackupCodeByUid( $uid, $fields = '*' )

This API is used to receive a backup code to login via the UID.

This API is used to receive a backup code to login via the UID.

Parameters

$uid
$fields

Returns

type
object
public type
# mfaResetBackupCodeByUid( $uid, $fields = '*' )

This API is used to get backup codes for login by the UID.

This API is used to get backup codes for login by the UID.

Parameters

$uid
$fields

Returns

type
object
public {"IsDeleted":
# mfaResetGoogleAuthenticatorByUid( $uid, $googleauthenticator )

MFA Reset Google Authenticator By UID

MFA Reset Google Authenticator By UID

Parameters

$uid
$googleauthenticator

Returns

{"IsDeleted":
"true"}
public {"IsDeleted":
# mfaResetSMSAuthenticatorByUid( $uid, $otpauthenticator )

MFA Reset SMS Authenticator By UID

MFA Reset SMS Authenticator By UID

Parameters

$uid
$otpauthenticator

Returns

{"IsDeleted":
"true"}
public type
# resetPhoneIdVerification( $uid, $data, $fields = '*' )

This API is used to reset phone id verification by the UID.

This API is used to reset phone id verification by the UID.

Parameters

$uid
$data
true(boolean type) if have you no body parameters
$fields

Returns

type
object
public type
# generateSOTT( $time_difference = '10', $fields = '*' )

This API allows you to generate SOTT with a given expiration time.

This API allows you to generate SOTT with a given expiration time.

Parameters

$time_difference
$fields

Returns

type
object
API documentation generated by ApiGen