samlcompletelogout

Documentation

Overview

Verifies the logout response sent from the SAML IdP.

Index

• Variables
• type NewSamlCompleteLogout
  • func NewSamlCompleteLogoutFunc(tp elastictransport.Interface) NewSamlCompleteLogout
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type SamlCompleteLogout
  • func New(tp elastictransport.Interface) *SamlCompleteLogout
  • func (r *SamlCompleteLogout) Content(content string) *SamlCompleteLogout
  • func (r *SamlCompleteLogout) ErrorTrace(errortrace bool) *SamlCompleteLogout
  • func (r *SamlCompleteLogout) FilterPath(filterpaths ...string) *SamlCompleteLogout
  • func (r *SamlCompleteLogout) Header(key, value string) *SamlCompleteLogout
  • func (r *SamlCompleteLogout) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SamlCompleteLogout) Human(human bool) *SamlCompleteLogout
  • func (r *SamlCompleteLogout) Ids(ids ...string) *SamlCompleteLogout
  • func (r SamlCompleteLogout) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *SamlCompleteLogout) Pretty(pretty bool) *SamlCompleteLogout
  • 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

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.

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

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/security/saml_complete_logout/Request.ts#L23-L40

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

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.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html

func (*SamlCompleteLogout) Content

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) ErrorTrace

func (r *SamlCompleteLogout) ErrorTrace(errortrace bool) *SamlCompleteLogout

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*SamlCompleteLogout) FilterPath

func (r *SamlCompleteLogout) FilterPath(filterpaths ...string) *SamlCompleteLogout

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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

func (r *SamlCompleteLogout) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*SamlCompleteLogout) Human

func (r *SamlCompleteLogout) Human(human bool) *SamlCompleteLogout

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*SamlCompleteLogout) Ids

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

func (r SamlCompleteLogout) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*SamlCompleteLogout) Pretty

func (r *SamlCompleteLogout) Pretty(pretty bool) *SamlCompleteLogout

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*SamlCompleteLogout) QueryString

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

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.