samlinvalidate

Documentation

Overview

Consumes a SAML LogoutRequest

Index

• Variables
• type NewSamlInvalidate
  • func NewSamlInvalidateFunc(tp elastictransport.Interface) NewSamlInvalidate
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Acs(acs string) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) QueryString(querystring string) *RequestBuilder
  • func (rb *RequestBuilder) Realm(realm string) *RequestBuilder
• type SamlInvalidate
  • func New(tp elastictransport.Interface) *SamlInvalidate
  • func (r SamlInvalidate) Do(ctx context.Context) (*http.Response, error)
  • func (r *SamlInvalidate) Header(key, value string) *SamlInvalidate
  • func (r *SamlInvalidate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SamlInvalidate) Raw(raw json.RawMessage) *SamlInvalidate
  • func (r *SamlInvalidate) Request(req *Request) *SamlInvalidate

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 NewSamlInvalidate

type NewSamlInvalidate func() *SamlInvalidate

NewSamlInvalidate type alias for index.

func NewSamlInvalidateFunc

func NewSamlInvalidateFunc(tp elastictransport.Interface) NewSamlInvalidate

NewSamlInvalidateFunc returns a new instance of SamlInvalidate 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 {

	// Acs The Assertion Consumer Service URL that matches the one of the SAML realm in
	// Elasticsearch that should be used. You must specify either this parameter or
	// the realm parameter.
	Acs *string `json:"acs,omitempty"`

	// QueryString The query part of the URL that the user was redirected to by the SAML IdP to
	// initiate the Single Logout.
	// This query should include a single parameter named SAMLRequest that contains
	// a SAML logout request that is deflated and Base64 encoded.
	// If the SAML IdP has signed the logout request, the URL should include two
	// extra parameters named SigAlg and Signature that contain the algorithm used
	// for the signature and the signature value itself.
	// In order for Elasticsearch to be able to verify the IdP’s signature, the
	// value of the query_string field must be an exact match to the string provided
	// by the browser.
	// The client application must not attempt to parse or process the string in any
	// way.
	QueryString string `json:"query_string"`

	// Realm The name of the SAML realm in Elasticsearch the configuration. You must
	// specify either this parameter or the acs parameter.
	Realm *string `json:"realm,omitempty"`
}

Request holds the request body struct for the package samlinvalidate

https://github.com/elastic/elasticsearch-specification/blob/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/security/saml_invalidate/Request.ts#L22-L43

type RequestBuilder

type RequestBuilder struct {
	// contains filtered or unexported fields
}

RequestBuilder is the builder API for the samlinvalidate.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Acs

func (rb *RequestBuilder) Acs(acs string) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) QueryString

func (rb *RequestBuilder) QueryString(querystring string) *RequestBuilder

func (*RequestBuilder) Realm

func (rb *RequestBuilder) Realm(realm string) *RequestBuilder

type SamlInvalidate

type SamlInvalidate struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *SamlInvalidate

Consumes a SAML LogoutRequest

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

func (SamlInvalidate) Do

func (r SamlInvalidate) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*SamlInvalidate) Header

func (r *SamlInvalidate) Header(key, value string) *SamlInvalidate

Header set a key, value pair in the SamlInvalidate headers map.

func (*SamlInvalidate) HttpRequest

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

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

func (*SamlInvalidate) Raw

func (r *SamlInvalidate) Raw(raw json.RawMessage) *SamlInvalidate

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*SamlInvalidate) Request

func (r *SamlInvalidate) Request(req *Request) *SamlInvalidate

Request allows to set the request property with the appropriate payload.