User

33 operation(s). Part of the API index.

Call these as client.<service>.<method>(...). <service> is the client field for this group — the README lists the field name for every service. These pages group operations the way the OpenAPI specification tags them, which is not always one field per page.

`accountListPasskey`

GET /identity/v2/auth/account/passkey

List registered Passkeys

Lists all registered Passkeys for a User with a valid Access Token.

Example

public static void callAccountListPasskey(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional

  try {
    var response = client.user.accountListPasskey(accessToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User

Returns

PasskeyListResponse

`accountRemovePasskey`

DELETE /identity/v2/auth/account/passkey/{passkeyId}

Remove Passkey

Removes a specific Passkey from the User's Account.

Example

public static void callAccountRemovePasskey(LoginRadiusClient client) {
  String passkeyId = "<passkeyId>"; //Required
  String accessToken = "<accessToken>"; //Optional

  try {
    var response = client.user.accountRemovePasskey(passkeyId, accessToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`passkeyId`	path	string	yes	Id asscociated with the Passkey
`access_token`	query	string	no	Access Token of the User

Returns

IsDeleted

`addEmail`

POST /identity/v2/auth/email

Add Email

Adds an Email to a User's account, either as a primary or additional Email.

Example

public static void callAddEmail(LoginRadiusClient client) {
  AddEmailModel addEmailModel = new AddEmailModel().email("<email>"); //Required
  String accessToken = "<accessToken>"; //Optional
  String emailtemplate = "<emailtemplate>"; //Optional
  String verificationurl = "<verificationurl>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional

  try {
    var response = client.user.addEmail(addEmailModel, accessToken, emailtemplate, verificationurl, preventWebhook, xPreventWebhook);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`emailtemplate`	query	string	no	Name of the Email template to use for this notification.
`verificationurl`	query	string	no	Verification URL for the User which will be included in the Email template..
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

AddEmailModel as application/json.

Returns

IsPostedResponse

`changePhoneNumber`

PUT /identity/v2/auth/phone

Change Phone number

Updates the User's Phone number using the Access Token.

Example

public static void callChangePhoneNumber(LoginRadiusClient client) {
  String smstemplate = "<smstemplate>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional
  String accessToken = "<accessToken>"; //Optional
  Boolean isvoiceotp = true; //Optional
  PhoneIdModel phoneIdModel = new PhoneIdModel().phone("<phone>"); //Optional

  try {
    var response = client.user.changePhoneNumber(smstemplate, preventWebhook, xPreventWebhook, accessToken, isvoiceotp, phoneIdModel);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`smstemplate`	query	string	no	SMS Template
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.
`access_token`	query	string	no	Access Token of the User
`isvoiceotp`	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.

Request body

PhoneIdModel as application/json.

Returns

SMSResponse

`checkEmailAvailability`

GET /identity/v2/auth/email

Check Email availability

Verifies Email availability or checks Email using a Verification Token or OTP.

Example

public static void callCheckEmailAvailability(LoginRadiusClient client) {
  String email = "<email>"; //Optional
  String username = "<username>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional
  String verificationtoken = "<verificationtoken>"; //Optional
  String otp = "<otp>"; //Optional
  String uuid = "<uuid>"; //Optional
  String url = "<url>"; //Optional
  String welcomeemailtemplate = "<welcomeemailtemplate>"; //Optional
  String gRecaptchaResponse = "<gRecaptchaResponse>"; //Optional
  String gRecaptchaResponse2 = "<gRecaptchaResponse2>"; //Optional
  String qqCaptchaTicket = "<qqCaptchaTicket>"; //Optional
  String qqCaptchaRandstr = "<qqCaptchaRandstr>"; //Optional
  String hCaptchaResponse = "<hCaptchaResponse>"; //Optional

  try {
    var response = client.user.checkEmailAvailability(email, username, preventWebhook, xPreventWebhook, verificationtoken, otp, uuid, url, welcomeemailtemplate, gRecaptchaResponse, gRecaptchaResponse2, qqCaptchaTicket, qqCaptchaRandstr, hCaptchaResponse);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`email`	query	string (email)	no	Email address of the associated Account.
`username`	query	string	no	Username of the associated Account.
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.
`verificationtoken`	query	string	no	Verification token received in the Email.
`otp`	query	string	no	One-time passcode sent to the User's Email.
`uuid`	query	string	no	Email template for the welcome Email.
`url`	query	string	no	URL to log the main domain in the database.
`welcomeemailtemplate`	query	string	no	Welcome Email Template
`g-recaptcha-response`	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
`g_recaptcha_response`	query	string	no	Google reCAPTCHA Response
`qq_captcha_ticket`	query	string	no	QQ reCAPTCHA Response
`qq_captcha_randstr`	query	string	no	QQ reCAPTCHA Response
`h-captcha-response`	query	string	no	hCaptcha Response

Returns

object

`deleteAccByPhoneOTP`

POST /identity/v2/auth/account/delete

Delete Account by Phone OTP

Deletes an Account using a Phone OTP.

Example

public static void callDeleteAccByPhoneOTP(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional
  String gRecaptchaResponse = "<gRecaptchaResponse>"; //Optional
  String gRecaptchaResponse2 = "<gRecaptchaResponse2>"; //Optional
  String hCaptchaResponse = "<hCaptchaResponse>"; //Optional
  String qqCaptchaTicket = "<qqCaptchaTicket>"; //Required
  String qqCaptchaRandstr = "<qqCaptchaRandstr>"; //Required
  VerifyDeleteAccountOtp verifyDeleteAccountOtp = new VerifyDeleteAccountOtp().otp("<otp>"); //Optional

  try {
    var response = client.user.deleteAccByPhoneOTP(accessToken, preventWebhook, xPreventWebhook, gRecaptchaResponse, gRecaptchaResponse2, hCaptchaResponse, qqCaptchaTicket, qqCaptchaRandstr, verifyDeleteAccountOtp);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.
`g-recaptcha-response`	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
`g_recaptcha_response`	query	string	no	Google reCAPTCHA Response
`h-captcha-response`	query	string	no	hCaptcha Response
`qq_captcha_ticket`	query	string	no	QQ Captcha ticket (required if Bot Protection is enabled)
`qq_captcha_randstr`	query	string	no	QQ Captcha rand string (required if Bot Protection is enabled)

Request body

VerifyDeleteAccountOtp as application/json.

Returns

IsDeleted

`deleteAccount`

GET /identity/v2/auth/account/delete

Delete Account by Email token or OTP

Deletes an Account using a delete token or OTP.

Example

public static void callDeleteAccount(LoginRadiusClient client) {
  Boolean preventWebhook = true; //Optional
  String deletetoken = "<deletetoken>"; //Optional
  Boolean xPreventWebhook = true; //Optional
  String email = "<email>"; //Optional
  String otp = "<otp>"; //Optional

  try {
    var response = client.user.deleteAccount(preventWebhook, deletetoken, xPreventWebhook, email, otp);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`deletetoken`	query	string	no	This is required if the OTP is not passed in the query parameter.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.
`email`	query	string (email)	no	Email address of the associated Account.
`otp`	query	string	no	One-time passcode sent to the User's Email.

Returns

IsPostedResponse

`deleteAccountByAccessToken`

DELETE /identity/v2/auth/account

Send User deletion Email

Sends a confirmation Email for User deletion to the User's Email using their Access Token.

Example

public static void callDeleteAccountByAccessToken(LoginRadiusClient client) {
  String emailtemplate = "<emailtemplate>"; //Optional
  String deleteurl = "<deleteurl>"; //Optional
  String accessToken = "<accessToken>"; //Optional

  try {
    var response = client.user.deleteAccountByAccessToken(emailtemplate, deleteurl, accessToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`emailtemplate`	query	string	no	Name of the Email template to use for this notification.
`deleteurl`	query	string	no	DeleteUrl URL which is being sent in the Email
`access_token`	query	string	no	Access Token of the User

Returns

IsDeleteRequestAccepted

`deleteemailbyaccesstoken`

DELETE /identity/v2/auth/email

Remove Email

Removes additional Emails from a User's account.

Example

public static void callDeleteemailbyaccesstoken(LoginRadiusClient client) {
  DeleteemailbyaccesstokenRequest deleteemailbyaccesstokenRequest = new DeleteemailbyaccesstokenRequest().email("<email>"); //Required
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional

  try {
    var response = client.user.deleteemailbyaccesstoken(deleteemailbyaccesstokenRequest, preventWebhook, xPreventWebhook);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

object as application/json.

Returns

IsDeleted

`getAccountDetails`

GET /identity/v2/auth/account

Retrieve User

Retrieves User details based on the Access Token.

Example

public static void callGetAccountDetails(LoginRadiusClient client) {
  String welcomeemailtemplate = "<welcomeemailtemplate>"; //Optional
  String accessToken = "<accessToken>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional

  try {
    var response = client.user.getAccountDetails(welcomeemailtemplate, accessToken, preventWebhook, xPreventWebhook);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`welcomeemailtemplate`	query	string	no	Welcome Email Template
`access_token`	query	string	no	Access Token of the User
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Returns

IdentityResponseWithSocialWithoutLogins

`getConsentLogs`

GET /identity/v2/auth/consent/logs

Retrieve Consent Logs

Retrieves consent logs for a User based on the provided Access Token.

Example

public static void callGetConsentLogs(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional

  try {
    var response = client.user.getConsentLogs(accessToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User

Returns

ConsentLogsResponse

`getInvitation`

GET /identity/v2/auth/invitations/{invitation_token}

Retrieve invitation details

Retrieves details about a specific invitation using the invitation token.

Example

public static void callGetInvitation(LoginRadiusClient client) {
  String invitationToken = "<invitationToken>"; //Required

  try {
    var response = client.user.getInvitation(invitationToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`invitation_token`	path	string	yes	The token of the invitation to retrieve.

Returns

InvitationToken

`getInvitationByInvitationId`

GET /v2/manage/invitations/{invitationid}

Retrieve invitation by ID

Retrieves invitation details by invitation ID.

Example

public static void callGetInvitationByInvitationId(LoginRadiusClient client) {
  String invitationid = "<invitationid>"; //Required

  try {
    var response = client.user.getInvitationByInvitationId(invitationid);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`invitationid`	path	string	yes	The ID of the invitation. The ID is typically in the format inv_<unique_id>, where <unique_id> is a string of alphanumeric characters.

Returns

Invitation

`getPrivacyPolicyAcceptance`

GET /identity/v2/auth/privacypolicy/accept

Accept Privacy Policy

Updates the Privacy Policy stored in a User's profile using their Access Token.

Example

public static void callGetPrivacyPolicyAcceptance(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional

  try {
    var response = client.user.getPrivacyPolicyAcceptance(accessToken, preventWebhook, xPreventWebhook);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Returns

IdentityResponseWithSocialWithoutLogins

`getPrivacyPolicyHistory`

GET /identity/v2/auth/privacypolicy/history

Retrieve Privacy Policy History

Returns all accepted Privacy Policies for a User using their Access Token.

Example

public static void callGetPrivacyPolicyHistory(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional

  try {
    var response = client.user.getPrivacyPolicyHistory(accessToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User

Returns

PrivacyPolicyHistoryResponse

`getVerifiedConsentWithAccessToken`

GET /identity/v2/auth/consent/verify

Retrieve Consent Status

Retrieves the consent verification status for a User based on the provided Access Token and event.

Example

public static void callGetVerifiedConsentWithAccessToken(LoginRadiusClient client) {
  String event = "<event>"; //Required
  Boolean iscustom = true; //Required
  String accessToken = "<accessToken>"; //Optional

  try {
    var response = client.user.getVerifiedConsentWithAccessToken(event, iscustom, accessToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`event`	query	string	yes	Event type to filter consent verification (e.g., `login`).
`iscustom`	query	boolean	yes	This field value is used to filter the consent verification by custom events. The iscustom value should be a boolean. If true, it filters for custom events; if false, it filters for standard events.

Returns

VerifyConsent

`linkSocialIdentitiesByAccessToken`

POST /identity/v2/auth/socialidentity

Link social identities

Links a social provider account to an existing Account using Access Tokens.

Example

public static void callLinkSocialIdentitiesByAccessToken(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional
  CandidateTokenModel candidateTokenModel = new CandidateTokenModel().candidatetoken("<candidatetoken>"); //Optional

  try {
    var response = client.user.linkSocialIdentitiesByAccessToken(accessToken, preventWebhook, xPreventWebhook, candidateTokenModel);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

CandidateTokenModel as application/json.

Returns

IsPostedResponse

`linkSocialIdentitiesByPing`

POST /identity/v2/auth/socialidentity/ping

Link social identities via PING

Links a social provider account with an existing Account using the Access Token and the social provider's User Access Token.

Example

public static void callLinkSocialIdentitiesByPing(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional
  ClientGuidBodyModel clientGuidBodyModel = new ClientGuidBodyModel().clientgUID("<clientgUID>").access_token("<access_token>"); //Optional

  try {
    var response = client.user.linkSocialIdentitiesByPing(accessToken, clientGuidBodyModel);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User

Request body

ClientGuidBodyModel as application/json.

Returns

IsPostedResponse

`removePhoneIdByToken`

DELETE /identity/v2/auth/phone

Remove Phone number

Removes the User's Phone number using the Access Token.

Example

public static void callRemovePhoneIdByToken(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional

  try {
    var response = client.user.removePhoneIdByToken(accessToken, preventWebhook, xPreventWebhook);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Returns

IsDeleted

`resendEmailVerification`

PUT /identity/v2/auth/register

Resend verification Email

Resends the verification Email to the User to confirm their Email address.

Example

public static void callResendEmailVerification(LoginRadiusClient client) {
  EmailModel emailModel = new EmailModel().email("<email>"); //Required
  String verificationurl = "<verificationurl>"; //Optional
  String emailtemplate = "<emailtemplate>"; //Optional

  try {
    var response = client.user.resendEmailVerification(emailModel, verificationurl, emailtemplate);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`verificationurl`	query	string	no	Verification URL for the User which will be included in the Email template..
`emailtemplate`	query	string	no	Name of the Email template to use for this notification.

Request body

EmailModel as application/json.

Returns

IsPostedResponse

`resendPhoneOtp`

POST /identity/v2/auth/phone/otp

Resend Phone OTP

Resends the Phone OTP using either the Access Token or Phone number.

Example

public static void callResendPhoneOtp(LoginRadiusClient client) {
  String smstemplate = "<smstemplate>"; //Optional
  String accessToken = "<accessToken>"; //Optional
  Boolean isvoiceotp = true; //Optional
  PhoneIdModelOptional phoneIdModelOptional = new PhoneIdModelOptional().phone("<phone>"); //Optional

  try {
    var response = client.user.resendPhoneOtp(smstemplate, accessToken, isvoiceotp, phoneIdModelOptional);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`smstemplate`	query	string	no	SMS Template
`access_token`	query	string	no	Access Token of the User
`isvoiceotp`	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.

Request body

PhoneIdModelOptional as application/json.

Returns

SMSResponse

`sendDeleteOtp`

GET /identity/v2/auth/account/otp

Retrieve delete Account OTP

Retrieves the OTP for the specified Account to facilitate account deletion.

Example

public static void callSendDeleteOtp(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional
  String smstemplate = "<smstemplate>"; //Optional
  Boolean isvoiceotp = true; //Optional

  try {
    var response = client.user.sendDeleteOtp(accessToken, smstemplate, isvoiceotp);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`smstemplate`	query	string	no	SMS Template
`isvoiceotp`	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.

Returns

SMSResponse

`sendEmailVerification`

GET /identity/v2/auth/email/sendverificationemail

Send verification Email for social profile linking

Sends a verification Email to the unverified Email of the social profile. This is applicable only in optional verification workflows.

Example

public static void callSendEmailVerification(LoginRadiusClient client) {
  String emailtemplate = "<emailtemplate>"; //Optional
  String verificationurl = "<verificationurl>"; //Optional
  String clientguid = "<clientguid>"; //Optional
  String accessToken = "<accessToken>"; //Optional

  try {
    var response = client.user.sendEmailVerification(emailtemplate, verificationurl, clientguid, accessToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`emailtemplate`	query	string	no	Name of the Email template to use for this notification.
`verificationurl`	query	string	no	Verification URL for the User which will be included in the Email template..
`clientguid`	query	string	no	Client GUID for the request.
`access_token`	query	string	no	Access Token of the User

Returns

SendEmailVerificationResponse

`sendWelcomeEmail`

GET /identity/v2/auth/account/sendwelcomeemail

Send Welcome Email

Sends a welcome Email to the User.

Example

public static void callSendWelcomeEmail(LoginRadiusClient client) {
  String welcomeemailtemplate = "<welcomeemailtemplate>"; //Optional
  String accessToken = "<accessToken>"; //Optional

  try {
    var response = client.user.sendWelcomeEmail(welcomeemailtemplate, accessToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`welcomeemailtemplate`	query	string	no	Welcome Email Template
`access_token`	query	string	no	Access Token of the User

Returns

IsPostedResponse

`setorchangeusernamebyaccesstoken`

PUT /identity/v2/auth/username

Update Username

Sets or changes the User's Username using the Access Token.

Example

public static void callSetorchangeusernamebyaccesstoken(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional
  SetUserNameRequest setUserNameRequest = new SetUserNameRequest().username("<username>"); //Optional

  try {
    var response = client.user.setorchangeusernamebyaccesstoken(accessToken, preventWebhook, xPreventWebhook, setUserNameRequest);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

SetUserNameRequest as application/json.

Returns

IsPostedResponse

`submitConsentByAccessToken`

POST /identity/v2/auth/consent/profile

Submit Consent

Submits User consent information using an Access Token.

Example

public static void callSubmitConsentByAccessToken(LoginRadiusClient client) {
  ConsentSubmit consentSubmit = new ConsentSubmit().events("<events>").data("<data>"); //Required
  String accessToken = "<accessToken>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional

  try {
    var response = client.user.submitConsentByAccessToken(consentSubmit, accessToken, preventWebhook, xPreventWebhook);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

ConsentSubmit as application/json.

Returns

Profile

`submitConsentByConsentToken`

POST /identity/v2/auth/consent

Submit Consent with Token

Submits User consent information using a consent token.

Example

public static void callSubmitConsentByConsentToken(LoginRadiusClient client) {
  String consenttoken = "<consenttoken>"; //Required
  ConsentSubmit consentSubmit = new ConsentSubmit().events("<events>").data("<data>"); //Required
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional

  try {
    var response = client.user.submitConsentByConsentToken(consenttoken, consentSubmit, preventWebhook, xPreventWebhook);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`consenttoken`	query	string	yes	The consent token for the User.
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

ConsentSubmit as application/json.

Returns

ConsentResponse

`unlinkSocialIdentitiesByAccessToken`

DELETE /identity/v2/auth/socialidentity

Unlink social identities

Unlinks a social provider account from the specified Account using Access Tokens, removing it from the database.

Example

public static void callUnlinkSocialIdentitiesByAccessToken(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional
  UnlinkSocialIdentityRequest unlinkSocialIdentityRequest = new UnlinkSocialIdentityRequest().provider("<provider>").providerid("<providerid>"); //Optional

  try {
    var response = client.user.unlinkSocialIdentitiesByAccessToken(accessToken, preventWebhook, xPreventWebhook, unlinkSocialIdentityRequest);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

UnlinkSocialIdentityRequest as application/json.

Returns

IsDeleted

`unlockaccountbyaccesstoken`

PUT /identity/v2/auth/account/unlock

Unlock User

Unlocks a User's Account with a valid Access Token after successfully passing Bot Protection challenges.

Example

public static void callUnlockaccountbyaccesstoken(LoginRadiusClient client) {
  UnlockaccountbyaccesstokenRequest unlockaccountbyaccesstokenRequest = new UnlockaccountbyaccesstokenRequest().securityAnswer("<securityAnswer>"); //Required
  String accessToken = "<accessToken>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional
  String gRecaptchaResponse = "<gRecaptchaResponse>"; //Optional
  String qqCaptchaTicket = "<qqCaptchaTicket>"; //Optional
  String qqCaptchaRandstr = "<qqCaptchaRandstr>"; //Optional
  String hCaptchaResponse = "<hCaptchaResponse>"; //Optional

  try {
    var response = client.user.unlockaccountbyaccesstoken(unlockaccountbyaccesstokenRequest, accessToken, preventWebhook, xPreventWebhook, gRecaptchaResponse, qqCaptchaTicket, qqCaptchaRandstr, hCaptchaResponse);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.
`g-recaptcha-response`	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
`qq_captcha_ticket`	query	string	no	QQ reCAPTCHA Response
`qq_captcha_randstr`	query	string	no	QQ reCAPTCHA Response
`h-captcha-response`	query	string	no	hCaptcha Response

Request body

object as application/json.

Returns

IsPostedResponse

`updateAccountByAccessToken`

PUT /identity/v2/auth/account

Update User

Updates the User's account information using a valid Access Token.

Example

public static void callUpdateAccountByAccessToken(LoginRadiusClient client) {
  UpdateAccountByAccessTokenRequest updateAccountByAccessTokenRequest = new UpdateAccountByAccessTokenRequest().access_token("<access_token>").userName("<userName>").phoneId("<phoneId>"); //Required
  String verificationurl = "<verificationurl>"; //Optional
  String emailtemplate = "<emailtemplate>"; //Optional
  String smstemplate = "<smstemplate>"; //Optional
  Boolean nullsupport = true; //Optional
  Boolean isvoiceotp = true; //Optional
  String fields = "<fields>"; //Optional
  String gRecaptchaResponse = "<gRecaptchaResponse>"; //Optional
  String qqCaptchaTicket = "<qqCaptchaTicket>"; //Optional
  String qqCaptchaRandstr = "<qqCaptchaRandstr>"; //Optional
  String hCaptchaResponse = "<hCaptchaResponse>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional
  String accessToken = "<accessToken>"; //Optional

  try {
    var response = client.user.updateAccountByAccessToken(updateAccountByAccessTokenRequest, verificationurl, emailtemplate, smstemplate, nullsupport, isvoiceotp, fields, gRecaptchaResponse, qqCaptchaTicket, qqCaptchaRandstr, hCaptchaResponse, preventWebhook, xPreventWebhook, accessToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`verificationurl`	query	string	no	Verification URL for the User which will be included in the Email template..
`emailtemplate`	query	string	no	Name of the Email template to use for this notification.
`smstemplate`	query	string	no	SMS Template
`nullsupport`	query	boolean	no	Bool flag, if this flag is sent as true then the fields which are send in payload as null then in the profile as well that will be saved as null only
`isvoiceotp`	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.
`fields`	query	string	no	Comma-separated list of profile fields to include in the response.
`g-recaptcha-response`	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
`qq_captcha_ticket`	query	string	no	QQ reCAPTCHA Response
`qq_captcha_randstr`	query	string	no	QQ reCAPTCHA Response
`h-captcha-response`	query	string	no	hCaptcha Response
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.
`access_token`	query	string	no	Access Token of the User

Request body

object as application/json.

Returns

UpdateByTokenResponse

`updateConsentByAccessToken`

PUT /identity/v2/auth/consent

Update Consent Profile

Updates the consent profile using an Access Token.

Example

public static void callUpdateConsentByAccessToken(LoginRadiusClient client) {
  ConsentUpdate consentUpdate = new ConsentUpdate().consents("<consents>"); //Required
  String accessToken = "<accessToken>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional

  try {
    var response = client.user.updateConsentByAccessToken(consentUpdate, accessToken, preventWebhook, xPreventWebhook);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`access_token`	query	string	no	Access Token of the User
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

ConsentUpdate as application/json.

Returns

ConsentProfile

`updateEmail`

PUT /identity/v2/auth/email

Verify Email

Verifies the User's Email when OTP Email Verification is enabled, requiring LoginRadius activation.

Example

public static void callUpdateEmail(LoginRadiusClient client) {
  String url = "<url>"; //Optional
  String welcomeemailtemplate = "<welcomeemailtemplate>"; //Optional
  Boolean preventWebhook = true; //Optional
  Boolean xPreventWebhook = true; //Optional
  String gRecaptchaResponse = "<gRecaptchaResponse>"; //Optional
  String gRecaptchaResponse2 = "<gRecaptchaResponse2>"; //Optional
  String qqCaptchaTicket = "<qqCaptchaTicket>"; //Optional
  String qqCaptchaRandstr = "<qqCaptchaRandstr>"; //Optional
  String hCaptchaResponse = "<hCaptchaResponse>"; //Optional
  UpdateEmailRequest updateEmailRequest = new UpdateEmailRequest().otp("<otp>"); //Optional

  try {
    var response = client.user.updateEmail(url, welcomeemailtemplate, preventWebhook, xPreventWebhook, gRecaptchaResponse, gRecaptchaResponse2, qqCaptchaTicket, qqCaptchaRandstr, hCaptchaResponse, updateEmailRequest);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`url`	query	string	no	URL to log the main domain in the database.
`welcomeemailtemplate`	query	string	no	Welcome Email Template
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.
`g-recaptcha-response`	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
`g_recaptcha_response`	query	string	no	Google reCAPTCHA Response
`qq_captcha_ticket`	query	string	no	QQ reCAPTCHA Response
`qq_captcha_randstr`	query	string	no	QQ reCAPTCHA Response
`h-captcha-response`	query	string	no	hCaptcha Response

Request body

object as application/json.

Returns

object

`verifyPhoneOtp`

PUT /identity/v2/auth/phone/otp

Verify Phone

Validates the verification code sent to confirm a User's Phone number when the User is logged in and provides an Access Token.

Example

public static void callVerifyPhoneOtp(LoginRadiusClient client) {
  VerifyOtpPhoneModel verifyOtpPhoneModel = new VerifyOtpPhoneModel().phone("<phone>"); //Required
  String otp = "<otp>"; //Optional
  String smstemplate = "<smstemplate>"; //Optional
  String gRecaptchaResponse = "<gRecaptchaResponse>"; //Optional
  String gRecaptchaResponse2 = "<gRecaptchaResponse2>"; //Optional
  String qqCaptchaTicket = "<qqCaptchaTicket>"; //Optional
  String qqCaptchaRandstr = "<qqCaptchaRandstr>"; //Optional
  String hCaptchaResponse = "<hCaptchaResponse>"; //Optional
  String accessToken = "<accessToken>"; //Optional
  Boolean xPreventWebhook = true; //Optional
  Boolean preventWebhook = true; //Optional

  try {
    var response = client.user.verifyPhoneOtp(verifyOtpPhoneModel, otp, smstemplate, gRecaptchaResponse, gRecaptchaResponse2, qqCaptchaTicket, qqCaptchaRandstr, hCaptchaResponse, accessToken, xPreventWebhook, preventWebhook);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
`otp`	query	string	no	One-time passcode sent to the User's Email.
`smstemplate`	query	string	no	SMS Template
`g-recaptcha-response`	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
`g_recaptcha_response`	query	string	no	Google reCAPTCHA Response
`qq_captcha_ticket`	query	string	no	QQ reCAPTCHA Response
`qq_captcha_randstr`	query	string	no	QQ reCAPTCHA Response
`h-captcha-response`	query	string	no	hCaptcha Response
`access_token`	query	string	no	Access Token of the User
`X-PreventWebhook`	header	boolean	no	When true, suppresses webhook events for this operation.
`prevent_webhook`	query	boolean	no	When true, suppresses webhook events for this operation.

Request body

VerifyOtpPhoneModel as application/json.

Returns

object

FilesExpand file tree

user.md

Latest commit

History

user.md

File metadata and controls

User

accountListPasskey

Example

Parameters

Returns

accountRemovePasskey

Example

Parameters

Returns

addEmail

Example

Parameters

Request body

Returns

changePhoneNumber

Example

Parameters

Request body

Returns

checkEmailAvailability

Example

Parameters

Returns

deleteAccByPhoneOTP

Example

Parameters

Request body

Returns

deleteAccount

Example

Parameters

Returns

deleteAccountByAccessToken

Example

Parameters

Returns

deleteemailbyaccesstoken

Example

Parameters

Request body

Returns

getAccountDetails

Example

Parameters

Returns

getConsentLogs

Example

Parameters

Returns

getInvitation

Example

Parameters

Returns

getInvitationByInvitationId

Example

Parameters

Returns

getPrivacyPolicyAcceptance

Example

Parameters

Returns

getPrivacyPolicyHistory

Example

Parameters

Returns

getVerifiedConsentWithAccessToken

Example

Parameters

Returns

linkSocialIdentitiesByAccessToken

Example

Parameters

Request body

Returns

`accountListPasskey`

`accountRemovePasskey`

`addEmail`

`changePhoneNumber`

`checkEmailAvailability`

`deleteAccByPhoneOTP`

`deleteAccount`

`deleteAccountByAccessToken`

`deleteemailbyaccesstoken`

`getAccountDetails`

`getConsentLogs`

`getInvitation`

`getInvitationByInvitationId`

`getPrivacyPolicyAcceptance`

`getPrivacyPolicyHistory`

`getVerifiedConsentWithAccessToken`

`linkSocialIdentitiesByAccessToken`

`linkSocialIdentitiesByPing`

`removePhoneIdByToken`

`resendEmailVerification`

`resendPhoneOtp`

`sendDeleteOtp`

`sendEmailVerification`

`sendWelcomeEmail`

`setorchangeusernamebyaccesstoken`

`submitConsentByAccessToken`

`submitConsentByConsentToken`

`unlinkSocialIdentitiesByAccessToken`

`unlockaccountbyaccesstoken`

`updateAccountByAccessToken`

`updateConsentByAccessToken`

`updateEmail`