oidcauthenticate

Documentation

Overview

Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair

Index

• Variables
• type NewOidcAuthenticate
  • func NewOidcAuthenticateFunc(tp elastictransport.Interface) NewOidcAuthenticate
• type OidcAuthenticate
  • func New(tp elastictransport.Interface) *OidcAuthenticate
  • func (r OidcAuthenticate) Do(ctx context.Context) (bool, error)
  • func (r *OidcAuthenticate) Header(key, value string) *OidcAuthenticate
  • func (r *OidcAuthenticate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r OidcAuthenticate) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r OidcAuthenticate) Perform(providedCtx 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 NewOidcAuthenticate

type NewOidcAuthenticate func() *OidcAuthenticate

NewOidcAuthenticate type alias for index.

func NewOidcAuthenticateFunc

func NewOidcAuthenticateFunc(tp elastictransport.Interface) NewOidcAuthenticate

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

type OidcAuthenticate

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

func New

func New(tp elastictransport.Interface) *OidcAuthenticate

Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair

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

func (OidcAuthenticate) Do

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

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

func (*OidcAuthenticate) Header

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

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

func (*OidcAuthenticate) HttpRequest

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

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

func (OidcAuthenticate) IsSuccess

func (r OidcAuthenticate) IsSuccess(providedCtx 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 (OidcAuthenticate) Perform

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

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