samllogout

package
v8.6.0 Latest Latest
Warning

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

Go to latest
Published: Jan 11, 2023 License: Apache-2.0 Imports: 9 Imported by: 4

Documentation

Overview

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

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 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/saml_logout/Request.ts#L22-L41

func NewRequest added in v8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0

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

FromJSON allows to load an arbitrary json into the request structure

type SamlLogout

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

func New

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) (*http.Response, error)

Do runs the http.Request through the provided transport.

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) Raw

func (r *SamlLogout) Raw(raw json.RawMessage) *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.

Jump to

Keyboard shortcuts

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