hasprivileges
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Check user privileges.
Determine whether the specified user has a specified list of privileges.All users can use this API, but only to determine their own privileges.To check the privileges of other users, you must use the run as feature.
Index¶
- Variables
- type 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
- type Request
- type Response
Constants¶
This section is empty.
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.
Functions¶
This section is empty.
Types¶
typeHasPrivileges¶
type HasPrivileges struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *HasPrivileges
Check user privileges.
Determine whether the specified user has a specified list of privileges.All users can use this API, but only to determine their own privileges.To check the privileges of other users, you must use the run as feature.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html
func (*HasPrivileges)Application¶added inv8.9.0
func (r *HasPrivileges) Application(applications ...types.ApplicationPrivilegesCheck) *HasPrivileges
API name: application
func (*HasPrivileges)Cluster¶added inv8.9.0
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 (rHasPrivileges) Do(providedCtxcontext.Context) (*Response,error)
Do runs the request through the transport, handle the response and returns a hasprivileges.Response
func (*HasPrivileges)ErrorTrace¶added inv8.14.0
func (r *HasPrivileges) ErrorTrace(errortracebool) *HasPrivileges
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace
func (*HasPrivileges)FilterPath¶added inv8.14.0
func (r *HasPrivileges) FilterPath(filterpaths ...string) *HasPrivileges
FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path
func (*HasPrivileges)Header¶
func (r *HasPrivileges) Header(key, valuestring) *HasPrivileges
Header set a key, value pair in the HasPrivileges headers map.
func (*HasPrivileges)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*HasPrivileges)Human¶added inv8.14.0
func (r *HasPrivileges) Human(humanbool) *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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human
func (*HasPrivileges)Index¶added inv8.9.0
func (r *HasPrivileges) Index(indices ...types.IndexPrivilegesCheck) *HasPrivileges
API name: index
func (HasPrivileges)Perform¶added inv8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*HasPrivileges)Pretty¶added inv8.14.0
func (r *HasPrivileges) Pretty(prettybool) *HasPrivileges
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty
func (*HasPrivileges)Raw¶
func (r *HasPrivileges) Raw(rawio.Reader) *HasPrivileges
Raw takes a json payload as input which is then passed to the http.RequestIf 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(userstring) *HasPrivileges
User UsernameAPI Name: user
typeNewHasPrivileges¶
type NewHasPrivileges func() *HasPrivileges
NewHasPrivileges type alias for index.
funcNewHasPrivilegesFunc¶
func NewHasPrivilegesFunc(tpelastictransport.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.
typeRequest¶
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
typeResponse¶added inv8.7.0
type Response struct {Applicationtypes.ApplicationsPrivileges `json:"application"`Cluster map[string]bool `json:"cluster"`HasAllRequestedbool `json:"has_all_requested"`Index map[string]types.Privileges `json:"index"`Usernamestring `json:"username"`}Response holds the response body struct for the package hasprivileges