management

package
v3.1.0-rc.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 16, 2026 License: GPL-3.0 Imports: 11 Imported by: 0

README

OpenAPI Management Bindings

This package contains generated Go model and client bindings for selected management OpenAPI operations. The source contract is server/openapi/openapi.yaml, and generation is limited by server/openapi/oapi-management-bindings.yaml to OpenAPI export, async, cache, brute-force, runtime config, and OIDC session administration endpoint tags.

The production-supported boundary for downstream callers is server/openapi/client. Use this generated package for the DTOs and generated response wrappers that boundary exposes.

The generated files are committed so normal builds do not require generator access at compile time.

Generator

This package is generated with:

github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen v2.7.0

The project keeps the generator as a vendored tool dependency. oapi-codegen v2.7.0 warns that OpenAPI 3.1 support is not complete, so generation stays narrow and is guarded by adapter, smoke, and supported-boundary tests. Gin route registration, runtime request validation, and special protocol clients stay hand-owned by Nauthilus.

Regenerating

From the repository root:

make generate-openapi-bindings

The package-local go:generate directive is equivalent:

go generate ./server/openapi/generated/management

Check that committed generated files are in sync:

make generate-openapi-bindings-check

After regenerating, run:

GOEXPERIMENT=runtimesecret GOCACHE=/tmp/nauthilus-go-cache go test ./server/openapi ./server/openapi/client ./server/openapi/generated/management ./server/handler/cache ./server/handler/bruteforce
GOEXPERIMENT=runtimesecret GOCACHE=/tmp/nauthilus-go-cache make guardrails

Documentation

Overview

Package management provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.2 DO NOT EDIT.

Package management contains generated OpenAPI model and client bindings for selected management API operations.

Index

Constants

View Source
const (
	BackchannelBasicScopes  backchannelBasicContextKey  = "backchannelBasic.Scopes"
	BackchannelBearerScopes backchannelBearerContextKey = "backchannelBearer.Scopes"
)

Variables

This section is empty.

Functions

func NewDeleteOIDCSessionRequest

func NewDeleteOIDCSessionRequest(server string, userId string, token string) (*http.Request, error)

NewDeleteOIDCSessionRequest generates requests for DeleteOIDCSession

func NewDeleteOIDCSessionsRequest

func NewDeleteOIDCSessionsRequest(server string, userId string) (*http.Request, error)

NewDeleteOIDCSessionsRequest generates requests for DeleteOIDCSessions

func NewEnqueueBruteForceRuleFlushRequest

func NewEnqueueBruteForceRuleFlushRequest(server string, body EnqueueBruteForceRuleFlushJSONRequestBody) (*http.Request, error)

NewEnqueueBruteForceRuleFlushRequest calls the generic EnqueueBruteForceRuleFlush builder with application/json body

func NewEnqueueBruteForceRuleFlushRequestWithBody

func NewEnqueueBruteForceRuleFlushRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewEnqueueBruteForceRuleFlushRequestWithBody generates requests for EnqueueBruteForceRuleFlush with any type of body

func NewEnqueueUserCacheFlushRequest

func NewEnqueueUserCacheFlushRequest(server string, body EnqueueUserCacheFlushJSONRequestBody) (*http.Request, error)

NewEnqueueUserCacheFlushRequest calls the generic EnqueueUserCacheFlush builder with application/json body

func NewEnqueueUserCacheFlushRequestWithBody

func NewEnqueueUserCacheFlushRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewEnqueueUserCacheFlushRequestWithBody generates requests for EnqueueUserCacheFlush with any type of body

func NewFlushBruteForceRuleRequest

func NewFlushBruteForceRuleRequest(server string, body FlushBruteForceRuleJSONRequestBody) (*http.Request, error)

NewFlushBruteForceRuleRequest calls the generic FlushBruteForceRule builder with application/json body

func NewFlushBruteForceRuleRequestWithBody

func NewFlushBruteForceRuleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewFlushBruteForceRuleRequestWithBody generates requests for FlushBruteForceRule with any type of body

func NewFlushUserCacheRequest

func NewFlushUserCacheRequest(server string, body FlushUserCacheJSONRequestBody) (*http.Request, error)

NewFlushUserCacheRequest calls the generic FlushUserCache builder with application/json body

func NewFlushUserCacheRequestWithBody

func NewFlushUserCacheRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewFlushUserCacheRequestWithBody generates requests for FlushUserCache with any type of body

func NewGetAsyncJobStatusRequest

func NewGetAsyncJobStatusRequest(server string, jobId string) (*http.Request, error)

NewGetAsyncJobStatusRequest generates requests for GetAsyncJobStatus

func NewGetOpenAPIJSONRequest

func NewGetOpenAPIJSONRequest(server string) (*http.Request, error)

