samllogout

package
v9.0.0 Latest Latest
Warning

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

Go to latest
Published: Apr 17, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Logout of SAML.

Submits a request to invalidate an access token and refresh token.

NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

This API invalidates the tokens that were generated for a user by the SAML authenticate API. If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).

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/52c473efb1fb5320a5bac12572d0b285882862fb/specification/security/saml_logout/Request.ts#L22-L57

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 A URL that contains a SAML logout request as a parameter.
	// You can use this URL to be redirected back to the SAML IdP and to initiate
	// Single Logout.
	Redirect string `json:"redirect"`
}

Response holds the response body struct for the package samllogout

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/security/saml_logout/Response.ts#L20-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type SamlLogout

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

func New

Logout of SAML.

Submits a request to invalidate an access token and refresh token.

NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

This API invalidates the tokens that were generated for a user by the SAML authenticate API. If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-logout

func (SamlLogout) Do

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

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

func (*SamlLogout) ErrorTrace

func (r *SamlLogout) ErrorTrace(errortrace bool) *SamlLogout

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*SamlLogout) FilterPath

func (r *SamlLogout) FilterPath(filterpaths ...string) *SamlLogout

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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

func (r *SamlLogout) Human(human bool) *SamlLogout

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (SamlLogout) Perform

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

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

func (*SamlLogout) Pretty

func (r *SamlLogout) Pretty(pretty bool) *SamlLogout

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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

func (r *SamlLogout) RefreshToken(refreshtoken string) *SamlLogout

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

func (*SamlLogout) Request

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

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

func (*SamlLogout) Token

func (r *SamlLogout) Token(token string) *SamlLogout

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

close