Versions in this module Expand all Collapse all v0 v0.1.0 Sep 16, 2026 Changes in this version + func NewCreateRealmRequest(server string, body CreateRealmJSONRequestBody) (*http.Request, error) + func NewCreateRealmRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error) + func NewDeleteRealmRequest(server string, realm string) (*http.Request, error) + func NewGetRealmRequest(server string, realm string) (*http.Request, error) + func NewListRealmsRequest(server string, params *ListRealmsParams) (*http.Request, error) + func NewPatchRealmRequest(server string, realm string, body PatchRealmJSONRequestBody) (*http.Request, error) + func NewPatchRealmRequestWithBody(server string, realm string, contentType string, body io.Reader) (*http.Request, error) + func NewUpdateRealmRequest(server string, realm string, body UpdateRealmJSONRequestBody) (*http.Request, error) + func NewUpdateRealmRequestWithBody(server string, realm string, contentType string, body io.Reader) (*http.Request, error) + type APIError = lock.APIError + type Client struct + Client HttpRequestDoer + RequestEditors []RequestEditorFn + Server string + func NewClient(server string, opts ...ClientOption) (*Client, error) + func (c *Client) CreateRealm(ctx context.Context, body CreateRealmJSONRequestBody, ...) (*RealmResponse, error) + func (c *Client) CreateRealmWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*RealmResponse, error) + func (c *Client) DeleteRealm(ctx context.Context, realm string, reqEditors ...RequestEditorFn) (*Response, error) + func (c *Client) GetRealm(ctx context.Context, realm string, reqEditors ...RequestEditorFn) (*RealmResponse, error) + func (c *Client) ListRealms(ctx context.Context, params *ListRealmsParams, reqEditors ...RequestEditorFn) (*RealmCollection, error) + func (c *Client) PatchRealm(ctx context.Context, realm string, body PatchRealmJSONRequestBody, ...) (*RealmResponse, error) + func (c *Client) PatchRealmWithBody(ctx context.Context, realm string, contentType string, body io.Reader, ...) (*RealmResponse, error) + func (c *Client) UpdateRealm(ctx context.Context, realm string, body UpdateRealmJSONRequestBody, ...) (*RealmResponse, error) + func (c *Client) UpdateRealmWithBody(ctx context.Context, realm string, contentType string, body io.Reader, ...) (*RealmResponse, error) + type ClientInterface interface + CreateRealm func(ctx context.Context, body CreateRealmJSONRequestBody, ...) (*RealmResponse, error) + CreateRealmWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*RealmResponse, error) + DeleteRealm func(ctx context.Context, realm string, reqEditors ...RequestEditorFn) (*Response, error) + GetRealm func(ctx context.Context, realm string, reqEditors ...RequestEditorFn) (*RealmResponse, error) + ListRealms func(ctx context.Context, params *ListRealmsParams, reqEditors ...RequestEditorFn) (*RealmCollection, error) + PatchRealm func(ctx context.Context, realm string, body PatchRealmJSONRequestBody, ...) (*RealmResponse, error) + PatchRealmWithBody func(ctx context.Context, realm string, contentType string, body io.Reader, ...) (*RealmResponse, error) + UpdateRealm func(ctx context.Context, realm string, body UpdateRealmJSONRequestBody, ...) (*RealmResponse, error) + UpdateRealmWithBody func(ctx context.Context, realm string, contentType string, body io.Reader, ...) (*RealmResponse, error) + type ClientOption func(*Client) error + func WithHTTPClient(doer HttpRequestDoer) ClientOption + func WithRequestEditorFn(fn RequestEditorFn) ClientOption + func WithToken(token string) ClientOption + type CreateRealm401JSONResponseBodyError string + const CreateRealm401JSONResponseBodyErrorInvalidToken + func (e CreateRealm401JSONResponseBodyError) Valid() bool + type CreateRealm403JSONResponseBodyError string + const CreateRealm403JSONResponseBodyErrorInsufficientScope + func (e CreateRealm403JSONResponseBodyError) Valid() bool + type CreateRealmData struct + Domain string + Name string + Settings *RealmSettingsPatch + Slug string + type CreateRealmJSONRequestBody = CreateRealmData + type DeleteRealm401JSONResponseBodyError string + const DeleteRealm401JSONResponseBodyErrorInvalidToken + func (e DeleteRealm401JSONResponseBodyError) Valid() bool + type DeleteRealm403JSONResponseBodyError string + const DeleteRealm403JSONResponseBodyErrorInsufficientScope + func (e DeleteRealm403JSONResponseBodyError) Valid() bool + type GetRealm401JSONResponseBodyError string + const GetRealm401JSONResponseBodyErrorInvalidToken + func (e GetRealm401JSONResponseBodyError) Valid() bool + type GetRealm403JSONResponseBodyError string + const GetRealm403JSONResponseBodyErrorInsufficientScope + func (e GetRealm403JSONResponseBodyError) Valid() bool + type HttpRequestDoer interface + Do func(req *http.Request) (*http.Response, error) + type ListRealms401JSONResponseBodyError string + const ListRealms401JSONResponseBodyErrorInvalidToken + func (e ListRealms401JSONResponseBodyError) Valid() bool + type ListRealms403JSONResponseBodyError string + const ListRealms403JSONResponseBodyErrorInsufficientScope + func (e ListRealms403JSONResponseBodyError) Valid() bool + type ListRealmsParams struct + FilterDomain *[]string + FilterDomainStatus *[]ListRealmsParamsFilterDomainStatus + FilterName *[]string + FilterSlug *[]string + Page *int + PerPage *int + Sort *[]ListRealmsParamsSort + type ListRealmsParamsFilterDomainStatus string + const ListRealmsParamsFilterDomainStatusMisrouted + const ListRealmsParamsFilterDomainStatusPending + const ListRealmsParamsFilterDomainStatusUnreachable + const ListRealmsParamsFilterDomainStatusVerified + func (e ListRealmsParamsFilterDomainStatus) Valid() bool + type ListRealmsParamsSort string + const CreatedAt + const MinusCreatedAt + const MinusName + const MinusSlug + const Name + const Slug + func (e ListRealmsParamsSort) Valid() bool + type ModelNotFoundException struct + Message string + type PatchRealm401JSONResponseBodyError string + const PatchRealm401JSONResponseBodyErrorInvalidToken + func (e PatchRealm401JSONResponseBodyError) Valid() bool + type PatchRealm403JSONResponseBodyError string + const PatchRealm403JSONResponseBodyErrorInsufficientScope + func (e PatchRealm403JSONResponseBodyError) Valid() bool + type PatchRealmJSONRequestBody = UpdateRealmData + type RealmCollection struct + Data []RealmData + Links []struct{ ... } + Meta struct{ ... } + type RealmData struct + CreatedAt nullable.Nullable[string] + Domain nullable.Nullable[string] + DomainCheckError nullable.Nullable[string] + DomainCheckedAt nullable.Nullable[string] + DomainStatus RealmDomainStatus + Host string + Issuer string + Master bool + Name string + Settings RealmSettings + Slug string + UpdatedAt nullable.Nullable[string] + type RealmDomainStatus string + const RealmDomainStatusMisrouted + const RealmDomainStatusPending + const RealmDomainStatusUnreachable + const RealmDomainStatusVerified + func (e RealmDomainStatus) Valid() bool + type RealmResponse struct + Data RealmData + type RealmSettings struct + AccessTokenLifetime float32 + AllowedRedirectDomains []string + AllowedRedirectSchemes []string + AutoProvision bool + ChallengeProviders []string + ClientCredentialsLifetime float32 + DefaultScopes []string + DynamicRegistration bool + EmailVerificationRequired bool + FirstPartyTrusted bool + IDTokenLifetime float32 + LinkByVerifiedEmail bool + LoginMethods []string + MfaRequirement string + OptionalScopes []string + PasswordHistory float32 + PasswordMaxAgeDays float32 + PasswordMinLength float32 + PasswordMixedCase bool + PasswordNumbers bool + PasswordSymbols bool + PasswordUncompromised bool + RecoveryCodes float32 + RefreshTokenLifetime float32 + SessionAbsoluteLifetime float32 + SessionTokenRefreshSkew float32 + SessionTokenTTL float32 + TokenExchange bool + TotpSecretLength float32 + TotpWindow float32 + TrustedClients []string + type RealmSettingsPatch struct + AccessTokenLifetime *float32 + AllowedRedirectDomains *[]string + AllowedRedirectSchemes *[]string + AutoProvision *bool + ChallengeProviders *[]string + ClientCredentialsLifetime *float32 + DefaultScopes *[]string + DynamicRegistration *bool + EmailVerificationRequired *bool + FirstPartyTrusted *bool + IDTokenLifetime *float32 + LinkByVerifiedEmail *bool + LoginMethods *[]string + MfaRequirement *string + OptionalScopes *[]string + PasswordHistory *float32 + PasswordMaxAgeDays *float32 + PasswordMinLength *float32 + PasswordMixedCase *bool + PasswordNumbers *bool + PasswordSymbols *bool + PasswordUncompromised *bool + RecoveryCodes *float32 + RefreshTokenLifetime *float32 + SessionAbsoluteLifetime *float32 + SessionTokenRefreshSkew *float32 + SessionTokenTTL *float32 + TokenExchange *bool + TotpSecretLength *float32 + TotpWindow *float32 + TrustedClients *[]string + type RequestEditorFn func(ctx context.Context, req *http.Request) error + type Response = lock.Response + type UpdateRealm401JSONResponseBodyError string + const UpdateRealm401JSONResponseBodyErrorInvalidToken + func (e UpdateRealm401JSONResponseBodyError) Valid() bool + type UpdateRealm403JSONResponseBodyError string + const UpdateRealm403JSONResponseBodyErrorInsufficientScope + func (e UpdateRealm403JSONResponseBodyError) Valid() bool + type UpdateRealmData struct + Domain *string + Name *string + Settings *RealmSettingsPatch + type UpdateRealmJSONRequestBody = UpdateRealmData + type ValidationException struct + Errors map[string][]string + Message string
Go to main page