hasprivileges

Documentation

Overview

Check user privileges.

Determine whether the specified user has a specified list of privileges.

Index

• Variables
• type HasPrivileges
  • func New(tp elastictransport.Interface) *HasPrivileges
  • func (r *HasPrivileges) Application(applications ...types.ApplicationPrivilegesCheck) *HasPrivileges
  • func (r *HasPrivileges) Cluster(clusters ...clusterprivilege.ClusterPrivilege) *HasPrivileges
  • func (r HasPrivileges) Do(providedCtx context.Context) (*Response, error)
  • func (r *HasPrivileges) ErrorTrace(errortrace bool) *HasPrivileges
  • func (r *HasPrivileges) FilterPath(filterpaths ...string) *HasPrivileges
  • func (r *HasPrivileges) Header(key, value string) *HasPrivileges
  • func (r *HasPrivileges) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *HasPrivileges) Human(human bool) *HasPrivileges
  • func (r *HasPrivileges) Index(indices ...types.IndexPrivilegesCheck) *HasPrivileges
  • func (r HasPrivileges) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *HasPrivileges) Pretty(pretty bool) *HasPrivileges
  • func (r *HasPrivileges) Raw(raw io.Reader) *HasPrivileges
  • func (r *HasPrivileges) Request(req *Request) *HasPrivileges
  • func (r *HasPrivileges) User(user string) *HasPrivileges
• type NewHasPrivileges
  • func NewHasPrivilegesFunc(tp elastictransport.Interface) NewHasPrivileges
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, 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 HasPrivileges

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

func New

func New(tp elastictransport.Interface) *HasPrivileges

Check user privileges.

Determine whether the specified user has a specified list of privileges.

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

func (*HasPrivileges) Application

func (r *HasPrivileges) Application(applications ...types.ApplicationPrivilegesCheck) *HasPrivileges

API name: application

func (*HasPrivileges) Cluster

func (r *HasPrivileges) Cluster(clusters ...clusterprivilege.ClusterPrivilege) *HasPrivileges

Cluster A list of the cluster privileges that you want to check. API name: cluster

func (HasPrivileges) Do

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

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

func (*HasPrivileges) ErrorTrace

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

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

func (*HasPrivileges) FilterPath

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

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

func (*HasPrivileges) Header

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

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

func (*HasPrivileges) HttpRequest

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

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

func (*HasPrivileges) Human

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

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 (*HasPrivileges) Index

func (r *HasPrivileges) Index(indices ...types.IndexPrivilegesCheck) *HasPrivileges

API name: index

func (HasPrivileges) Perform

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

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

func (*HasPrivileges) Pretty

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

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

func (*HasPrivileges) Raw

func (r *HasPrivileges) Raw(raw io.Reader) *HasPrivileges

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

func (*HasPrivileges) Request

func (r *HasPrivileges) Request(req *Request) *HasPrivileges

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

func (*HasPrivileges) User

func (r *HasPrivileges) User(user string) *HasPrivileges

User Username API Name: user

type NewHasPrivileges

type NewHasPrivileges func() *HasPrivileges

NewHasPrivileges type alias for index.

func NewHasPrivilegesFunc

func NewHasPrivilegesFunc(tp elastictransport.Interface) NewHasPrivileges

NewHasPrivilegesFunc returns a new instance of HasPrivileges 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 {
	Application []types.ApplicationPrivilegesCheck `json:"application,omitempty"`
	// Cluster A list of the cluster privileges that you want to check.
	Cluster []clusterprivilege.ClusterPrivilege `json:"cluster,omitempty"`
	Index   []types.IndexPrivilegesCheck        `json:"index,omitempty"`
}

Request holds the request body struct for the package hasprivileges

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L46

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

type Response

type Response struct {
	Application     types.ApplicationsPrivileges `json:"application"`
	Cluster         map[string]bool              `json:"cluster"`
	HasAllRequested bool                         `json:"has_all_requested"`
	Index           map[string]types.Privileges  `json:"index"`
	Username        string                       `json:"username"`
}

Response holds the response body struct for the package hasprivileges

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/security/has_privileges/SecurityHasPrivilegesResponse.ts#L24-L32

func NewResponse

func NewResponse() *Response

NewResponse returns a Response