lrbody

package
v0.0.0-...-5999da7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 3, 2022 License: MIT Imports: 0 Imported by: 8

Documentation

Overview

The lrbody package holds the structs to be encoded as the body in POST and PUT calls These structs are meant to serve as convenient measures assisting API calls provided by the Loginradius Go SDK All functions in this SDK takes interface{} as the body, but initiating your data in the appropriate struct and passing in place of the body when calling the SDK functions will ensure the parameters submitted are correctly formatted and named for the LoginRadius APIs The usage of the structs in this package is optional and provided for convenience only Majority of methods take map[string]string as body parameter as well. These structs provide reference only, and do not include optional parameters

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountCreate

type AccountCreate struct {
	Email    EmailArray
	Password string
}

Used by PostManageAccountCreate

type AccountPassword

type AccountPassword struct {
	Password string `json:"Password"`
}

Used by PutManageAccountSetPassword

type AccountSecurityQuestion

type AccountSecurityQuestion struct {
	Securityquestionanswer accountSecurityQA `json:"securityquestionanswer"`
}

Used by PutManageAccountUpdateSecurityQuestionConfig

type AddEmail

type AddEmail struct {
	Type  string `json:"type"`
	Email string `json:"email"`
}

Used by PostAuthAddEmail

type AuthEmail

type AuthEmail struct {
	Type  string `json:"Type"`
	Value string `json:"Value"`
}

Used by PostAuthUserRegistrationByEmail

type AuthUsername

type AuthUsername struct {
	Username string `json:"username"`
}

type ChangePassword

type ChangePassword struct {
	OldPw string `json:"oldpassword"`
	NewPw string `json:"newpassword"`
}

used by PutAuthChangePassword

type Email

type Email struct {
	Email string `json:"Email"`
}

Used by PostManageEmailVerificationToken, PostManageForgotPasswordToken

type EmailArray

type EmailArray []struct {
	Type  string
	Value string
}

Used by PostManageAccountCreate

type EmailLogin

type EmailLogin struct {
	Email    string `json:"Email"`
	Password string `json:"Password"`
}

Used by PostAuthLoginByEmail

type EmailStr

type EmailStr struct {
	Email string
}

Used by PostAuthForgotPassword, PutResendEmailVerification, DeleteAuthRemoveEmail

type LinkeSocialIds

type LinkeSocialIds struct {
	CandidateToken string `json:"candidatetoken"`
}

used by PutAuthLinkSocialIdentities

type PermissionList

type PermissionList struct {
	Permissions []string `json:"permissions"`
}

Used by PutAccountAddPermissionsToRole, DeleteRolesAccountRemovePermissions

type RegistrationUser

type RegistrationUser struct {
	Email    []AuthEmail `json:"Email"`
	Password string      `json:"Password"`
}

Used by PostAuthUserRegistrationByEmail

type ResetPw

type ResetPw struct {
	ResetToken string `json:"resettoken"`
	Password   string `json:"password"`
}

used by PutAuthResetPasswordByResetToken

type ResetPwOtp

type ResetPwOtp struct {
	Email    string `json:"email"`
	Password string `json:"password"`
	Otp      string `json:"otp"`
}

used by PutAuthResetPasswordByOTP

type ResetPwSecurityQuestionEmail

type ResetPwSecurityQuestionEmail struct {
	Email          string `json:"email"`
	SecurityAnswer string `json:"securityanswer"`
	Password       string `json:"Password"`
}

used by PutAuthResetPasswordBySecurityAnswerAndEmail

type ResetPwSecurityQuestionPhone

type ResetPwSecurityQuestionPhone struct {
	Phone          string `json:"phone"`
	SecurityAnswer string `json:"securityanswer"`
	Password       string `json:"password"`
}

used by PutAuthResetPasswordBySecurityAnswerAndPhone

type ResetPwSecurityQuestionUsername

type ResetPwSecurityQuestionUsername struct {
	Username       string `json:"username"`
	SecurityAnswer string `json:"securityanswer"`
	Password       string `json:"password"`
}

used by PutAuthResetPasswordBySecurityAnswerAndUsername

type Role

type Role struct {
	Name        string          `json:"name"`
	Permissions map[string]bool `json:"permissions"`
}

type RoleList

type RoleList struct {
	Roles []string `json:"roles"`
}

Used by PutRolesAssignToUser

type Roles

type Roles struct {
	Roles []Role `json:"roles"`
}

Used by PostRolesCreate

type SecurityQuestionAnswer

type SecurityQuestionAnswer struct {
	SecurityAnswer string `json:"2acec20722394dc3bd6362ef27df824e"`
}

Used by PutAuthUpdateSecurityQuestionByEmail

type UpdateProfile

type UpdateProfile struct {
	Firstname string `json:"FirstName"`
	Lastname  string `json:"LastName"`
	Gender    string `json:"Gender"`
	Birthdate string `json:"BirthDate"`
	Country   string `json:"Country"`
	City      string `json:"City"`
	State     string `json:"State"`
}

Used by PutAuthUpdateProfileByToken, PutManageAccountUpdate This serves as an example of struct that can be passed as the body for these endpoints Please adjust accordingly based on the field that needs to be updated For more information refer to https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-update

type Username

type Username struct {
	Username string `json:"Username"`
}

Used by PostManageForgotPasswordToken

type UsernameLogin

type UsernameLogin struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

Used by PostAuthLoginByUsername

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL