samlauthenticate

Documentation

Overview

Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair

Index

• Variables
• type NewSamlAuthenticate
  • func NewSamlAuthenticateFunc(tp elastictransport.Interface) NewSamlAuthenticate
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) Content(content string) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Ids(ids *types.IdsBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Realm(realm string) *RequestBuilder
• type SamlAuthenticate
  • func New(tp elastictransport.Interface) *SamlAuthenticate
  • func (r SamlAuthenticate) Do(ctx context.Context) (*http.Response, error)
  • func (r *SamlAuthenticate) Header(key, value string) *SamlAuthenticate
  • func (r *SamlAuthenticate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SamlAuthenticate) Raw(raw json.RawMessage) *SamlAuthenticate
  • func (r *SamlAuthenticate) Request(req *Request) *SamlAuthenticate

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 NewSamlAuthenticate

type NewSamlAuthenticate func() *SamlAuthenticate

NewSamlAuthenticate type alias for index.

func NewSamlAuthenticateFunc

func NewSamlAuthenticateFunc(tp elastictransport.Interface) NewSamlAuthenticate

NewSamlAuthenticateFunc returns a new instance of SamlAuthenticate 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 The SAML response as it was sent by the user’s browser, usually a Base64
	// encoded XML document.
	Content string `json:"content"`

	// Ids A json array with all the valid SAML Request Ids that the caller of the API
	// has for the current user.
	Ids types.Ids `json:"ids"`

	// Realm The name of the realm that should authenticate the SAML response. Useful in
	// cases where many SAML realms are defined.
	Realm *string `json:"realm,omitempty"`
}

Request holds the request body struct for the package samlauthenticate

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/security/saml_authenticate/Request.ts#L23-L38

type RequestBuilder

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

RequestBuilder is the builder API for the samlauthenticate.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

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

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) Content

func (rb *RequestBuilder) Content(content string) *RequestBuilder

func (*RequestBuilder) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Ids

func (rb *RequestBuilder) Ids(ids *types.IdsBuilder) *RequestBuilder

func (*RequestBuilder) Realm

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

type SamlAuthenticate

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

func New

func New(tp elastictransport.Interface) *SamlAuthenticate

Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair

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

func (SamlAuthenticate) Do

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

Do runs the http.Request through the provided transport.

func (*SamlAuthenticate) Header

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

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

func (*SamlAuthenticate) HttpRequest

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

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

func (*SamlAuthenticate) Raw

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

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

func (*SamlAuthenticate) Request

func (r *SamlAuthenticate) Request(req *Request) *SamlAuthenticate

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