invalidatetoken

Documentation

Overview

Invalidates one or more access tokens or refresh tokens.

Index

• Variables
• type InvalidateToken
  • func New(tp elastictransport.Interface) *InvalidateToken
  • func (r InvalidateToken) Do(ctx context.Context) (*http.Response, error)
  • func (r *InvalidateToken) Header(key, value string) *InvalidateToken
  • func (r *InvalidateToken) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *InvalidateToken) Raw(raw json.RawMessage) *InvalidateToken
  • func (r *InvalidateToken) Request(req *Request) *InvalidateToken
• type NewInvalidateToken
  • func NewInvalidateTokenFunc(tp elastictransport.Interface) NewInvalidateToken
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) RealmName(realmname types.Name) *RequestBuilder
  • func (rb *RequestBuilder) RefreshToken(refreshtoken string) *RequestBuilder
  • func (rb *RequestBuilder) Token(token string) *RequestBuilder
  • func (rb *RequestBuilder) Username(username types.Username) *RequestBuilder

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 InvalidateToken

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

func New

func New(tp elastictransport.Interface) *InvalidateToken

Invalidates one or more access tokens or refresh tokens.

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

func (InvalidateToken) Do

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

Do runs the http.Request through the provided transport.

func (*InvalidateToken) Header

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

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

func (*InvalidateToken) HttpRequest

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

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

func (*InvalidateToken) Raw

func (r *InvalidateToken) Raw(raw json.RawMessage) *InvalidateToken

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

func (*InvalidateToken) Request

func (r *InvalidateToken) Request(req *Request) *InvalidateToken

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

type NewInvalidateToken

type NewInvalidateToken func() *InvalidateToken

NewInvalidateToken type alias for index.

func NewInvalidateTokenFunc

func NewInvalidateTokenFunc(tp elastictransport.Interface) NewInvalidateToken

NewInvalidateTokenFunc returns a new instance of InvalidateToken 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 {
	RealmName *types.Name `json:"realm_name,omitempty"`

	RefreshToken *string `json:"refresh_token,omitempty"`

	Token *string `json:"token,omitempty"`

	Username *types.Username `json:"username,omitempty"`
}

Request holds the request body struct for the package invalidatetoken

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/security/invalidate_token/SecurityInvalidateTokenRequest.ts#L23-L35

type RequestBuilder

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

RequestBuilder is the builder API for the invalidatetoken.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) RealmName

func (rb *RequestBuilder) RealmName(realmname types.Name) *RequestBuilder

func (*RequestBuilder) RefreshToken

func (rb *RequestBuilder) RefreshToken(refreshtoken string) *RequestBuilder

func (*RequestBuilder) Token

func (rb *RequestBuilder) Token(token string) *RequestBuilder

func (*RequestBuilder) Username

func (rb *RequestBuilder) Username(username types.Username) *RequestBuilder