otp

Documentation

Index

• type Request
  • func (r *Request) Post(c *sa.Client) (*Response, error)
  • func (r *Request) ValidateOTP(c *sa.Client, userID string, domain string, otp string) (*Response, error)
• type Response
  • func (r *Response) IsSignatureValid(c *sa.Client) (bool, error)

Types

type Request

type Request struct {
	UserID string `json:"user_id"`
	Domain string `json:"domain,omitempty"`
	OTP    string `json:"otp"`
}

Request :

Request struct to build the required post parameters.

Fields:

[Required] UserId: The username that you want to validate an otp for.
[Required] Domain: The domain of the user you want to validate an otp for.
[Required] OTP: The OTP you want to validate.

func (*Request) Post

func (r *Request) Post(c *sa.Client) (*Response, error)

Post :

Executes a post to the otp endpoint.

Parameters:

[Required] r: should have all required fields of the struct populated before using.
[Required] c: passing in the client containing authorization and host information.

Returns:

Response: Struct marshaled from the Json response from the API endpoints.
Error: If an error is encountered, response will be nil and the error must be handled.

func (*Request) ValidateOTP

func (r *Request) ValidateOTP(c *sa.Client, userID string, domain string, otp string) (*Response, error)

ValidateOTP :

Helper function for making Validate otp auth endpoint posts.

Parameters:

[Required] c: passing in the client containing authorization and host information.
[Required] userID: the userID of the user you wish to validate.
[Required] domain: the domain of the user you wish to validate. (optional)
[Required] otp: the otp to be validated.

Returns:

Response: Struct marshaled from the Json response from the API endpoints.
Error: If an error is encountered, response will be nil and the error must be handled.

type Response

type Response struct {
	Status       string         `json:"status"`
	Message      string         `json:"message"`
	UserID       string         `json:"user_id,omitempty"`
	RawJSON      string         `json:"-"`
	HTTPResponse *http.Response `json:"-"`
}

Response :

Response struct that will be populated after the post request.

func (*Response) IsSignatureValid

func (r *Response) IsSignatureValid(c *sa.Client) (bool, error)

IsSignatureValid :

Helper function to validate the SecureAuth Response signature in X-SA-SIGNATURE

Parameters:

[Required] r: response struct with HTTPResponse
[Required] c: passing in the client with application id and key

Returns:

bool: if true, computed signature matches X-SA-SIGNATURE. if false, computed signature does not match.
error: If an error is encountered, bool will be false and the error must be handled.