getserviceaccounts

Documentation

Overview

Get service accounts.

Get a list of service accounts that match the provided path parameters.

NOTE: Currently, only the `elastic/fleet-server` service account is available.

Index

• Variables
• type GetServiceAccounts
  • func New(tp elastictransport.Interface) *GetServiceAccounts
  • func (r GetServiceAccounts) Do(providedCtx context.Context) (Response, error)
  • func (r *GetServiceAccounts) ErrorTrace(errortrace bool) *GetServiceAccounts
  • func (r *GetServiceAccounts) FilterPath(filterpaths ...string) *GetServiceAccounts
  • func (r *GetServiceAccounts) Header(key, value string) *GetServiceAccounts
  • func (r *GetServiceAccounts) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetServiceAccounts) Human(human bool) *GetServiceAccounts
  • func (r GetServiceAccounts) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetServiceAccounts) Namespace(namespace string) *GetServiceAccounts
  • func (r GetServiceAccounts) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetServiceAccounts) Pretty(pretty bool) *GetServiceAccounts
  • func (r *GetServiceAccounts) Service(service string) *GetServiceAccounts
• type NewGetServiceAccounts
  • func NewGetServiceAccountsFunc(tp elastictransport.Interface) NewGetServiceAccounts
• 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 GetServiceAccounts

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

func New

func New(tp elastictransport.Interface) *GetServiceAccounts

Get service accounts.

Get a list of service accounts that match the provided path parameters.

NOTE: Currently, only the `elastic/fleet-server` service account is available.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-service-accounts

func (GetServiceAccounts) Do

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

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

func (*GetServiceAccounts) ErrorTrace

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

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

func (*GetServiceAccounts) FilterPath

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

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

func (*GetServiceAccounts) Header

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

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

func (*GetServiceAccounts) HttpRequest

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

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

func (*GetServiceAccounts) Human

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

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 (GetServiceAccounts) IsSuccess

func (r GetServiceAccounts) 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 (*GetServiceAccounts) Namespace

func (r *GetServiceAccounts) Namespace(namespace string) *GetServiceAccounts

Namespace The name of the namespace. Omit this parameter to retrieve information about all service accounts. If you omit this parameter, you must also omit the `service` parameter. API Name: namespace

func (GetServiceAccounts) Perform

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

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

func (*GetServiceAccounts) Pretty

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

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

func (*GetServiceAccounts) Service

func (r *GetServiceAccounts) Service(service string) *GetServiceAccounts

Service The service name. Omit this parameter to retrieve information about all service accounts that belong to the specified `namespace`. API Name: service

type NewGetServiceAccounts

type NewGetServiceAccounts func() *GetServiceAccounts

NewGetServiceAccounts type alias for index.

func NewGetServiceAccountsFunc

func NewGetServiceAccountsFunc(tp elastictransport.Interface) NewGetServiceAccounts

NewGetServiceAccountsFunc returns a new instance of GetServiceAccounts with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response map[string]types.RoleDescriptorWrapper

func NewResponse

func NewResponse() Response

NewResponse returns a Response