Documentation
¶
Overview ¶
Determines whether the specified user has a specified list of privileges.
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) Header(key, value string) *HasPrivileges
- func (r *HasPrivileges) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *HasPrivileges) Index(indices ...types.IndexPrivilegesCheck) *HasPrivileges
- func (r HasPrivileges) Perform(providedCtx context.Context) (*http.Response, error)
- 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 ¶
type HasPrivileges ¶
type HasPrivileges struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *HasPrivileges
Determines 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 ¶ added in v8.9.0
func (r *HasPrivileges) Application(applications ...types.ApplicationPrivilegesCheck) *HasPrivileges
API name: application
func (*HasPrivileges) Cluster ¶ added in v8.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 (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) Header ¶
func (r *HasPrivileges) Header(key, value string) *HasPrivileges
Header set a key, value pair in the HasPrivileges headers map.
func (*HasPrivileges) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*HasPrivileges) Index ¶ added in v8.9.0
func (r *HasPrivileges) Index(indices ...types.IndexPrivilegesCheck) *HasPrivileges
API name: index
func (HasPrivileges) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
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
type Response ¶ added in v8.7.0
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
Source Files