oidclogout

package
v8.13.1 Latest Latest
Warning

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

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 9 Imported by: 3

Documentation

Overview

Invalidates a refresh token and access token that was generated from the OpenID Connect 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 NewOidcLogout

type NewOidcLogout func() *OidcLogout

NewOidcLogout type alias for index.

func NewOidcLogoutFunc

func NewOidcLogoutFunc(tp elastictransport.Interface) NewOidcLogout

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

type OidcLogout

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

func New

Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API

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

func (OidcLogout) Do

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

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

func (*OidcLogout) Header

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

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

func (*OidcLogout) HttpRequest

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

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

func (OidcLogout) IsSuccess

func (r OidcLogout) 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 (OidcLogout) Perform added in v8.7.0

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

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

Jump to

Keyboard shortcuts

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