getuser

Documentation

Overview

Get users.

Get information about users in the native realm and built-in users.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetUser

Get users.

Get information about users in the native realm and built-in users.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-user

func (GetUser) Do

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

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

func (*GetUser) ErrorTrace

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

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

func (*GetUser) FilterPath

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

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

func (*GetUser) Header

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

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

func (*GetUser) HttpRequest

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

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

func (*GetUser) Human

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

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

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

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

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

func (*GetUser) Pretty

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

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

func (*GetUser) Username

func (r *GetUser) Username(usernames ...string) *GetUser

Username An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users. API Name: username

func (*GetUser) WithProfileUid

func (r *GetUser) WithProfileUid(withprofileuid bool) *GetUser

WithProfileUid Determines whether to retrieve the user profile UID, if it exists, for the users. API name: with_profile_uid

type NewGetUser

type NewGetUser func() *GetUser

NewGetUser type alias for index.

func NewGetUserFunc

func NewGetUserFunc(tp elastictransport.Interface) NewGetUser

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

type Response

type Response map[string]types.User

func NewResponse

func NewResponse() Response

NewResponse returns a Response