samlprepareauthentication

Documentation

Overview

Creates a SAML authentication request

Index

• Variables
• type NewSamlPrepareAuthentication
  • func NewSamlPrepareAuthenticationFunc(tp elastictransport.Interface) NewSamlPrepareAuthentication
• 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) Realm(realm string) *RequestBuilder
  • func (rb *RequestBuilder) RelayState(relaystate string) *RequestBuilder
• type SamlPrepareAuthentication
  • func New(tp elastictransport.Interface) *SamlPrepareAuthentication
  • func (r SamlPrepareAuthentication) Do(ctx context.Context) (*http.Response, error)
  • func (r *SamlPrepareAuthentication) Header(key, value string) *SamlPrepareAuthentication
  • func (r *SamlPrepareAuthentication) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SamlPrepareAuthentication) Raw(raw json.RawMessage) *SamlPrepareAuthentication
  • func (r *SamlPrepareAuthentication) Request(req *Request) *SamlPrepareAuthentication

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 NewSamlPrepareAuthentication

type NewSamlPrepareAuthentication func() *SamlPrepareAuthentication

NewSamlPrepareAuthentication type alias for index.

func NewSamlPrepareAuthenticationFunc

func NewSamlPrepareAuthenticationFunc(tp elastictransport.Interface) NewSamlPrepareAuthentication

NewSamlPrepareAuthenticationFunc returns a new instance of SamlPrepareAuthentication 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 realms in
	// Elasticsearch.
	// The realm is used to generate the authentication request. You must specify
	// either this parameter or the realm parameter.
	Acs *string `json:"acs,omitempty"`

	// Realm The name of the SAML realm in Elasticsearch for which the configuration is
	// used to generate the authentication request.
	// You must specify either this parameter or the acs parameter.
	Realm *string `json:"realm,omitempty"`

	// RelayState A string that will be included in the redirect URL that this API returns as
	// the RelayState query parameter.
	// If the Authentication Request is signed, this value is used as part of the
	// signature computation.
	RelayState *string `json:"relay_state,omitempty"`
}

Request holds the request body struct for the package samlprepareauthentication

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/security/saml_prepare_authentication/Request.ts#L22-L46

type RequestBuilder

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

RequestBuilder is the builder API for the samlprepareauthentication.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) Realm

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

func (*RequestBuilder) RelayState

func (rb *RequestBuilder) RelayState(relaystate string) *RequestBuilder

type SamlPrepareAuthentication

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

func New

func New(tp elastictransport.Interface) *SamlPrepareAuthentication

Creates a SAML authentication request

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

func (SamlPrepareAuthentication) Do

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

Do runs the http.Request through the provided transport.

func (*SamlPrepareAuthentication) Header

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

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

func (*SamlPrepareAuthentication) HttpRequest

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

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

func (*SamlPrepareAuthentication) Raw

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

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

func (*SamlPrepareAuthentication) Request

func (r *SamlPrepareAuthentication) Request(req *Request) *SamlPrepareAuthentication

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