samllogout

Documentation

Overview

Invalidates an access token and a refresh token that were generated via the SAML Authenticate API

Index

• Variables
• type NewSamlLogout
  • func NewSamlLogoutFunc(tp elastictransport.Interface) NewSamlLogout
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type SamlLogout
  • func New(tp elastictransport.Interface) *SamlLogout
  • func (r SamlLogout) Do(ctx context.Context) (*Response, error)
  • func (r *SamlLogout) Header(key, value string) *SamlLogout
  • func (r *SamlLogout) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r SamlLogout) Perform(ctx context.Context) (*http.Response, error)
  • func (r *SamlLogout) Raw(raw io.Reader) *SamlLogout
  • func (r *SamlLogout) Request(req *Request) *SamlLogout

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 NewSamlLogout

type NewSamlLogout func() *SamlLogout

NewSamlLogout type alias for index.

func NewSamlLogoutFunc

func NewSamlLogoutFunc(tp elastictransport.Interface) NewSamlLogout

NewSamlLogoutFunc returns a new instance of SamlLogout 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 {

	// RefreshToken The refresh token that was returned as a response to calling the SAML
	// authenticate API.
	// Alternatively, the most recent refresh token that was received after
	// refreshing the original access token.
	RefreshToken *string `json:"refresh_token,omitempty"`
	// Token The access token that was returned as a response to calling the SAML
	// authenticate API.
	// Alternatively, the most recent token that was received after refreshing the
	// original one by using a refresh_token.
	Token string `json:"token"`
}

Request holds the request body struct for the package samllogout

https://github.com/elastic/elasticsearch-specification/blob/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/security/saml_logout/Request.ts#L22-L41

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Redirect string `json:"redirect"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type SamlLogout

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

func New

func New(tp elastictransport.Interface) *SamlLogout

Invalidates an access token and a refresh token that were generated via the SAML Authenticate API

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

func (SamlLogout) Do

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

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

func (*SamlLogout) Header

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

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

func (*SamlLogout) HttpRequest

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

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

func (SamlLogout) Perform

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

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

func (*SamlLogout) Raw

func (r *SamlLogout) Raw(raw io.Reader) *SamlLogout

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

func (*SamlLogout) Request

func (r *SamlLogout) Request(req *Request) *SamlLogout

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