Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Parameters ¶
type Parameters struct {
IPAddress string `json:"ip_address"`
}
Parameters :
Parameters struct for post params needed for adapt auth endpoint.
Fields:
[Required] IpAddress: Ip Address of the user to be evaluated.
type Request ¶
type Request struct {
UserID string `json:"user_id"`
Params Parameters `json:"parameters"`
}
Request :
Request struct to build the required post parameters.
Fields:
[Required] UserId: the username that you want to evaluate. [Required] Params: struct for required post params.
func (*Request) EvaluateAdaptiveAuth ¶
func (r *Request) EvaluateAdaptiveAuth(c *sa.Client, userID string, ipAddress string) (*Response, error)
EvaluateAdaptiveAuth :
Helper function for making Adaptive Auth Posts
Parameters:
[Required] c: passing in the client containing authorization and host information. [Required] userId: the user you wish to evaluate via adaptive auth. [Required] ipAddress: the ip address of the user being evaluated.
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) Post ¶
Post :
Executes a post to the adaptauth endpoint.
Parameters:
[Required] r: should have all the 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.
type Response ¶
type Response struct {
RealmWorkflow string `json:"realm_workflow,omitempty"`
SuggestedAction string `json:"suggested_action,omitempty"`
RedirectURL string `json:"redirect_url,omitempty"`
Status string `json:"status"`
Message string `json:"message"`
RawJSON string `json:"-"`
HTTPResponse *http.Response `json:"-"`
}
Response :
Response struct that will be populated after the post request.
func (*Response) IsSignatureValid ¶ added in v1.1.0
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.
Source Files
Click to show internal directories.
Click to hide internal directories.