oidcprepareauthentication

Documentation

Overview

Creates an OAuth 2.0 authentication request as a URL string

Index

• Variables
• type NewOidcPrepareAuthentication
  • func NewOidcPrepareAuthenticationFunc(tp elastictransport.Interface) NewOidcPrepareAuthentication
• type OidcPrepareAuthentication
  • func New(tp elastictransport.Interface) *OidcPrepareAuthentication
  • func (r OidcPrepareAuthentication) Do(ctx context.Context) (bool, error)
  • func (r *OidcPrepareAuthentication) Header(key, value string) *OidcPrepareAuthentication
  • func (r *OidcPrepareAuthentication) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r OidcPrepareAuthentication) IsSuccess(ctx context.Context) (bool, error)
  • func (r OidcPrepareAuthentication) Perform(ctx context.Context) (*http.Response, error)

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 NewOidcPrepareAuthentication

type NewOidcPrepareAuthentication func() *OidcPrepareAuthentication

NewOidcPrepareAuthentication type alias for index.

func NewOidcPrepareAuthenticationFunc

func NewOidcPrepareAuthenticationFunc(tp elastictransport.Interface) NewOidcPrepareAuthentication

NewOidcPrepareAuthenticationFunc returns a new instance of OidcPrepareAuthentication with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type OidcPrepareAuthentication

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

func New

func New(tp elastictransport.Interface) *OidcPrepareAuthentication

Creates an OAuth 2.0 authentication request as a URL string

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

func (OidcPrepareAuthentication) Do

func (r OidcPrepareAuthentication) Do(ctx context.Context) (bool, error)

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

func (*OidcPrepareAuthentication) Header

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

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

func (*OidcPrepareAuthentication) HttpRequest

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

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

func (OidcPrepareAuthentication) IsSuccess

func (r OidcPrepareAuthentication) IsSuccess(ctx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (OidcPrepareAuthentication) Perform

func (r OidcPrepareAuthentication) Perform(ctx context.Context) (*http.Response, error)

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