getuser

Documentation

Overview

Retrieves 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) Header(key, value string) *GetUser
  • func (r *GetUser) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetUser) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetUser) Perform(providedCtx context.Context) (*http.Response, error)
  • 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

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

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

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) 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) 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) 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 If true will return the User Profile ID for a user, if any. 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