getservicecredentials

Documentation

Overview

Get service account credentials.

To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).

The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.

NOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster. Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetServiceCredentials

Get service account credentials.

To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).

The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.

NOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster. Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html

func (GetServiceCredentials) Do

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

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

func (*GetServiceCredentials) ErrorTrace

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

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

func (*GetServiceCredentials) FilterPath

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

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

func (*GetServiceCredentials) Header

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

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

func (*GetServiceCredentials) HttpRequest

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

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

func (*GetServiceCredentials) Human

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

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

func (r GetServiceCredentials) 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 (GetServiceCredentials) Perform

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

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

func (*GetServiceCredentials) Pretty

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

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

type NewGetServiceCredentials

type NewGetServiceCredentials func(namespace, service string) *GetServiceCredentials

NewGetServiceCredentials type alias for index.

func NewGetServiceCredentialsFunc

func NewGetServiceCredentialsFunc(tp elastictransport.Interface) NewGetServiceCredentials

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

type Response

type Response struct {
	Count int `json:"count"`
	// NodesCredentials Service account credentials collected from all nodes of the cluster.
	NodesCredentials types.NodesCredentials    `json:"nodes_credentials"`
	ServiceAccount   string                    `json:"service_account"`
	Tokens           map[string]types.Metadata `json:"tokens"`
}

Response holds the response body struct for the package getservicecredentials

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/get_service_credentials/GetServiceCredentialsResponse.ts#L25-L34

func NewResponse

func NewResponse() *Response

NewResponse returns a Response