NewGetOpenAPIJSONRequest generates requests for GetOpenAPIJSON

func NewGetOpenAPIYAMLRequest

func NewGetOpenAPIYAMLRequest(server string) (*http.Request, error)

NewGetOpenAPIYAMLRequest generates requests for GetOpenAPIYAML

func NewListBruteForceEntriesRequest

func NewListBruteForceEntriesRequest(server string, params *ListBruteForceEntriesParams) (*http.Request, error)

NewListBruteForceEntriesRequest generates requests for ListBruteForceEntries

func NewListFilteredBruteForceEntriesRequest

func NewListFilteredBruteForceEntriesRequest(server string, params *ListFilteredBruteForceEntriesParams, body ListFilteredBruteForceEntriesJSONRequestBody) (*http.Request, error)

NewListFilteredBruteForceEntriesRequest calls the generic ListFilteredBruteForceEntries builder with application/json body

func NewListFilteredBruteForceEntriesRequestWithBody

func NewListFilteredBruteForceEntriesRequestWithBody(server string, params *ListFilteredBruteForceEntriesParams, contentType string, body io.Reader) (*http.Request, error)

NewListFilteredBruteForceEntriesRequestWithBody generates requests for ListFilteredBruteForceEntries with any type of body

func NewListOIDCSessionsRequest

func NewListOIDCSessionsRequest(server string, userId string) (*http.Request, error)

NewListOIDCSessionsRequest generates requests for ListOIDCSessions

Types

type AsyncAccepted

type AsyncAccepted = AsyncAcceptedResult

AsyncAccepted defines model for AsyncAccepted.

type AsyncAcceptedPayload

type AsyncAcceptedPayload struct {
	JobId string `json:"jobId"`

	// Status The initial state returned immediately after the job is accepted.
	Status AsyncAcceptedPayloadStatus `json:"status"`
}

AsyncAcceptedPayload defines model for AsyncAcceptedPayload.

type AsyncAcceptedPayloadStatus

type AsyncAcceptedPayloadStatus string

AsyncAcceptedPayloadStatus The initial state returned immediately after the job is accepted.

const (
	AsyncAcceptedStatusQueued AsyncAcceptedPayloadStatus = "QUEUED"
)

Defines values for AsyncAcceptedPayloadStatus.

func (AsyncAcceptedPayloadStatus) Valid

func (e AsyncAcceptedPayloadStatus) Valid() bool

Valid indicates whether the value is a known member of the AsyncAcceptedPayloadStatus enum.

type AsyncAcceptedResult

type AsyncAcceptedResult struct {
	Object    string               `json:"object"`
	Operation string               `json:"operation"`
	Result    AsyncAcceptedPayload `json:"result"`
	Session   string               `json:"session"`
}

AsyncAcceptedResult defines model for AsyncAcceptedResult.

type AsyncJobStatusPayload

type AsyncJobStatusPayload struct {
	CreatedAt   *string `json:"createdAt,omitempty"`
	Error       *string `json:"error,omitempty"`
	FinishedAt  *string `json:"finishedAt,omitempty"`
	JobId       *string `json:"jobId,omitempty"`
	ResultCount *string `json:"resultCount,omitempty"`
	StartedAt   *string `json:"startedAt,omitempty"`

	// Status Current async job lifecycle state.
	Status *AsyncJobStatusPayloadStatus `json:"status,omitempty"`
	Type   *string                      `json:"type,omitempty"`
}

AsyncJobStatusPayload defines model for AsyncJobStatusPayload.

type AsyncJobStatusPayloadStatus

type AsyncJobStatusPayloadStatus string

AsyncJobStatusPayloadStatus Current async job lifecycle state.

const (
	AsyncJobStatusDone       AsyncJobStatusPayloadStatus = "DONE"
	AsyncJobStatusError      AsyncJobStatusPayloadStatus = "ERROR"
	AsyncJobStatusInProgress AsyncJobStatusPayloadStatus = "INPROGRESS"
	AsyncJobStatusQueued     AsyncJobStatusPayloadStatus = "QUEUED"
)

Defines values for AsyncJobStatusPayloadStatus.

func (AsyncJobStatusPayloadStatus) Valid

Valid indicates whether the value is a known member of the AsyncJobStatusPayloadStatus enum.

type AsyncJobStatusResult

type AsyncJobStatusResult struct {
	Object    string                `json:"object"`
	Operation string                `json:"operation"`
	Result    AsyncJobStatusPayload `json:"result"`
	Session   string                `json:"session"`
}

AsyncJobStatusResult defines model for AsyncJobStatusResult.

type BruteForceFilterRequest

type BruteForceFilterRequest struct {
	Accounts    *[]string `json:"accounts,omitempty"`
	IpAddresses *[]string `json:"ip_addresses,omitempty"`
}

