samlprepareauthentication

package
v8.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 11 Imported by: 3

Documentation

Overview

Creates a SAML authentication request

Index

Constants

This section is empty.

Variables

View Source
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 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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/security/saml_prepare_authentication/Request.ts#L22-L46

func NewRequest added in v8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0

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

FromJSON allows to load an arbitrary json into the request structure

type Response added in v8.7.0

type Response struct {
	Id       string `json:"id"`
	Realm    string `json:"realm"`
	Redirect string `json:"redirect"`
}

Response holds the response body struct for the package samlprepareauthentication

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/security/saml_prepare_authentication/Response.ts#L22-L28

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

type SamlPrepareAuthentication

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

func (*SamlPrepareAuthentication) Acs added in v8.9.0

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. API name: acs

func (SamlPrepareAuthentication) Do

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

Do runs the request through the transport, handle the response and returns a samlprepareauthentication.Response

func (*SamlPrepareAuthentication) Header

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) Perform added in v8.7.0

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

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

func (*SamlPrepareAuthentication) Raw

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) Realm added in v8.9.0

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. API name: realm

func (*SamlPrepareAuthentication) RelayState added in v8.9.0

func (r *SamlPrepareAuthentication) RelayState(relaystate string) *SamlPrepareAuthentication

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. API name: relay_state

func (*SamlPrepareAuthentication) Request

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL