authenticate

Documentation

Overview

Authenticate a user.

Authenticates a user and returns information about the authenticated user. Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code.

Index

• Variables
• type Authenticate
  • func New(tp elastictransport.Interface) *Authenticate
  • func (r Authenticate) Do(providedCtx context.Context) (*Response, error)
  • func (r *Authenticate) ErrorTrace(errortrace bool) *Authenticate
  • func (r *Authenticate) FilterPath(filterpaths ...string) *Authenticate
  • func (r *Authenticate) Header(key, value string) *Authenticate
  • func (r *Authenticate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Authenticate) Human(human bool) *Authenticate
  • func (r Authenticate) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Authenticate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Authenticate) Pretty(pretty bool) *Authenticate
• type NewAuthenticate
  • func NewAuthenticateFunc(tp elastictransport.Interface) NewAuthenticate
• 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 Authenticate

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

func New

func New(tp elastictransport.Interface) *Authenticate

Authenticate a user.

Authenticates a user and returns information about the authenticated user. Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code.

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

func (Authenticate) Do

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

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

func (*Authenticate) ErrorTrace

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

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

func (*Authenticate) FilterPath

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

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

func (*Authenticate) Header

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

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

func (*Authenticate) HttpRequest

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

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

func (*Authenticate) Human

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

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 (Authenticate) IsSuccess

func (r Authenticate) 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 (Authenticate) Perform

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

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

func (*Authenticate) Pretty

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

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

type NewAuthenticate

type NewAuthenticate func() *Authenticate

NewAuthenticate type alias for index.

func NewAuthenticateFunc

func NewAuthenticateFunc(tp elastictransport.Interface) NewAuthenticate

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

type Response

type Response struct {
	ApiKey              *types.ApiKey            `json:"api_key,omitempty"`
	AuthenticationRealm types.RealmInfo          `json:"authentication_realm"`
	AuthenticationType  string                   `json:"authentication_type"`
	Email               *string                  `json:"email,omitempty"`
	Enabled             bool                     `json:"enabled"`
	FullName            *string                  `json:"full_name,omitempty"`
	LookupRealm         types.RealmInfo          `json:"lookup_realm"`
	Metadata            types.Metadata           `json:"metadata"`
	Roles               []string                 `json:"roles"`
	Token               *types.AuthenticateToken `json:"token,omitempty"`
	Username            string                   `json:"username"`
}

Response holds the response body struct for the package authenticate

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/security/authenticate/SecurityAuthenticateResponse.ts#L25-L43

func NewResponse

func NewResponse() *Response

NewResponse returns a Response