BruteForceFilterRequest defines model for BruteForceFilterRequest.

type BruteForceFlushPayload

type BruteForceFlushPayload struct {
	IpAddress   *string   `json:"ip_address,omitempty"`
	OidcCid     *string   `json:"oidc_cid,omitempty"`
	Protocol    *string   `json:"protocol,omitempty"`
	RemovedKeys *[]string `json:"removed_keys,omitempty"`
	RuleName    *string   `json:"rule_name,omitempty"`
	Status      *string   `json:"status,omitempty"`
}

BruteForceFlushPayload defines model for BruteForceFlushPayload.

type BruteForceFlushRequest

type BruteForceFlushRequest struct {
	IpAddress string  `json:"ip_address"`
	OidcCid   *string `json:"oidc_cid,omitempty"`
	Protocol  *string `json:"protocol,omitempty"`
	RuleName  string  `json:"rule_name"`
}

BruteForceFlushRequest defines model for BruteForceFlushRequest.

type BruteForceFlushResult

type BruteForceFlushResult struct {
	Object    string                 `json:"object"`
	Operation string                 `json:"operation"`
	Result    BruteForceFlushPayload `json:"result"`
	Session   string                 `json:"session"`
}

BruteForceFlushResult defines model for BruteForceFlushResult.

type BruteForceListResult

type BruteForceListResult struct {
	Object    string        `json:"object"`
	Operation string        `json:"operation"`
	Result    []interface{} `json:"result"`
	Session   string        `json:"session"`
}

BruteForceListResult defines model for BruteForceListResult.

type CacheFlushPayload

type CacheFlushPayload struct {
	RemovedKeys *[]string `json:"removed_keys,omitempty"`
	Status      *string   `json:"status,omitempty"`
	User        *string   `json:"user,omitempty"`
}

CacheFlushPayload defines model for CacheFlushPayload.

type CacheFlushRequest

type CacheFlushRequest struct {
	User string `json:"user"`
}

CacheFlushRequest defines model for CacheFlushRequest.

type CacheFlushResult

type CacheFlushResult struct {
	Object    string            `json:"object"`
	Operation string            `json:"operation"`
	Result    CacheFlushPayload `json:"result"`
	Session   string            `json:"session"`
}

CacheFlushResult defines model for CacheFlushResult.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) DeleteOIDCSession

