Documentation
¶
Overview ¶
Verifies the logout response sent from the SAML IdP
Index ¶
- Variables
- type NewSamlCompleteLogout
- type Request
- type SamlCompleteLogout
- func (r *SamlCompleteLogout) Content(content string) *SamlCompleteLogout
- func (r *SamlCompleteLogout) Header(key, value string) *SamlCompleteLogout
- func (r *SamlCompleteLogout) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *SamlCompleteLogout) Ids(ids ...string) *SamlCompleteLogout
- func (r SamlCompleteLogout) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *SamlCompleteLogout) QueryString(querystring string) *SamlCompleteLogout
- func (r *SamlCompleteLogout) Raw(raw io.Reader) *SamlCompleteLogout
- func (r *SamlCompleteLogout) Realm(realm string) *SamlCompleteLogout
- func (r *SamlCompleteLogout) Request(req *Request) *SamlCompleteLogout
Constants ¶
This section is empty.
Variables ¶
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")
ErrBuildPath is returned in case of missing parameters within the build of the request.
Functions ¶
This section is empty.
Types ¶
type NewSamlCompleteLogout ¶
type NewSamlCompleteLogout func() *SamlCompleteLogout
NewSamlCompleteLogout type alias for index.
func NewSamlCompleteLogoutFunc ¶
func NewSamlCompleteLogoutFunc(tp elastictransport.Interface) NewSamlCompleteLogout
NewSamlCompleteLogoutFunc returns a new instance of SamlCompleteLogout with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// Content If the SAML IdP sends the logout response with the HTTP-Post binding, this
// field must be set to the value of the SAMLResponse form parameter from the
// logout response.
Content *string `json:"content,omitempty"`
// Ids A json array with all the valid SAML Request Ids that the caller of the API
// has for the current user.
Ids []string `json:"ids"`
// QueryString If the SAML IdP sends the logout response with the HTTP-Redirect binding,
// this field must be set to the query string of the redirect URI.
QueryString *string `json:"query_string,omitempty"`
// Realm The name of the SAML realm in Elasticsearch for which the configuration is
// used to verify the logout response.
Realm string `json:"realm"`
}
Request holds the request body struct for the package samlcompletelogout
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
func (*Request) UnmarshalJSON ¶ added in v8.12.1
type SamlCompleteLogout ¶
type SamlCompleteLogout struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *SamlCompleteLogout
Verifies the logout response sent from the SAML IdP
func (*SamlCompleteLogout) Content ¶ added in v8.9.0
func (r *SamlCompleteLogout) Content(content string) *SamlCompleteLogout
Content If the SAML IdP sends the logout response with the HTTP-Post binding, this field must be set to the value of the SAMLResponse form parameter from the logout response. API name: content
func (*SamlCompleteLogout) Header ¶
func (r *SamlCompleteLogout) Header(key, value string) *SamlCompleteLogout
Header set a key, value pair in the SamlCompleteLogout headers map.
func (*SamlCompleteLogout) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*SamlCompleteLogout) Ids ¶ added in v8.9.0
func (r *SamlCompleteLogout) Ids(ids ...string) *SamlCompleteLogout
Ids A json array with all the valid SAML Request Ids that the caller of the API has for the current user. API name: ids
func (SamlCompleteLogout) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*SamlCompleteLogout) QueryString ¶ added in v8.9.0
func (r *SamlCompleteLogout) QueryString(querystring string) *SamlCompleteLogout
QueryString If the SAML IdP sends the logout response with the HTTP-Redirect binding, this field must be set to the query string of the redirect URI. API name: query_string
func (*SamlCompleteLogout) Raw ¶
func (r *SamlCompleteLogout) Raw(raw io.Reader) *SamlCompleteLogout
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*SamlCompleteLogout) Realm ¶ added in v8.9.0
func (r *SamlCompleteLogout) Realm(realm string) *SamlCompleteLogout
Realm The name of the SAML realm in Elasticsearch for which the configuration is used to verify the logout response. API name: realm
func (*SamlCompleteLogout) Request ¶
func (r *SamlCompleteLogout) Request(req *Request) *SamlCompleteLogout
Request allows to set the request property with the appropriate payload.
Source Files