Documentation
¶
Overview ¶
Retrieves security privileges for the logged in user.
Index ¶
- Variables
- type GetUserPrivileges
- func (r *GetUserPrivileges) Application(name string) *GetUserPrivileges
- func (r GetUserPrivileges) Do(providedCtx context.Context) (*Response, error)
- func (r *GetUserPrivileges) Header(key, value string) *GetUserPrivileges
- func (r *GetUserPrivileges) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetUserPrivileges) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetUserPrivileges) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetUserPrivileges) Priviledge(name string) *GetUserPrivileges
- func (r *GetUserPrivileges) Username(username string) *GetUserPrivileges
- type NewGetUserPrivileges
- 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 GetUserPrivileges ¶
type GetUserPrivileges struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetUserPrivileges
Retrieves security privileges for the logged in user.
func (*GetUserPrivileges) Application ¶
func (r *GetUserPrivileges) Application(name string) *GetUserPrivileges
Application The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications. API name: application
func (GetUserPrivileges) Do ¶
func (r GetUserPrivileges) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getuserprivileges.Response
func (*GetUserPrivileges) Header ¶
func (r *GetUserPrivileges) Header(key, value string) *GetUserPrivileges
Header set a key, value pair in the GetUserPrivileges headers map.
func (*GetUserPrivileges) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetUserPrivileges) IsSuccess ¶
func (r GetUserPrivileges) 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 (GetUserPrivileges) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetUserPrivileges) Priviledge ¶
func (r *GetUserPrivileges) Priviledge(name string) *GetUserPrivileges
Priviledge The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application. API name: priviledge
func (*GetUserPrivileges) Username ¶
func (r *GetUserPrivileges) Username(username string) *GetUserPrivileges
API name: username
type NewGetUserPrivileges ¶
type NewGetUserPrivileges func() *GetUserPrivileges
NewGetUserPrivileges type alias for index.
func NewGetUserPrivilegesFunc ¶
func NewGetUserPrivilegesFunc(tp elastictransport.Interface) NewGetUserPrivileges
NewGetUserPrivilegesFunc returns a new instance of GetUserPrivileges with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response struct {
Applications []types.ApplicationPrivileges `json:"applications"`
Cluster []string `json:"cluster"`
Global []types.GlobalPrivilege `json:"global"`
Indices []types.UserIndicesPrivileges `json:"indices"`
RunAs []string `json:"run_as"`
}
Response holds the response body struct for the package getuserprivileges
Source Files