func (c *Client) DeleteOIDCSession(ctx context.Context, userId string, token string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteOIDCSessions

func (c *Client) DeleteOIDCSessions(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnqueueBruteForceRuleFlush

func (c *Client) EnqueueBruteForceRuleFlush(ctx context.Context, body EnqueueBruteForceRuleFlushJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnqueueBruteForceRuleFlushWithBody

func (c *Client) EnqueueBruteForceRuleFlushWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnqueueUserCacheFlush

func (c *Client) EnqueueUserCacheFlush(ctx context.Context, body EnqueueUserCacheFlushJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnqueueUserCacheFlushWithBody

func (c *Client) EnqueueUserCacheFlushWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FlushBruteForceRule

func (c *Client) FlushBruteForceRule(ctx context.Context, body FlushBruteForceRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FlushBruteForceRuleWithBody

func (c *Client) FlushBruteForceRuleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FlushUserCache

func (c *Client) FlushUserCache(ctx context.Context, body FlushUserCacheJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FlushUserCacheWithBody

func (c *Client) FlushUserCacheWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAsyncJobStatus

func (c *Client) GetAsyncJobStatus(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetOpenAPIJSON

func (c *Client) GetOpenAPIJSON(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetOpenAPIYAML

func (c *Client) GetOpenAPIYAML(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListBruteForceEntries

func (c *Client) ListBruteForceEntries(ctx context.Context, params *ListBruteForceEntriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListFilteredBruteForceEntriesWithBody

func (c *Client) ListFilteredBruteForceEntriesWithBody(ctx context.Context, params *ListFilteredBruteForceEntriesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListOIDCSessions

func (c *Client) ListOIDCSessions(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetAsyncJobStatus request
	GetAsyncJobStatus(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FlushBruteForceRuleWithBody request with any body
	FlushBruteForceRuleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	FlushBruteForceRule(ctx context.Context, body FlushBruteForceRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EnqueueBruteForceRuleFlushWithBody request with any body
	EnqueueBruteForceRuleFlushWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	EnqueueBruteForceRuleFlush(ctx context.Context, body EnqueueBruteForceRuleFlushJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListBruteForceEntries request
	ListBruteForceEntries(ctx context.Context, params *ListBruteForceEntriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListFilteredBruteForceEntriesWithBody request with any body
	ListFilteredBruteForceEntriesWithBody(ctx context.Context, params *ListFilteredBruteForceEntriesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ListFilteredBruteForceEntries(ctx context.Context, params *ListFilteredBruteForceEntriesParams, body ListFilteredBruteForceEntriesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FlushUserCacheWithBody request with any body
	FlushUserCacheWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	FlushUserCache(ctx context.Context, body FlushUserCacheJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EnqueueUserCacheFlushWithBody request with any body
	EnqueueUserCacheFlushWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	EnqueueUserCacheFlush(ctx context.Context, body EnqueueUserCacheFlushJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteOIDCSessions request
	DeleteOIDCSessions(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListOIDCSessions request
	ListOIDCSessions(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteOIDCSession request
	DeleteOIDCSession(ctx context.Context, userId string, token string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOpenAPIJSON request
	GetOpenAPIJSON(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOpenAPIYAML request
	GetOpenAPIYAML(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) DeleteOIDCSessionWithResponse

func (c *ClientWithResponses) DeleteOIDCSessionWithResponse(ctx context.Context, userId string, token string, reqEditors ...RequestEditorFn) (*DeleteOIDCSessionResponse, error)

DeleteOIDCSessionWithResponse request returning *DeleteOIDCSessionResponse

func (*ClientWithResponses) DeleteOIDCSessionsWithResponse

func (c *ClientWithResponses) DeleteOIDCSessionsWithResponse(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*DeleteOIDCSessionsResponse, error)

DeleteOIDCSessionsWithResponse request returning *DeleteOIDCSessionsResponse

func (*ClientWithResponses) EnqueueBruteForceRuleFlushWithBodyWithResponse

func (c *ClientWithResponses) EnqueueBruteForceRuleFlushWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EnqueueBruteForceRuleFlushResponse, error)

EnqueueBruteForceRuleFlushWithBodyWithResponse request with arbitrary body returning *EnqueueBruteForceRuleFlushResponse

func (*ClientWithResponses) EnqueueBruteForceRuleFlushWithResponse

func (c *ClientWithResponses) EnqueueBruteForceRuleFlushWithResponse(ctx context.Context, body EnqueueBruteForceRuleFlushJSONRequestBody, reqEditors ...RequestEditorFn) (*EnqueueBruteForceRuleFlushResponse, error)

func (*ClientWithResponses) EnqueueUserCacheFlushWithBodyWithResponse

func (c *ClientWithResponses) EnqueueUserCacheFlushWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EnqueueUserCacheFlushResponse, error)

EnqueueUserCacheFlushWithBodyWithResponse request with arbitrary body returning *EnqueueUserCacheFlushResponse

func (*ClientWithResponses) EnqueueUserCacheFlushWithResponse

func (c *ClientWithResponses) EnqueueUserCacheFlushWithResponse(ctx context.Context, body EnqueueUserCacheFlushJSONRequestBody, reqEditors ...RequestEditorFn) (*EnqueueUserCacheFlushResponse, error)

func (*ClientWithResponses) FlushBruteForceRuleWithBodyWithResponse

func (c *ClientWithResponses) FlushBruteForceRuleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*FlushBruteForceRuleResponse, error)

FlushBruteForceRuleWithBodyWithResponse request with arbitrary body returning *FlushBruteForceRuleResponse

func (*ClientWithResponses) FlushBruteForceRuleWithResponse

func (c *ClientWithResponses) FlushBruteForceRuleWithResponse(ctx context.Context, body FlushBruteForceRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*FlushBruteForceRuleResponse, error)

func (*ClientWithResponses) FlushUserCacheWithBodyWithResponse

func (c *ClientWithResponses) FlushUserCacheWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*FlushUserCacheResponse, error)

FlushUserCacheWithBodyWithResponse request with arbitrary body returning *FlushUserCacheResponse

func (*ClientWithResponses) FlushUserCacheWithResponse

func (c *ClientWithResponses) FlushUserCacheWithResponse(ctx context.Context, body FlushUserCacheJSONRequestBody, reqEditors ...RequestEditorFn) (*FlushUserCacheResponse, error)

func (*ClientWithResponses) GetAsyncJobStatusWithResponse

func (c *ClientWithResponses) GetAsyncJobStatusWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*GetAsyncJobStatusResponse, error)

GetAsyncJobStatusWithResponse request returning *GetAsyncJobStatusResponse

func (*ClientWithResponses) GetOpenAPIJSONWithResponse

func (c *ClientWithResponses) GetOpenAPIJSONWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenAPIJSONResponse, error)

GetOpenAPIJSONWithResponse request returning *GetOpenAPIJSONResponse

func (*ClientWithResponses) GetOpenAPIYAMLWithResponse

func (c *ClientWithResponses) GetOpenAPIYAMLWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenAPIYAMLResponse, error)

GetOpenAPIYAMLWithResponse request returning *GetOpenAPIYAMLResponse

func (*ClientWithResponses) ListBruteForceEntriesWithResponse

func (c *ClientWithResponses) ListBruteForceEntriesWithResponse(ctx context.Context, params *ListBruteForceEntriesParams, reqEditors ...RequestEditorFn) (*ListBruteForceEntriesResponse, error)

ListBruteForceEntriesWithResponse request returning *ListBruteForceEntriesResponse

func (*ClientWithResponses) ListFilteredBruteForceEntriesWithBodyWithResponse

func (c *ClientWithResponses) ListFilteredBruteForceEntriesWithBodyWithResponse(ctx context.Context, params *ListFilteredBruteForceEntriesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ListFilteredBruteForceEntriesResponse, error)

ListFilteredBruteForceEntriesWithBodyWithResponse request with arbitrary body returning *ListFilteredBruteForceEntriesResponse

func (*ClientWithResponses) ListOIDCSessionsWithResponse

func (c *ClientWithResponses) ListOIDCSessionsWithResponse(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*ListOIDCSessionsResponse, error)

ListOIDCSessionsWithResponse request returning *ListOIDCSessionsResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetAsyncJobStatusWithResponse request
	GetAsyncJobStatusWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*GetAsyncJobStatusResponse, error)

	// FlushBruteForceRuleWithBodyWithResponse request with any body
	FlushBruteForceRuleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*FlushBruteForceRuleResponse, error)

	FlushBruteForceRuleWithResponse(ctx context.Context, body FlushBruteForceRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*FlushBruteForceRuleResponse, error)

	// EnqueueBruteForceRuleFlushWithBodyWithResponse request with any body
	EnqueueBruteForceRuleFlushWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EnqueueBruteForceRuleFlushResponse, error)

	EnqueueBruteForceRuleFlushWithResponse(ctx context.Context, body EnqueueBruteForceRuleFlushJSONRequestBody, reqEditors ...RequestEditorFn) (*EnqueueBruteForceRuleFlushResponse, error)

	// ListBruteForceEntriesWithResponse request
	ListBruteForceEntriesWithResponse(ctx context.Context, params *ListBruteForceEntriesParams, reqEditors ...RequestEditorFn) (*ListBruteForceEntriesResponse, error)

	// ListFilteredBruteForceEntriesWithBodyWithResponse request with any body
	ListFilteredBruteForceEntriesWithBodyWithResponse(ctx context.Context, params *ListFilteredBruteForceEntriesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ListFilteredBruteForceEntriesResponse, error)

	ListFilteredBruteForceEntriesWithResponse(ctx context.Context, params *ListFilteredBruteForceEntriesParams, body ListFilteredBruteForceEntriesJSONRequestBody, reqEditors ...RequestEditorFn) (*ListFilteredBruteForceEntriesResponse, error)

	// FlushUserCacheWithBodyWithResponse request with any body
	FlushUserCacheWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*FlushUserCacheResponse, error)

	FlushUserCacheWithResponse(ctx context.Context, body FlushUserCacheJSONRequestBody, reqEditors ...RequestEditorFn) (*FlushUserCacheResponse, error)

	// EnqueueUserCacheFlushWithBodyWithResponse request with any body
	EnqueueUserCacheFlushWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EnqueueUserCacheFlushResponse, error)

	EnqueueUserCacheFlushWithResponse(ctx context.Context, body EnqueueUserCacheFlushJSONRequestBody, reqEditors ...RequestEditorFn) (*EnqueueUserCacheFlushResponse, error)

	// DeleteOIDCSessionsWithResponse request
	DeleteOIDCSessionsWithResponse(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*DeleteOIDCSessionsResponse, error)

	// ListOIDCSessionsWithResponse request
	ListOIDCSessionsWithResponse(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*ListOIDCSessionsResponse, error)

	// DeleteOIDCSessionWithResponse request
	DeleteOIDCSessionWithResponse(ctx context.Context, userId string, token string, reqEditors ...RequestEditorFn) (*DeleteOIDCSessionResponse, error)

	// GetOpenAPIJSONWithResponse request
	GetOpenAPIJSONWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenAPIJSONResponse, error)

	// GetOpenAPIYAMLWithResponse request
	GetOpenAPIYAMLWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenAPIYAMLResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type DeleteOIDCSessionResponse

type DeleteOIDCSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON500      *Error
}

func ParseDeleteOIDCSessionResponse

func ParseDeleteOIDCSessionResponse(rsp *http.Response) (*DeleteOIDCSessionResponse, error)

ParseDeleteOIDCSessionResponse parses an HTTP response from a DeleteOIDCSessionWithResponse call

func (DeleteOIDCSessionResponse) ContentType

func (r DeleteOIDCSessionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteOIDCSessionResponse) Status

func (r DeleteOIDCSessionResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteOIDCSessionResponse) StatusCode

func (r DeleteOIDCSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteOIDCSessionsResponse

type DeleteOIDCSessionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON500      *Error
}

func ParseDeleteOIDCSessionsResponse

func ParseDeleteOIDCSessionsResponse(rsp *http.Response) (*DeleteOIDCSessionsResponse, error)

ParseDeleteOIDCSessionsResponse parses an HTTP response from a DeleteOIDCSessionsWithResponse call

func (DeleteOIDCSessionsResponse) ContentType

func (r DeleteOIDCSessionsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteOIDCSessionsResponse) Status

Status returns HTTPResponse.Status

func (DeleteOIDCSessionsResponse) StatusCode

func (r DeleteOIDCSessionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EnqueueBruteForceRuleFlushJSONRequestBody

type EnqueueBruteForceRuleFlushJSONRequestBody = BruteForceFlushRequest

EnqueueBruteForceRuleFlushJSONRequestBody defines body for EnqueueBruteForceRuleFlush for application/json ContentType.

type EnqueueBruteForceRuleFlushResponse

type EnqueueBruteForceRuleFlushResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *AsyncAccepted
	JSON400      *JSONValidationError
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON500      *Error
}

func ParseEnqueueBruteForceRuleFlushResponse

func ParseEnqueueBruteForceRuleFlushResponse(rsp *http.Response) (*EnqueueBruteForceRuleFlushResponse, error)

ParseEnqueueBruteForceRuleFlushResponse parses an HTTP response from a EnqueueBruteForceRuleFlushWithResponse call

func (EnqueueBruteForceRuleFlushResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EnqueueBruteForceRuleFlushResponse) Status

Status returns HTTPResponse.Status

func (EnqueueBruteForceRuleFlushResponse) StatusCode

func (r EnqueueBruteForceRuleFlushResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EnqueueUserCacheFlushJSONRequestBody

type EnqueueUserCacheFlushJSONRequestBody = CacheFlushRequest

EnqueueUserCacheFlushJSONRequestBody defines body for EnqueueUserCacheFlush for application/json ContentType.

type EnqueueUserCacheFlushResponse

type EnqueueUserCacheFlushResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *AsyncAccepted
	JSON400      *JSONValidationError
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON500      *Error
}

func ParseEnqueueUserCacheFlushResponse

func ParseEnqueueUserCacheFlushResponse(rsp *http.Response) (*EnqueueUserCacheFlushResponse, error)

ParseEnqueueUserCacheFlushResponse parses an HTTP response from a EnqueueUserCacheFlushWithResponse call

func (EnqueueUserCacheFlushResponse) ContentType

func (r EnqueueUserCacheFlushResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EnqueueUserCacheFlushResponse) Status

Status returns HTTPResponse.Status

func (EnqueueUserCacheFlushResponse) StatusCode

func (r EnqueueUserCacheFlushResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error

type Error = ErrorResponse

Error defines model for Error.

type ErrorResponse

type ErrorResponse struct {
	Error string `json:"error"`
}

ErrorResponse defines model for ErrorResponse.

type FieldError

type FieldError struct {
	Field   *string `json:"field,omitempty"`
	Message *string `json:"message,omitempty"`
}

FieldError defines model for FieldError.

type FieldErrorResponse

type FieldErrorResponse struct {
	Errors []FieldError `json:"errors"`
}

FieldErrorResponse defines model for FieldErrorResponse.

type FlushBruteForceRuleJSONRequestBody

type FlushBruteForceRuleJSONRequestBody = BruteForceFlushRequest

FlushBruteForceRuleJSONRequestBody defines body for FlushBruteForceRule for application/json ContentType.

type FlushBruteForceRuleResponse

type FlushBruteForceRuleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BruteForceFlushResult
	JSON400      *JSONValidationError
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON500      *Error
}

func ParseFlushBruteForceRuleResponse

func ParseFlushBruteForceRuleResponse(rsp *http.Response) (*FlushBruteForceRuleResponse, error)

ParseFlushBruteForceRuleResponse parses an HTTP response from a FlushBruteForceRuleWithResponse call

func (FlushBruteForceRuleResponse) ContentType

func (r FlushBruteForceRuleResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (FlushBruteForceRuleResponse) Status

Status returns HTTPResponse.Status

func (FlushBruteForceRuleResponse) StatusCode

func (r FlushBruteForceRuleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FlushUserCacheJSONRequestBody

type FlushUserCacheJSONRequestBody = CacheFlushRequest

FlushUserCacheJSONRequestBody defines body for FlushUserCache for application/json ContentType.

type FlushUserCacheResponse

type FlushUserCacheResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CacheFlushResult
	JSON400      *JSONValidationError
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON500      *Error
}

func ParseFlushUserCacheResponse

func ParseFlushUserCacheResponse(rsp *http.Response) (*FlushUserCacheResponse, error)

ParseFlushUserCacheResponse parses an HTTP response from a FlushUserCacheWithResponse call

func (FlushUserCacheResponse) ContentType

func (r FlushUserCacheResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (FlushUserCacheResponse) Status

func (r FlushUserCacheResponse) Status() string

Status returns HTTPResponse.Status

func (FlushUserCacheResponse) StatusCode

func (r FlushUserCacheResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Forbidden

type Forbidden = ErrorResponse

Forbidden defines model for Forbidden.

type GetAsyncJobStatusResponse

type GetAsyncJobStatusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AsyncJobStatusResult
	JSON401      *Unauthorized
	JSON404      *NotFound
	JSON500      *Error
}

func ParseGetAsyncJobStatusResponse

func ParseGetAsyncJobStatusResponse(rsp *http.Response) (*GetAsyncJobStatusResponse, error)

ParseGetAsyncJobStatusResponse parses an HTTP response from a GetAsyncJobStatusWithResponse call

func (GetAsyncJobStatusResponse) ContentType

func (r GetAsyncJobStatusResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetAsyncJobStatusResponse) Status

func (r GetAsyncJobStatusResponse) Status() string

Status returns HTTPResponse.Status

func (GetAsyncJobStatusResponse) StatusCode

func (r GetAsyncJobStatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOpenAPIJSONResponse

type GetOpenAPIJSONResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetOpenAPIJSONResponse

func ParseGetOpenAPIJSONResponse(rsp *http.Response) (*GetOpenAPIJSONResponse, error)

ParseGetOpenAPIJSONResponse parses an HTTP response from a GetOpenAPIJSONWithResponse call

func (GetOpenAPIJSONResponse) ContentType

func (r GetOpenAPIJSONResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetOpenAPIJSONResponse) Status

func (r GetOpenAPIJSONResponse) Status() string

Status returns HTTPResponse.Status

func (GetOpenAPIJSONResponse) StatusCode

func (r GetOpenAPIJSONResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOpenAPIYAMLResponse

type GetOpenAPIYAMLResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	YAML200      *string
}

func ParseGetOpenAPIYAMLResponse

func ParseGetOpenAPIYAMLResponse(rsp *http.Response) (*GetOpenAPIYAMLResponse, error)

ParseGetOpenAPIYAMLResponse parses an HTTP response from a GetOpenAPIYAMLWithResponse call

func (GetOpenAPIYAMLResponse) ContentType

func (r GetOpenAPIYAMLResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetOpenAPIYAMLResponse) Status

func (r GetOpenAPIYAMLResponse) Status() string

Status returns HTTPResponse.Status

func (GetOpenAPIYAMLResponse) StatusCode

func (r GetOpenAPIYAMLResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type JSONValidationError

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

JSONValidationError defines model for JSONValidationError.

func (JSONValidationError) AsErrorResponse

func (t JSONValidationError) AsErrorResponse() (ErrorResponse, error)

AsErrorResponse returns the union data inside the JSONValidationError as a ErrorResponse

func (JSONValidationError) AsFieldErrorResponse

func (t JSONValidationError) AsFieldErrorResponse() (FieldErrorResponse, error)

AsFieldErrorResponse returns the union data inside the JSONValidationError as a FieldErrorResponse

func (*JSONValidationError) FromErrorResponse

func (t *JSONValidationError) FromErrorResponse(v ErrorResponse) error

FromErrorResponse overwrites any union data inside the JSONValidationError as the provided ErrorResponse

func (*JSONValidationError) FromFieldErrorResponse

func (t *JSONValidationError) FromFieldErrorResponse(v FieldErrorResponse) error

FromFieldErrorResponse overwrites any union data inside the JSONValidationError as the provided FieldErrorResponse

func (JSONValidationError) MarshalJSON

func (t JSONValidationError) MarshalJSON() ([]byte, error)

func (*JSONValidationError) MergeErrorResponse

func (t *JSONValidationError) MergeErrorResponse(v ErrorResponse) error

MergeErrorResponse performs a merge with any union data inside the JSONValidationError, using the provided ErrorResponse

func (*JSONValidationError) MergeFieldErrorResponse

func (t *JSONValidationError) MergeFieldErrorResponse(v FieldErrorResponse) error

MergeFieldErrorResponse performs a merge with any union data inside the JSONValidationError, using the provided FieldErrorResponse

func (*JSONValidationError) UnmarshalJSON

func (t *JSONValidationError) UnmarshalJSON(b []byte) error

type ListBruteForceEntriesParams

type ListBruteForceEntriesParams struct {
	// Limit Maximum number of records to return per brute-force list section.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Zero-based offset for brute-force list paging.
	Offset *PageOffset `form:"offset,omitempty" json:"offset,omitempty"`
}

ListBruteForceEntriesParams defines parameters for ListBruteForceEntries.

type ListBruteForceEntriesResponse

type ListBruteForceEntriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BruteForceListResult
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON500      *Error
}

func ParseListBruteForceEntriesResponse

func ParseListBruteForceEntriesResponse(rsp *http.Response) (*ListBruteForceEntriesResponse, error)

ParseListBruteForceEntriesResponse parses an HTTP response from a ListBruteForceEntriesWithResponse call

func (ListBruteForceEntriesResponse) ContentType

func (r ListBruteForceEntriesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListBruteForceEntriesResponse) Status

Status returns HTTPResponse.Status

func (ListBruteForceEntriesResponse) StatusCode

func (r ListBruteForceEntriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListFilteredBruteForceEntriesJSONRequestBody

type ListFilteredBruteForceEntriesJSONRequestBody = BruteForceFilterRequest

ListFilteredBruteForceEntriesJSONRequestBody defines body for ListFilteredBruteForceEntries for application/json ContentType.

type ListFilteredBruteForceEntriesParams

type ListFilteredBruteForceEntriesParams struct {
	// Limit Maximum number of records to return per brute-force list section.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Zero-based offset for brute-force list paging.
	Offset *PageOffset `form:"offset,omitempty" json:"offset,omitempty"`
}

ListFilteredBruteForceEntriesParams defines parameters for ListFilteredBruteForceEntries.

type ListFilteredBruteForceEntriesResponse

type ListFilteredBruteForceEntriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BruteForceListResult
	JSON400      *JSONValidationError
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON500      *Error
}

func ParseListFilteredBruteForceEntriesResponse

func ParseListFilteredBruteForceEntriesResponse(rsp *http.Response) (*ListFilteredBruteForceEntriesResponse, error)

ParseListFilteredBruteForceEntriesResponse parses an HTTP response from a ListFilteredBruteForceEntriesWithResponse call

func (ListFilteredBruteForceEntriesResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListFilteredBruteForceEntriesResponse) Status

Status returns HTTPResponse.Status

func (ListFilteredBruteForceEntriesResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ListOIDCSessionsResponse

type ListOIDCSessionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OIDCSessions
	JSON400      *Error
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON500      *Error
}

func ParseListOIDCSessionsResponse

func ParseListOIDCSessionsResponse(rsp *http.Response) (*ListOIDCSessionsResponse, error)

ParseListOIDCSessionsResponse parses an HTTP response from a ListOIDCSessionsWithResponse call

func (ListOIDCSessionsResponse) ContentType

func (r ListOIDCSessionsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListOIDCSessionsResponse) Status

func (r ListOIDCSessionsResponse) Status() string

Status returns HTTPResponse.Status

func (ListOIDCSessionsResponse) StatusCode

func (r ListOIDCSessionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NotFound

type NotFound = ErrorResponse

NotFound defines model for NotFound.

type OIDCSessionSummary

type OIDCSessionSummary struct {
	AuthTime    time.Time `json:"auth_time"`
	ClientId    string    `json:"client_id"`
	DisplayName *string   `json:"display_name,omitempty"`

	// Id Stable non-secret session identifier derived from the stored token.
	Id           string    `json:"id"`
	MfaCompleted *bool     `json:"mfa_completed,omitempty"`
	MfaMethod    *string   `json:"mfa_method,omitempty"`
	RedirectUri  *string   `json:"redirect_uri,omitempty"`
	Scopes       *[]string `json:"scopes,omitempty"`
	UserId       string    `json:"user_id"`
	Username     *string   `json:"username,omitempty"`
}

OIDCSessionSummary defines model for OIDCSessionSummary.

type OIDCSessions

type OIDCSessions struct {
	Sessions []OIDCSessionSummary `json:"sessions"`
}

OIDCSessions defines model for OIDCSessions.

type PageLimit

type PageLimit = int

PageLimit defines model for PageLimit.

type PageOffset

type PageOffset = int

PageOffset defines model for PageOffset.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResultEnvelope

type ResultEnvelope struct {
	Object    string      `json:"object"`
	Operation string      `json:"operation"`
	Result    interface{} `json:"result"`
	Session   string      `json:"session"`
}

ResultEnvelope defines model for ResultEnvelope.

type Unauthorized

type Unauthorized = ErrorResponse

Unauthorized defines model for Unauthorized.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL