Movatterモバイル変換


[0]ホーム

URL:


Notice  The highest tagged major version isv9.

hasprivileges

package
v8.19.1Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 12, 2025 License:Apache-2.0Imports:13Imported by:5

Details

Repository

github.com/elastic/go-elasticsearch

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

Constants

This section is empty.

Variables

View Source
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

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)Applicationadded inv8.9.0

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

API name: application

func (*HasPrivileges)Clusteradded inv8.9.0

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)ErrorTraceadded 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)FilterPathadded 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

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

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

func (*HasPrivileges)Humanadded 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)Indexadded inv8.9.0

API name: index

func (HasPrivileges)Performadded inv8.7.0

func (rHasPrivileges) Perform(providedCtxcontext.Context) (*http.Response,error)

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

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

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

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L59

funcNewRequestadded inv8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request)FromJSONadded inv8.5.0

func (r *Request) FromJSON(datastring) (*Request,error)

FromJSON allows to load an arbitrary json into the request structure

typeResponseadded 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

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/security/has_privileges/SecurityHasPrivilegesResponse.ts#L24-L35

funcNewResponseadded inv8.7.0

func NewResponse() *Response

NewResponse returns a Response

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp