keycloak

package
v0.10.21 Latest Latest
Warning

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

Go to latest
Published: Nov 7, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGetUsersRequest

func NewGetUsersRequest(server string, realm string, params *GetUsersParams) (*http.Request, error)

NewGetUsersRequest generates requests for GetUsers

Types

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) GetUsers

func (c *Client) GetUsers(ctx context.Context, realm string, params *GetUsersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetUsers request
	GetUsers(ctx context.Context, realm string, params *GetUsersParams, 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) GetUsersWithResponse

func (c *ClientWithResponses) GetUsersWithResponse(ctx context.Context, realm string, params *GetUsersParams, reqEditors ...RequestEditorFn) (*GetUsersResponse, error)

GetUsersWithResponse request returning *GetUsersResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetUsersWithResponse request
	GetUsersWithResponse(ctx context.Context, realm string, params *GetUsersParams, reqEditors ...RequestEditorFn) (*GetUsersResponse, error)
}

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

type CredentialRepresentation

type CredentialRepresentation struct {
	Algorithm         *string              `json:"algorithm,omitempty"`
	Config            *map[string][]string `json:"config,omitempty"`
	Counter           *int32               `json:"counter,omitempty"`
	CreatedDate       *int64               `json:"createdDate,omitempty"`
	CredentialData    *string              `json:"credentialData,omitempty"`
	Device            *string              `json:"device,omitempty"`
	Digits            *int32               `json:"digits,omitempty"`
	HashIterations    *int32               `json:"hashIterations,omitempty"`
	HashedSaltedValue *string              `json:"hashedSaltedValue,omitempty"`
	Id                *string              `json:"id,omitempty"`
	Period            *int32               `json:"period,omitempty"`
	Priority          *int32               `json:"priority,omitempty"`
	Salt              *string              `json:"salt,omitempty"`
	SecretData        *string              `json:"secretData,omitempty"`
	Temporary         *bool                `json:"temporary,omitempty"`
	Type              *string              `json:"type,omitempty"`
	UserLabel         *string              `json:"userLabel,omitempty"`
	Value             *string              `json:"value,omitempty"`
}

CredentialRepresentation defines model for CredentialRepresentation.

type FederatedIdentityRepresentation

type FederatedIdentityRepresentation struct {
	IdentityProvider *string `json:"identityProvider,omitempty"`
	UserId           *string `json:"userId,omitempty"`
	UserName         *string `json:"userName,omitempty"`
}

FederatedIdentityRepresentation defines model for FederatedIdentityRepresentation.

type GetUsersParams

type GetUsersParams struct {
	// BriefRepresentation Boolean which defines whether brief representations are returned (default: false)
	BriefRepresentation *bool `form:"briefRepresentation,omitempty" json:"briefRepresentation,omitempty"`

	// Email A String contained in email, or the complete email, if param "exact" is true
	Email *string `form:"email,omitempty" json:"email,omitempty"`

	// EmailVerified whether the email has been verified
	EmailVerified *bool `form:"emailVerified,omitempty" json:"emailVerified,omitempty"`

	// Enabled Boolean representing if user is enabled or not
	Enabled *bool `form:"enabled,omitempty" json:"enabled,omitempty"`

	// Exact Boolean which defines whether the params "last", "first", "email" and "username" must match exactly
	Exact *bool `form:"exact,omitempty" json:"exact,omitempty"`

	// First Pagination offset
	First *int32 `form:"first,omitempty" json:"first,omitempty"`

	// FirstName A String contained in firstName, or the complete firstName, if param "exact" is true
	FirstName *string `form:"firstName,omitempty" json:"firstName,omitempty"`

	// IdpAlias The alias of an Identity Provider linked to the user
	IdpAlias *string `form:"idpAlias,omitempty" json:"idpAlias,omitempty"`

	// IdpUserId The userId at an Identity Provider linked to the user
	IdpUserId *string `form:"idpUserId,omitempty" json:"idpUserId,omitempty"`

	// LastName A String contained in lastName, or the complete lastName, if param "exact" is true
	LastName *string `form:"lastName,omitempty" json:"lastName,omitempty"`

	// Max Maximum results size (defaults to 100)
	Max *int32 `form:"max,omitempty" json:"max,omitempty"`

	// Q A query to search for custom attributes, in the format 'key1:value2 key2:value2'
	Q *string `form:"q,omitempty" json:"q,omitempty"`

	// Search A String contained in username, first or last name, or email. Default search behavior is prefix-based (e.g., foo or foo*). Use *foo* for infix search and "foo" for exact search.
	Search *string `form:"search,omitempty" json:"search,omitempty"`

	// Username A String contained in username, or the complete username, if param "exact" is true
	Username *string `form:"username,omitempty" json:"username,omitempty"`
}

