gettoken

Documentation

Overview

Get a token.

Create a bearer token for access without requiring basic authentication.

Index

• Variables
• type GetToken
  • func New(tp elastictransport.Interface) *GetToken
  • func (r GetToken) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetToken) ErrorTrace(errortrace bool) *GetToken
  • func (r *GetToken) FilterPath(filterpaths ...string) *GetToken
  • func (r *GetToken) GrantType(granttype accesstokengranttype.AccessTokenGrantType) *GetToken
  • func (r *GetToken) Header(key, value string) *GetToken
  • func (r *GetToken) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetToken) Human(human bool) *GetToken
  • func (r *GetToken) KerberosTicket(kerberosticket string) *GetToken
  • func (r *GetToken) Password(password string) *GetToken
  • func (r GetToken) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetToken) Pretty(pretty bool) *GetToken
  • func (r *GetToken) Raw(raw io.Reader) *GetToken
  • func (r *GetToken) RefreshToken(refreshtoken string) *GetToken
  • func (r *GetToken) Request(req *Request) *GetToken
  • func (r *GetToken) Scope(scope string) *GetToken
  • func (r *GetToken) Username(username string) *GetToken
• type NewGetToken
  • func NewGetTokenFunc(tp elastictransport.Interface) NewGetToken
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response

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

Get a token.

Create 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(providedCtx context.Context) (*Response, error)

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

func (*GetToken) ErrorTrace

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

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

func (*GetToken) FilterPath

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

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

func (*GetToken) GrantType

func (r *GetToken) GrantType(granttype accesstokengranttype.AccessTokenGrantType) *GetToken

API name: grant_type

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

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

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 (*GetToken) KerberosTicket

func (r *GetToken) KerberosTicket(kerberosticket string) *GetToken

API name: kerberos_ticket

func (*GetToken) Password

func (r *GetToken) Password(password string) *GetToken

API name: password

func (GetToken) Perform

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

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

func (*GetToken) Pretty

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

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

func (*GetToken) Raw

func (r *GetToken) Raw(raw io.Reader) *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) RefreshToken

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

API name: refresh_token

func (*GetToken) Request

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

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

func (*GetToken) Scope

func (r *GetToken) Scope(scope string) *GetToken

API name: scope

func (*GetToken) Username

func (r *GetToken) Username(username string) *GetToken

API name: username

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       *string                                    `json:"password,omitempty"`
	RefreshToken   *string                                    `json:"refresh_token,omitempty"`
	Scope          *string                                    `json:"scope,omitempty"`
	Username       *string                                    `json:"username,omitempty"`
}

Request holds the request body struct for the package gettoken

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/security/get_token/GetUserAccessTokenRequest.ts#L25-L42

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

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
	AccessToken                         string                  `json:"access_token"`
	Authentication                      types.AuthenticatedUser `json:"authentication"`
	ExpiresIn                           int64                   `json:"expires_in"`
	KerberosAuthenticationResponseToken *string                 `json:"kerberos_authentication_response_token,omitempty"`
	RefreshToken                        *string                 `json:"refresh_token,omitempty"`
	Scope                               *string                 `json:"scope,omitempty"`
	Type                                string                  `json:"type"`
}

Response holds the response body struct for the package gettoken

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/security/get_token/GetUserAccessTokenResponse.ts#L23-L33

func NewResponse

func NewResponse() *Response

NewResponse returns a Response