gettoken

Documentation

Overview

Creates a bearer token for access without requiring basic authentication.

Index

• Variables
• type GetToken
  • func New(tp elastictransport.Interface) *GetToken
  • func (r GetToken) Do(ctx context.Context) (*http.Response, error)
  • func (r *GetToken) Header(key, value string) *GetToken
  • func (r *GetToken) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetToken) Raw(raw json.RawMessage) *GetToken
  • func (r *GetToken) Request(req *Request) *GetToken
• type NewGetToken
  • func NewGetTokenFunc(tp elastictransport.Interface) NewGetToken
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) GrantType(granttype accesstokengranttype.AccessTokenGrantType) *RequestBuilder
  • func (rb *RequestBuilder) KerberosTicket(kerberosticket string) *RequestBuilder
  • func (rb *RequestBuilder) Password(password types.Password) *RequestBuilder
  • func (rb *RequestBuilder) RefreshToken(refreshtoken string) *RequestBuilder
  • func (rb *RequestBuilder) Scope(scope 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 GetToken

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

func New

func New(tp elastictransport.Interface) *GetToken

Creates a bearer token for access without requiring basic authentication.

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

func (GetToken) Do

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

Do runs the http.Request through the provided transport.

func (*GetToken) Header

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

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

func (*GetToken) HttpRequest

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

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

func (*GetToken) Raw

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

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

func (*GetToken) Request

func (r *GetToken) Request(req *Request) *GetToken

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

type NewGetToken

type NewGetToken func() *GetToken

NewGetToken type alias for index.

func NewGetTokenFunc

func NewGetTokenFunc(tp elastictransport.Interface) NewGetToken

NewGetTokenFunc returns a new instance of GetToken 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 {
	GrantType *accesstokengranttype.AccessTokenGrantType `json:"grant_type,omitempty"`

	KerberosTicket *string `json:"kerberos_ticket,omitempty"`

	Password *types.Password `json:"password,omitempty"`

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

	Scope *string `json:"scope,omitempty"`

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

Request holds the request body struct for the package gettoken

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/security/get_token/GetUserAccessTokenRequest.ts#L25-L39

type RequestBuilder

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

RequestBuilder is the builder API for the gettoken.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) GrantType

func (rb *RequestBuilder) GrantType(granttype accesstokengranttype.AccessTokenGrantType) *RequestBuilder

func (*RequestBuilder) KerberosTicket

func (rb *RequestBuilder) KerberosTicket(kerberosticket string) *RequestBuilder

func (*RequestBuilder) Password

func (rb *RequestBuilder) Password(password types.Password) *RequestBuilder

func (*RequestBuilder) RefreshToken

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

func (*RequestBuilder) Scope

func (rb *RequestBuilder) Scope(scope string) *RequestBuilder

func (*RequestBuilder) Username

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