Documentation
¶
Overview ¶
Invalidates one or more access tokens or refresh tokens.
Index ¶
- Variables
- type InvalidateToken
- func (r InvalidateToken) Do(providedCtx context.Context) (*Response, error)
- func (r *InvalidateToken) Header(key, value string) *InvalidateToken
- func (r *InvalidateToken) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r InvalidateToken) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *InvalidateToken) Raw(raw io.Reader) *InvalidateToken
- func (r *InvalidateToken) RealmName(name string) *InvalidateToken
- func (r *InvalidateToken) RefreshToken(refreshtoken string) *InvalidateToken
- func (r *InvalidateToken) Request(req *Request) *InvalidateToken
- func (r *InvalidateToken) Token(token string) *InvalidateToken
- func (r *InvalidateToken) Username(username string) *InvalidateToken
- type NewInvalidateToken
- 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 InvalidateToken ¶
type InvalidateToken struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *InvalidateToken
Invalidates one or more access tokens or refresh tokens.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html
func (InvalidateToken) Do ¶
func (r InvalidateToken) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a invalidatetoken.Response
func (*InvalidateToken) Header ¶
func (r *InvalidateToken) Header(key, value string) *InvalidateToken
Header set a key, value pair in the InvalidateToken headers map.
func (*InvalidateToken) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (InvalidateToken) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*InvalidateToken) Raw ¶
func (r *InvalidateToken) Raw(raw io.Reader) *InvalidateToken
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*InvalidateToken) RealmName ¶ added in v8.9.0
func (r *InvalidateToken) RealmName(name string) *InvalidateToken
API name: realm_name
func (*InvalidateToken) RefreshToken ¶ added in v8.9.0
func (r *InvalidateToken) RefreshToken(refreshtoken string) *InvalidateToken
API name: refresh_token
func (*InvalidateToken) Request ¶
func (r *InvalidateToken) Request(req *Request) *InvalidateToken
Request allows to set the request property with the appropriate payload.
func (*InvalidateToken) Token ¶ added in v8.9.0
func (r *InvalidateToken) Token(token string) *InvalidateToken
API name: token
func (*InvalidateToken) Username ¶ added in v8.9.0
func (r *InvalidateToken) Username(username string) *InvalidateToken
API name: username
type NewInvalidateToken ¶
type NewInvalidateToken func() *InvalidateToken
NewInvalidateToken type alias for index.
func NewInvalidateTokenFunc ¶
func NewInvalidateTokenFunc(tp elastictransport.Interface) NewInvalidateToken
NewInvalidateTokenFunc returns a new instance of InvalidateToken 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 {
RealmName *string `json:"realm_name,omitempty"`
RefreshToken *string `json:"refresh_token,omitempty"`
Token *string `json:"token,omitempty"`
Username *string `json:"username,omitempty"`
}
Request holds the request body struct for the package invalidatetoken
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
func (*Request) UnmarshalJSON ¶ added in v8.12.1
type Response ¶ added in v8.7.0
type Response struct {
ErrorCount int64 `json:"error_count"`
ErrorDetails []types.ErrorCause `json:"error_details,omitempty"`
InvalidatedTokens int64 `json:"invalidated_tokens"`
PreviouslyInvalidatedTokens int64 `json:"previously_invalidated_tokens"`
}
Response holds the response body struct for the package invalidatetoken
Source Files