GetUsersParams defines parameters for GetUsers.

type GetUsersResponse

type GetUsersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]UserRepresentation
}

func ParseGetUsersResponse

func ParseGetUsersResponse(rsp *http.Response) (*GetUsersResponse, error)

ParseGetUsersResponse parses an HTTP response from a GetUsersWithResponse call

func (GetUsersResponse) Status

func (r GetUsersResponse) Status() string

Status returns HTTPResponse.Status

func (GetUsersResponse) StatusCode

func (r GetUsersResponse) 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 RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type UserConsentRepresentation

type UserConsentRepresentation struct {
	ClientId            *string   `json:"clientId,omitempty"`
	CreatedDate         *int64    `json:"createdDate,omitempty"`
	GrantedClientScopes *[]string `json:"grantedClientScopes,omitempty"`
	GrantedRealmRoles   *[]string `json:"grantedRealmRoles,omitempty"`
	LastUpdatedDate     *int64    `json:"lastUpdatedDate,omitempty"`
}

UserConsentRepresentation defines model for UserConsentRepresentation.

type UserRepresentation

type UserRepresentation struct {
	Access                     *map[string]bool                   `json:"access,omitempty"`
	Attributes                 *map[string][]string               `json:"attributes,omitempty"`
	ClientConsents             *[]UserConsentRepresentation       `json:"clientConsents,omitempty"`
	ClientRoles                *map[string][]string               `json:"clientRoles,omitempty"`
	CreatedTimestamp           *int64                             `json:"createdTimestamp,omitempty"`
	Credentials                *[]CredentialRepresentation        `json:"credentials,omitempty"`
	DisableableCredentialTypes *[]string                          `json:"disableableCredentialTypes,omitempty"`
	Email                      *string                            `json:"email,omitempty"`
	EmailVerified              *bool                              `json:"emailVerified,omitempty"`
	Enabled                    *bool                              `json:"enabled,omitempty"`
	FederatedIdentities        *[]FederatedIdentityRepresentation `json:"federatedIdentities,omitempty"`
	FederationLink             *string                            `json:"federationLink,omitempty"`
	FirstName                  *string                            `json:"firstName,omitempty"`
	Groups                     *[]string                          `json:"groups,omitempty"`
	Id                         *string                            `json:"id,omitempty"`
	LastName                   *string                            `json:"lastName,omitempty"`
	NotBefore                  *int32                             `json:"notBefore,omitempty"`
	Origin                     *string                            `json:"origin,omitempty"`
	RealmRoles                 *[]string                          `json:"realmRoles,omitempty"`
	RequiredActions            *[]string                          `json:"requiredActions,omitempty"`
	Self                       *string                            `json:"self,omitempty"`
	ServiceAccountClientId     *string                            `json:"serviceAccountClientId,omitempty"`
	Totp                       *bool                              `json:"totp,omitempty"`
	Username                   *string                            `json:"username,omitempty"`
}

UserRepresentation defines model for UserRepresentation.

Jump to

Keyboard shortcuts

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