management

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Sep 16, 2026 License: MIT Imports: 12 Imported by: 0

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.8.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCreateClientRequest 

func NewCreateClientRequest(server string, realm string, body CreateClientJSONRequestBody) (*http.Request, error)

NewCreateClientRequest calls the generic CreateClient builder with application/json body

func NewCreateClientRequestWithBody 

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

NewCreateClientRequestWithBody constructs an http.Request for the CreateClient method, with any body, and a specified content type

func NewCreateResourceRequest 

func NewCreateResourceRequest(server string, realm string, body CreateResourceJSONRequestBody) (*http.Request, error)

NewCreateResourceRequest calls the generic CreateResource builder with application/json body

func NewCreateResourceRequestWithBody 

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

NewCreateResourceRequestWithBody constructs an http.Request for the CreateResource method, with any body, and a specified content type

func NewCreateSocialProviderRequest 

func NewCreateSocialProviderRequest(server string, realm string, body CreateSocialProviderJSONRequestBody) (*http.Request, error)

NewCreateSocialProviderRequest calls the generic CreateSocialProvider builder with application/json body

func NewCreateSocialProviderRequestWithBody 

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

NewCreateSocialProviderRequestWithBody constructs an http.Request for the CreateSocialProvider method, with any body, and a specified content type

func NewDeleteClientRequest 

func NewDeleteClientRequest(server string, realm string, client string) (*http.Request, error)

NewDeleteClientRequest constructs an http.Request for the DeleteClient method

func NewDeleteResourceRequest 

func NewDeleteResourceRequest(server string, realm string, resource string) (*http.Request, error)

NewDeleteResourceRequest constructs an http.Request for the DeleteResource method

func NewDeleteSocialProviderRequest 

func NewDeleteSocialProviderRequest(server string, realm string, socialProvider string) (*http.Request, error)

NewDeleteSocialProviderRequest constructs an http.Request for the DeleteSocialProvider method

func NewGetClientRequest 

func NewGetClientRequest(server string, realm string, client string) (*http.Request, error)

NewGetClientRequest constructs an http.Request for the GetClient method

func NewGetClientSecretRequest 

func NewGetClientSecretRequest(server string, realm string, client string) (*http.Request, error)

NewGetClientSecretRequest constructs an http.Request for the GetClientSecret method

func NewGetResourceRequest 

func NewGetResourceRequest(server string, realm string, resource string) (*http.Request, error)

NewGetResourceRequest constructs an http.Request for the GetResource method

func NewGetSocialProviderRequest 

func NewGetSocialProviderRequest(server string, realm string, socialProvider string) (*http.Request, error)

NewGetSocialProviderRequest constructs an http.Request for the GetSocialProvider method

func NewListClientsRequest 

func NewListClientsRequest(server string, realm string, params *ListClientsParams) (*http.Request, error)

NewListClientsRequest constructs an http.Request for the ListClients method

func NewListResourcesRequest 

func NewListResourcesRequest(server string, realm string, params *ListResourcesParams) (*http.Request, error)

NewListResourcesRequest constructs an http.Request for the ListResources method

func NewListSocialProvidersRequest 

func NewListSocialProvidersRequest(server string, realm string, params *ListSocialProvidersParams) (*http.Request, error)

NewListSocialProvidersRequest constructs an http.Request for the ListSocialProviders method

func NewPatchClientRequest 

func NewPatchClientRequest(server string, realm string, client string, body PatchClientJSONRequestBody) (*http.Request, error)

NewPatchClientRequest calls the generic PatchClient builder with application/json body

func NewPatchClientRequestWithBody 

func NewPatchClientRequestWithBody(server string, realm string, client string, contentType string, body io.Reader) (*http.Request, error)

NewPatchClientRequestWithBody constructs an http.Request for the PatchClient method, with any body, and a specified content type

func NewPatchResourceRequest 

func NewPatchResourceRequest(server string, realm string, resource string, body PatchResourceJSONRequestBody) (*http.Request, error)

NewPatchResourceRequest calls the generic PatchResource builder with application/json body

func NewPatchResourceRequestWithBody 

func NewPatchResourceRequestWithBody(server string, realm string, resource string, contentType string, body io.Reader) (*http.Request, error)

NewPatchResourceRequestWithBody constructs an http.Request for the PatchResource method, with any body, and a specified content type

func NewPatchSocialProviderRequest 

func NewPatchSocialProviderRequest(server string, realm string, socialProvider string, body PatchSocialProviderJSONRequestBody) (*http.Request, error)

NewPatchSocialProviderRequest calls the generic PatchSocialProvider builder with application/json body

func NewPatchSocialProviderRequestWithBody 

func NewPatchSocialProviderRequestWithBody(server string, realm string, socialProvider string, contentType string, body io.Reader) (*http.Request, error)

NewPatchSocialProviderRequestWithBody constructs an http.Request for the PatchSocialProvider method, with any body, and a specified content type

func NewRotateClientSecretRequest 

func NewRotateClientSecretRequest(server string, realm string, client string) (*http.Request, error)

NewRotateClientSecretRequest constructs an http.Request for the RotateClientSecret method

func NewUpdateClientRequest 

func NewUpdateClientRequest(server string, realm string, client string, body UpdateClientJSONRequestBody) (*http.Request, error)

NewUpdateClientRequest calls the generic UpdateClient builder with application/json body

func NewUpdateClientRequestWithBody 

func NewUpdateClientRequestWithBody(server string, realm string, client string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateClientRequestWithBody constructs an http.Request for the UpdateClient method, with any body, and a specified content type

func NewUpdateResourceRequest 

func NewUpdateResourceRequest(server string, realm string, resource string, body UpdateResourceJSONRequestBody) (*http.Request, error)

NewUpdateResourceRequest calls the generic UpdateResource builder with application/json body

func NewUpdateResourceRequestWithBody 

func NewUpdateResourceRequestWithBody(server string, realm string, resource string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateResourceRequestWithBody constructs an http.Request for the UpdateResource method, with any body, and a specified content type

func NewUpdateSocialProviderRequest 

func NewUpdateSocialProviderRequest(server string, realm string, socialProvider string, body UpdateSocialProviderJSONRequestBody) (*http.Request, error)

NewUpdateSocialProviderRequest calls the generic UpdateSocialProvider builder with application/json body

func NewUpdateSocialProviderRequestWithBody 

func NewUpdateSocialProviderRequestWithBody(server string, realm string, socialProvider string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateSocialProviderRequestWithBody constructs an http.Request for the UpdateSocialProvider method, with any body, and a specified content type

Types

type APIError 

type APIError = lock.APIError

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

func (c *Client) CreateClient(ctx context.Context, realm string, body CreateClientJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatedClientResponse, error)

CreateClient Create a client

A confidential client is minted a secret, which this is the response that carries it. The scopes it is granted come from the realm's client policy.

Takes a body of the `application/json` content type.

Corresponds with POST /v1/realms/{realm}/clients (the `CreateClient` operationId).

func (*Client) CreateClientWithBody 

func (c *Client) CreateClientWithBody(ctx context.Context, realm string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatedClientResponse, error)

CreateClientWithBody Create a client

A confidential client is minted a secret, which this is the response that carries it. The scopes it is granted come from the realm's client policy.

Takes any type of body and a specified content type.

Corresponds with POST /v1/realms/{realm}/clients (the `CreateClient` operationId).

func (*Client) CreateResource 

func (c *Client) CreateResource(ctx context.Context, realm string, body CreateResourceJSONRequestBody, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

CreateResource Create a protected resource

Takes a body of the `application/json` content type.

Corresponds with POST /v1/realms/{realm}/resources (the `CreateResource` operationId).

func (*Client) CreateResourceWithBody 

func (c *Client) CreateResourceWithBody(ctx context.Context, realm string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

CreateResourceWithBody Create a protected resource

Takes any type of body and a specified content type.

Corresponds with POST /v1/realms/{realm}/resources (the `CreateResource` operationId).

func (*Client) CreateSocialProvider 

func (c *Client) CreateSocialProvider(ctx context.Context, realm string, body CreateSocialProviderJSONRequestBody, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

CreateSocialProvider performs a POST /v1/realms/{realm}/social-providers (the `CreateSocialProvider` operationId) request. Takes a body of the `application/json` content type.

func (*Client) CreateSocialProviderWithBody 

func (c *Client) CreateSocialProviderWithBody(ctx context.Context, realm string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

CreateSocialProviderWithBody performs a POST /v1/realms/{realm}/social-providers (the `CreateSocialProvider` operationId) request, with any type of body and a specified content type.

func (*Client) DeleteClient 

func (c *Client) DeleteClient(ctx context.Context, realm string, client string, reqEditors ...RequestEditorFn) (*Response, error)

DeleteClient Delete a client

Purges the client together with the tokens, grants and consents issued for it. Blocking it instead keeps the trail.

Corresponds with DELETE /v1/realms/{realm}/clients/{client} (the `DeleteClient` operationId).

func (*Client) DeleteResource 

func (c *Client) DeleteResource(ctx context.Context, realm string, resource string, reqEditors ...RequestEditorFn) (*Response, error)

DeleteResource Delete a resource and its scopes

The built-in API resources cannot be deleted.

Corresponds with DELETE /v1/realms/{realm}/resources/{resource} (the `DeleteResource` operationId).

func (*Client) DeleteSocialProvider 

func (c *Client) DeleteSocialProvider(ctx context.Context, realm string, socialProvider string, reqEditors ...RequestEditorFn) (*Response, error)

DeleteSocialProvider performs a DELETE /v1/realms/{realm}/social-providers/{social_provider} (the `DeleteSocialProvider` operationId) request.

func (*Client) GetClient 

func (c *Client) GetClient(ctx context.Context, realm string, client string, reqEditors ...RequestEditorFn) (*ClientResponse, error)

GetClient Show a client

Corresponds with GET /v1/realms/{realm}/clients/{client} (the `GetClient` operationId).

func (*Client) GetClientSecret 

func (c *Client) GetClientSecret(ctx context.Context, realm string, client string, reqEditors ...RequestEditorFn) (*ClientSecretResponse, error)

GetClientSecret performs a POST /v1/realms/{realm}/clients/{client}/secret (the `GetClientSecret` operationId) request.

func (*Client) GetResource 

func (c *Client) GetResource(ctx context.Context, realm string, resource string, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

GetResource Show a protected resource

Corresponds with GET /v1/realms/{realm}/resources/{resource} (the `GetResource` operationId).

func (*Client) GetSocialProvider 

func (c *Client) GetSocialProvider(ctx context.Context, realm string, socialProvider string, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

GetSocialProvider performs a GET /v1/realms/{realm}/social-providers/{social_provider} (the `GetSocialProvider` operationId) request.

func (*Client) ListClients 

func (c *Client) ListClients(ctx context.Context, realm string, params *ListClientsParams, reqEditors ...RequestEditorFn) (*ClientCollection, error)

ListClients List the clients of a realm

Corresponds with GET /v1/realms/{realm}/clients (the `ListClients` operationId).

func (*Client) ListResources 

func (c *Client) ListResources(ctx context.Context, realm string, params *ListResourcesParams, reqEditors ...RequestEditorFn) (*ResourceCollection, error)

ListResources List the resources of a realm

Corresponds with GET /v1/realms/{realm}/resources (the `ListResources` operationId).

func (*Client) ListSocialProviders 

func (c *Client) ListSocialProviders(ctx context.Context, realm string, params *ListSocialProvidersParams, reqEditors ...RequestEditorFn) (*SocialProviderCollection, error)

ListSocialProviders performs a GET /v1/realms/{realm}/social-providers (the `ListSocialProviders` operationId) request.

func (*Client) PatchClient 

func (c *Client) PatchClient(ctx context.Context, realm string, client string, body PatchClientJSONRequestBody, reqEditors ...RequestEditorFn) (*ClientResponse, error)

PatchClient Update a client

A client's `client_id` is immutable, and everything left out of the payload keeps its current value. Turning a public client confidential mints a secret; the other way around drops it.

Takes a body of the `application/json` content type.

Corresponds with PATCH /v1/realms/{realm}/clients/{client} (the `PatchClient` operationId).

func (*Client) PatchClientWithBody 

func (c *Client) PatchClientWithBody(ctx context.Context, realm string, client string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClientResponse, error)

PatchClientWithBody Update a client

A client's `client_id` is immutable, and everything left out of the payload keeps its current value. Turning a public client confidential mints a secret; the other way around drops it.

Takes any type of body and a specified content type.

Corresponds with PATCH /v1/realms/{realm}/clients/{client} (the `PatchClient` operationId).

func (*Client) PatchResource 

func (c *Client) PatchResource(ctx context.Context, realm string, resource string, body PatchResourceJSONRequestBody, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

PatchResource Update a protected resource

Fields left out retain their values. The built-in API resources are protected.

Takes a body of the `application/json` content type.

Corresponds with PATCH /v1/realms/{realm}/resources/{resource} (the `PatchResource` operationId).

func (*Client) PatchResourceWithBody 

func (c *Client) PatchResourceWithBody(ctx context.Context, realm string, resource string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

PatchResourceWithBody Update a protected resource

Fields left out retain their values. The built-in API resources are protected.

Takes any type of body and a specified content type.

Corresponds with PATCH /v1/realms/{realm}/resources/{resource} (the `PatchResource` operationId).

func (*Client) PatchSocialProvider 

func (c *Client) PatchSocialProvider(ctx context.Context, realm string, socialProvider string, body PatchSocialProviderJSONRequestBody, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

PatchSocialProvider performs a PATCH /v1/realms/{realm}/social-providers/{social_provider} (the `PatchSocialProvider` operationId) request. Takes a body of the `application/json` content type.

func (*Client) PatchSocialProviderWithBody 

func (c *Client) PatchSocialProviderWithBody(ctx context.Context, realm string, socialProvider string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

PatchSocialProviderWithBody performs a PATCH /v1/realms/{realm}/social-providers/{social_provider} (the `PatchSocialProvider` operationId) request, with any type of body and a specified content type.

func (*Client) RotateClientSecret 

func (c *Client) RotateClientSecret(ctx context.Context, realm string, client string, reqEditors ...RequestEditorFn) (*ClientSecretResponse, error)

RotateClientSecret performs a POST /v1/realms/{realm}/clients/{client}/rotate-secret (the `RotateClientSecret` operationId) request.

func (*Client) UpdateClient 

func (c *Client) UpdateClient(ctx context.Context, realm string, client string, body UpdateClientJSONRequestBody, reqEditors ...RequestEditorFn) (*ClientResponse, error)

UpdateClient Update a client

A client's `client_id` is immutable, and everything left out of the payload keeps its current value. Turning a public client confidential mints a secret; the other way around drops it.

Takes a body of the `application/json` content type.

Corresponds with PUT /v1/realms/{realm}/clients/{client} (the `UpdateClient` operationId).

func (*Client) UpdateClientWithBody 

func (c *Client) UpdateClientWithBody(ctx context.Context, realm string, client string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClientResponse, error)

UpdateClientWithBody Update a client

A client's `client_id` is immutable, and everything left out of the payload keeps its current value. Turning a public client confidential mints a secret; the other way around drops it.

Takes any type of body and a specified content type.

Corresponds with PUT /v1/realms/{realm}/clients/{client} (the `UpdateClient` operationId).

func (*Client) UpdateResource 

func (c *Client) UpdateResource(ctx context.Context, realm string, resource string, body UpdateResourceJSONRequestBody, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

UpdateResource Update a protected resource

Fields left out retain their values. The built-in API resources are protected.

Takes a body of the `application/json` content type.

Corresponds with PUT /v1/realms/{realm}/resources/{resource} (the `UpdateResource` operationId).

func (*Client) UpdateResourceWithBody 

func (c *Client) UpdateResourceWithBody(ctx context.Context, realm string, resource string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

UpdateResourceWithBody Update a protected resource

Fields left out retain their values. The built-in API resources are protected.

Takes any type of body and a specified content type.

Corresponds with PUT /v1/realms/{realm}/resources/{resource} (the `UpdateResource` operationId).

func (*Client) UpdateSocialProvider 

func (c *Client) UpdateSocialProvider(ctx context.Context, realm string, socialProvider string, body UpdateSocialProviderJSONRequestBody, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

UpdateSocialProvider performs a PUT /v1/realms/{realm}/social-providers/{social_provider} (the `UpdateSocialProvider` operationId) request. Takes a body of the `application/json` content type.

func (*Client) UpdateSocialProviderWithBody 

func (c *Client) UpdateSocialProviderWithBody(ctx context.Context, realm string, socialProvider string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

UpdateSocialProviderWithBody performs a PUT /v1/realms/{realm}/social-providers/{social_provider} (the `UpdateSocialProvider` operationId) request, with any type of body and a specified content type.

type ClientCollection 

type ClientCollection struct {
	Data  []ClientData `json:"data"`
	Links []struct {
		Active bool                      `json:"active"`
		Label  string                    `json:"label"`
		URL    nullable.Nullable[string] `json:"url"`
	} `json:"links"`
	Meta struct {
		CurrentPage  int                       `json:"current_page"`
		FirstPageURL nullable.Nullable[string] `json:"first_page_url"`
		From         nullable.Nullable[int]    `json:"from"`
		LastPage     int                       `json:"last_page"`
		LastPageURL  nullable.Nullable[string] `json:"last_page_url"`
		NextPageURL  nullable.Nullable[string] `json:"next_page_url"`
		Path         nullable.Nullable[string] `json:"path"`
		PerPage      int                       `json:"per_page"`
		PrevPageURL  nullable.Nullable[string] `json:"prev_page_url"`
		To           nullable.Nullable[int]    `json:"to"`
		Total        int                       `json:"total"`
	} `json:"meta"`
}

ClientCollection defines model for ClientCollection.

type ClientData 

type ClientData struct {
	// BackchannelLogoutURI Where a back-channel logout token is delivered.
	BackchannelLogoutURI nullable.Nullable[string] `json:"backchannel_logout_uri,omitempty"`

	// ClientID The identifier a relying party authenticates with, and its path in this API.
	ClientID string `json:"client_id"`

	// Confidential Whether the client holds a secret.
	Confidential bool `json:"confidential"`

	// ConsentRequired Whether the identity is asked to consent before the client is granted its scopes.
	ConsentRequired bool `json:"consent_required"`

	// CreatedAt When the client was created.
	CreatedAt nullable.Nullable[string] `json:"created_at,omitempty"`

	// GrantTypes The grants the client may use.
	GrantTypes []string `json:"grant_types"`

	// Name Human readable name, shown to the identity on the consent screen.
	Name string `json:"name"`

	// PostLogoutRedirectUris Where an end-session request may return to.
	PostLogoutRedirectUris []string `json:"post_logout_redirect_uris"`

	// Realm The slug of the realm the client belongs to.
	Realm string `json:"realm"`

	// RedirectUris Where an authorization response may be sent back to.
	RedirectUris []string `json:"redirect_uris"`

	// Revoked Whether the client is blocked from obtaining tokens.
	Revoked bool `json:"revoked"`

	// RevokedAt When the client was blocked, if it is.
	RevokedAt nullable.Nullable[string] `json:"revoked_at,omitempty"`

	// Scopes The scopes the client is granted, from the realm’s client policy.
	Scopes []string `json:"scopes"`

	// TokenEndpointAuthMethod How the client authenticates at the token endpoint.
	TokenEndpointAuthMethod TokenEndpointAuthMethod `json:"token_endpoint_auth_method"`

	// UpdatedAt When the client was last changed.
	UpdatedAt nullable.Nullable[string] `json:"updated_at,omitempty"`
}

ClientData defines model for ClientData.

type ClientInterface 

type ClientInterface interface {

	// ListClients List the clients of a realm
	//
	// Corresponds with GET /v1/realms/{realm}/clients (the `ListClients` operationId).
	ListClients(ctx context.Context, realm string, params *ListClientsParams, reqEditors ...RequestEditorFn) (*ClientCollection, error)

	// CreateClientWithBody Create a client
	//
	// A confidential client is minted a secret, which this is the response that
	// carries it. The scopes it is granted come from the realm's client policy.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/realms/{realm}/clients (the `CreateClient` operationId).
	CreateClientWithBody(ctx context.Context, realm string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatedClientResponse, error)

	// CreateClient Create a client
	//
	// A confidential client is minted a secret, which this is the response that
	// carries it. The scopes it is granted come from the realm's client policy.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/realms/{realm}/clients (the `CreateClient` operationId).
	CreateClient(ctx context.Context, realm string, body CreateClientJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatedClientResponse, error)

	// DeleteClient Delete a client
	//
	// Purges the client together with the tokens, grants and consents issued
	// for it. Blocking it instead keeps the trail.
	//
	// Corresponds with DELETE /v1/realms/{realm}/clients/{client} (the `DeleteClient` operationId).
	DeleteClient(ctx context.Context, realm string, client string, reqEditors ...RequestEditorFn) (*Response, error)

	// GetClient Show a client
	//
	// Corresponds with GET /v1/realms/{realm}/clients/{client} (the `GetClient` operationId).
	GetClient(ctx context.Context, realm string, client string, reqEditors ...RequestEditorFn) (*ClientResponse, error)

	// PatchClientWithBody Update a client
	//
	// A client's `client_id` is immutable, and everything left out of the
	// payload keeps its current value. Turning a public client confidential
	// mints a secret; the other way around drops it.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /v1/realms/{realm}/clients/{client} (the `PatchClient` operationId).
	PatchClientWithBody(ctx context.Context, realm string, client string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClientResponse, error)

	// PatchClient Update a client
	//
	// A client's `client_id` is immutable, and everything left out of the
	// payload keeps its current value. Turning a public client confidential
	// mints a secret; the other way around drops it.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /v1/realms/{realm}/clients/{client} (the `PatchClient` operationId).
	PatchClient(ctx context.Context, realm string, client string, body PatchClientJSONRequestBody, reqEditors ...RequestEditorFn) (*ClientResponse, error)

	// UpdateClientWithBody Update a client
	//
	// A client's `client_id` is immutable, and everything left out of the
	// payload keeps its current value. Turning a public client confidential
	// mints a secret; the other way around drops it.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /v1/realms/{realm}/clients/{client} (the `UpdateClient` operationId).
	UpdateClientWithBody(ctx context.Context, realm string, client string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClientResponse, error)

	// UpdateClient Update a client
	//
	// A client's `client_id` is immutable, and everything left out of the
	// payload keeps its current value. Turning a public client confidential
	// mints a secret; the other way around drops it.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /v1/realms/{realm}/clients/{client} (the `UpdateClient` operationId).
	UpdateClient(ctx context.Context, realm string, client string, body UpdateClientJSONRequestBody, reqEditors ...RequestEditorFn) (*ClientResponse, error)

	// RotateClientSecret performs a POST /v1/realms/{realm}/clients/{client}/rotate-secret (the `RotateClientSecret` operationId) request.
	RotateClientSecret(ctx context.Context, realm string, client string, reqEditors ...RequestEditorFn) (*ClientSecretResponse, error)

	// GetClientSecret performs a POST /v1/realms/{realm}/clients/{client}/secret (the `GetClientSecret` operationId) request.
	GetClientSecret(ctx context.Context, realm string, client string, reqEditors ...RequestEditorFn) (*ClientSecretResponse, error)

	// ListResources List the resources of a realm
	//
	// Corresponds with GET /v1/realms/{realm}/resources (the `ListResources` operationId).
	ListResources(ctx context.Context, realm string, params *ListResourcesParams, reqEditors ...RequestEditorFn) (*ResourceCollection, error)

	// CreateResourceWithBody Create a protected resource
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/realms/{realm}/resources (the `CreateResource` operationId).
	CreateResourceWithBody(ctx context.Context, realm string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

	// CreateResource Create a protected resource
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/realms/{realm}/resources (the `CreateResource` operationId).
	CreateResource(ctx context.Context, realm string, body CreateResourceJSONRequestBody, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

	// DeleteResource Delete a resource and its scopes
	//
	// The built-in API resources cannot be deleted.
	//
	// Corresponds with DELETE /v1/realms/{realm}/resources/{resource} (the `DeleteResource` operationId).
	DeleteResource(ctx context.Context, realm string, resource string, reqEditors ...RequestEditorFn) (*Response, error)

	// GetResource Show a protected resource
	//
	// Corresponds with GET /v1/realms/{realm}/resources/{resource} (the `GetResource` operationId).
	GetResource(ctx context.Context, realm string, resource string, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

	// PatchResourceWithBody Update a protected resource
	//
	// Fields left out retain their values. The built-in API resources are protected.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /v1/realms/{realm}/resources/{resource} (the `PatchResource` operationId).
	PatchResourceWithBody(ctx context.Context, realm string, resource string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

	// PatchResource Update a protected resource
	//
	// Fields left out retain their values. The built-in API resources are protected.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /v1/realms/{realm}/resources/{resource} (the `PatchResource` operationId).
	PatchResource(ctx context.Context, realm string, resource string, body PatchResourceJSONRequestBody, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

	// UpdateResourceWithBody Update a protected resource
	//
	// Fields left out retain their values. The built-in API resources are protected.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /v1/realms/{realm}/resources/{resource} (the `UpdateResource` operationId).
	UpdateResourceWithBody(ctx context.Context, realm string, resource string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

	// UpdateResource Update a protected resource
	//
	// Fields left out retain their values. The built-in API resources are protected.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /v1/realms/{realm}/resources/{resource} (the `UpdateResource` operationId).
	UpdateResource(ctx context.Context, realm string, resource string, body UpdateResourceJSONRequestBody, reqEditors ...RequestEditorFn) (*ResourceResponse, error)

	// ListSocialProviders performs a GET /v1/realms/{realm}/social-providers (the `ListSocialProviders` operationId) request.
	ListSocialProviders(ctx context.Context, realm string, params *ListSocialProvidersParams, reqEditors ...RequestEditorFn) (*SocialProviderCollection, error)

	// CreateSocialProviderWithBody performs a POST /v1/realms/{realm}/social-providers (the `CreateSocialProvider` operationId) request,
	// with any type of body and a specified content type.
	CreateSocialProviderWithBody(ctx context.Context, realm string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

	// CreateSocialProvider performs a POST /v1/realms/{realm}/social-providers (the `CreateSocialProvider` operationId) request.
	// Takes a body of the `application/json` content type.
	CreateSocialProvider(ctx context.Context, realm string, body CreateSocialProviderJSONRequestBody, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

	// DeleteSocialProvider performs a DELETE /v1/realms/{realm}/social-providers/{social_provider} (the `DeleteSocialProvider` operationId) request.
	DeleteSocialProvider(ctx context.Context, realm string, socialProvider string, reqEditors ...RequestEditorFn) (*Response, error)

	// GetSocialProvider performs a GET /v1/realms/{realm}/social-providers/{social_provider} (the `GetSocialProvider` operationId) request.
	GetSocialProvider(ctx context.Context, realm string, socialProvider string, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

	// PatchSocialProviderWithBody performs a PATCH /v1/realms/{realm}/social-providers/{social_provider} (the `PatchSocialProvider` operationId) request,
	// with any type of body and a specified content type.
	PatchSocialProviderWithBody(ctx context.Context, realm string, socialProvider string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

	// PatchSocialProvider performs a PATCH /v1/realms/{realm}/social-providers/{social_provider} (the `PatchSocialProvider` operationId) request.
	// Takes a body of the `application/json` content type.
	PatchSocialProvider(ctx context.Context, realm string, socialProvider string, body PatchSocialProviderJSONRequestBody, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

	// UpdateSocialProviderWithBody performs a PUT /v1/realms/{realm}/social-providers/{social_provider} (the `UpdateSocialProvider` operationId) request,
	// with any type of body and a specified content type.
	UpdateSocialProviderWithBody(ctx context.Context, realm string, socialProvider string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)

	// UpdateSocialProvider performs a PUT /v1/realms/{realm}/social-providers/{social_provider} (the `UpdateSocialProvider` operationId) request.
	// Takes a body of the `application/json` content type.
	UpdateSocialProvider(ctx context.Context, realm string, socialProvider string, body UpdateSocialProviderJSONRequestBody, reqEditors ...RequestEditorFn) (*SocialProviderResponse, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

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.

func WithToken 

func WithToken(token string) ClientOption

type ClientResponse 

type ClientResponse struct {
	Data ClientData `json:"data"`
}

ClientResponse defines model for ClientResponse.

type ClientSecretData 

type ClientSecretData struct {
	// ClientID The identifier a relying party authenticates with.
	ClientID string `json:"client_id"`

	// Secret The credential disclosed by this explicit write-scoped operation; null for a public client.
	Secret nullable.Nullable[string] `json:"secret,omitempty"`
}

ClientSecretData defines model for ClientSecretData.

type ClientSecretResponse 

type ClientSecretResponse struct {
	Data ClientSecretData `json:"data"`
}

ClientSecretResponse defines model for ClientSecretResponse.

type CreateClient401JSONResponseBodyError 

type CreateClient401JSONResponseBodyError string

CreateClient401JSONResponseBodyError defines parameters for CreateClient. 

const (
	CreateClient401JSONResponseBodyErrorInvalidToken CreateClient401JSONResponseBodyError = "invalid_token"
)

Defines values for CreateClient401JSONResponseBodyError.

func (CreateClient401JSONResponseBodyError) Valid 

func (e CreateClient401JSONResponseBodyError) Valid() bool

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

type CreateClient403JSONResponseBodyError 

type CreateClient403JSONResponseBodyError string

CreateClient403JSONResponseBodyError defines parameters for CreateClient. 

const (
	CreateClient403JSONResponseBodyErrorInsufficientScope CreateClient403JSONResponseBodyError = "insufficient_scope"
)

Defines values for CreateClient403JSONResponseBodyError.

func (CreateClient403JSONResponseBodyError) Valid 

func (e CreateClient403JSONResponseBodyError) Valid() bool

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

type CreateClientData 

type CreateClientData struct {
	// BackchannelLogoutURI Where a back-channel logout token is delivered.
	BackchannelLogoutURI nullable.Nullable[string] `json:"backchannel_logout_uri,omitempty"`

	// ConsentRequired Whether the identity is asked to consent before the client is granted its scopes.
	ConsentRequired *bool `json:"consent_required,omitempty"`

	// GrantTypes The grants the client may use.
	GrantTypes []CreateClientDataGrantTypes `json:"grant_types"`

	// Name Human readable name, shown to the identity on the consent screen.
	Name string `json:"name"`

	// PostLogoutRedirectUris Where an end-session request may return to.
	PostLogoutRedirectUris *[]string `json:"post_logout_redirect_uris,omitempty"`

	// RedirectUris Where an authorization response may be sent back to. Required for the authorization code grant.
	RedirectUris *[]string `json:"redirect_uris,omitempty"`

	// TokenEndpointAuthMethod How the client authenticates at the token endpoint. `none` makes it a public client with no secret.
	TokenEndpointAuthMethod TokenEndpointAuthMethod `json:"token_endpoint_auth_method"`
}

CreateClientData defines model for CreateClientData.

type CreateClientDataGrantTypes 

type CreateClientDataGrantTypes string

CreateClientDataGrantTypes defines model for CreateClientData.GrantTypes. 

const (
	CreateClientDataGrantTypesAuthorizationCode CreateClientDataGrantTypes = "authorization_code"
	CreateClientDataGrantTypesClientCredentials CreateClientDataGrantTypes = "client_credentials"
	CreateClientDataGrantTypesRefreshToken      CreateClientDataGrantTypes = "refresh_token"
)

Defines values for CreateClientDataGrantTypes.

func (CreateClientDataGrantTypes) Valid 

func (e CreateClientDataGrantTypes) Valid() bool

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

type CreateClientJSONRequestBody 

type CreateClientJSONRequestBody = CreateClientData

CreateClientJSONRequestBody defines body for CreateClient for application/json ContentType.

type CreateResource401JSONResponseBodyError 

type CreateResource401JSONResponseBodyError string

CreateResource401JSONResponseBodyError defines parameters for CreateResource. 

const (
	CreateResource401JSONResponseBodyErrorInvalidToken CreateResource401JSONResponseBodyError = "invalid_token"
)

Defines values for CreateResource401JSONResponseBodyError.

func (CreateResource401JSONResponseBodyError) Valid 

func (e CreateResource401JSONResponseBodyError) Valid() bool

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

type CreateResource403JSONResponseBodyError 

type CreateResource403JSONResponseBodyError string

CreateResource403JSONResponseBodyError defines parameters for CreateResource. 

const (
	CreateResource403JSONResponseBodyErrorInsufficientScope CreateResource403JSONResponseBodyError = "insufficient_scope"
)

Defines values for CreateResource403JSONResponseBodyError.

func (CreateResource403JSONResponseBodyError) Valid 

func (e CreateResource403JSONResponseBodyError) Valid() bool

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

type CreateResourceData 

type CreateResourceData struct {
	// Identifier A path relative to the realm issuer, or an absolute URI with a host and no fragment.
	Identifier string `json:"identifier"`

	// Name Human readable name of the protected resource.
	Name string `json:"name"`

	// Scopes Scopes to create with this resource.
	Scopes *[]CreateResourceScopeData `json:"scopes,omitempty"`
}

CreateResourceData defines model for CreateResourceData.

type CreateResourceJSONRequestBody 

type CreateResourceJSONRequestBody = CreateResourceData

CreateResourceJSONRequestBody defines body for CreateResource for application/json ContentType.

type CreateResourceScopeData 

type CreateResourceScopeData struct {
	// Description Human readable description of the scope. Null clears the description.
	Description nullable.Nullable[string] `json:"description,omitempty"`

	// Value Scope value, unique within its resource. Whitespace is not allowed.
	Value string `json:"value"`
}

CreateResourceScopeData defines model for CreateResourceScopeData.

type CreateSocialProvider401JSONResponseBodyError 

type CreateSocialProvider401JSONResponseBodyError string

CreateSocialProvider401JSONResponseBodyError defines parameters for CreateSocialProvider. 

const (
	CreateSocialProvider401JSONResponseBodyErrorInvalidToken CreateSocialProvider401JSONResponseBodyError = "invalid_token"
)

Defines values for CreateSocialProvider401JSONResponseBodyError.

func (CreateSocialProvider401JSONResponseBodyError) Valid 

func (e CreateSocialProvider401JSONResponseBodyError) Valid() bool

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

type CreateSocialProvider403JSONResponseBodyError 

type CreateSocialProvider403JSONResponseBodyError string

CreateSocialProvider403JSONResponseBodyError defines parameters for CreateSocialProvider. 

const (
	CreateSocialProvider403JSONResponseBodyErrorInsufficientScope CreateSocialProvider403JSONResponseBodyError = "insufficient_scope"
)

Defines values for CreateSocialProvider403JSONResponseBodyError.

func (CreateSocialProvider403JSONResponseBodyError) Valid 

func (e CreateSocialProvider403JSONResponseBodyError) Valid() bool

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

type CreateSocialProviderData 

type CreateSocialProviderData struct {
	// Config Credentials required by the selected driver.
	Config SocialProviderCredentialsData `json:"config"`

	// Driver Upstream provider implementation.
	Driver SocialProviderDriver `json:"driver"`

	// Enabled Whether the realm accepts sign-ins through this provider.
	Enabled bool `json:"enabled"`

	// Key Immutable provider key used in callback URLs and linked accounts.
	Key string `json:"key"`
}

CreateSocialProviderData defines model for CreateSocialProviderData.

type CreateSocialProviderJSONRequestBody 

type CreateSocialProviderJSONRequestBody = CreateSocialProviderData

CreateSocialProviderJSONRequestBody defines body for CreateSocialProvider for application/json ContentType.

type CreatedClientData 

type CreatedClientData struct {
	// Client The newly created client.
	Client ClientData `json:"client"`

	// Credentials The credentials issued at creation. Regular client reads never contain them.
	Credentials ClientSecretData `json:"credentials"`
}

CreatedClientData defines model for CreatedClientData.

type CreatedClientResponse 

type CreatedClientResponse struct {
	Data CreatedClientData `json:"data"`
}

CreatedClientResponse defines model for CreatedClientResponse.

type DeleteClient401JSONResponseBodyError 

type DeleteClient401JSONResponseBodyError string

DeleteClient401JSONResponseBodyError defines parameters for DeleteClient. 

const (
	DeleteClient401JSONResponseBodyErrorInvalidToken DeleteClient401JSONResponseBodyError = "invalid_token"
)

Defines values for DeleteClient401JSONResponseBodyError.

func (DeleteClient401JSONResponseBodyError) Valid 

func (e DeleteClient401JSONResponseBodyError) Valid() bool

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

type DeleteClient403JSONResponseBodyError 

type DeleteClient403JSONResponseBodyError string

DeleteClient403JSONResponseBodyError defines parameters for DeleteClient. 

const (
	DeleteClient403JSONResponseBodyErrorInsufficientScope DeleteClient403JSONResponseBodyError = "insufficient_scope"
)

Defines values for DeleteClient403JSONResponseBodyError.

func (DeleteClient403JSONResponseBodyError) Valid 

func (e DeleteClient403JSONResponseBodyError) Valid() bool

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

type DeleteResource401JSONResponseBodyError 

type DeleteResource401JSONResponseBodyError string

DeleteResource401JSONResponseBodyError defines parameters for DeleteResource. 

const (
	DeleteResource401JSONResponseBodyErrorInvalidToken DeleteResource401JSONResponseBodyError = "invalid_token"
)

Defines values for DeleteResource401JSONResponseBodyError.

func (DeleteResource401JSONResponseBodyError) Valid 

func (e DeleteResource401JSONResponseBodyError) Valid() bool

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

type DeleteResource403JSONResponseBodyError 

type DeleteResource403JSONResponseBodyError string

DeleteResource403JSONResponseBodyError defines parameters for DeleteResource. 

const (
	DeleteResource403JSONResponseBodyErrorInsufficientScope DeleteResource403JSONResponseBodyError = "insufficient_scope"
)

Defines values for DeleteResource403JSONResponseBodyError.

func (DeleteResource403JSONResponseBodyError) Valid 

func (e DeleteResource403JSONResponseBodyError) Valid() bool

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

type DeleteSocialProvider401JSONResponseBodyError 

type DeleteSocialProvider401JSONResponseBodyError string

DeleteSocialProvider401JSONResponseBodyError defines parameters for DeleteSocialProvider. 

const (
	DeleteSocialProvider401JSONResponseBodyErrorInvalidToken DeleteSocialProvider401JSONResponseBodyError = "invalid_token"
)

Defines values for DeleteSocialProvider401JSONResponseBodyError.

func (DeleteSocialProvider401JSONResponseBodyError) Valid 

func (e DeleteSocialProvider401JSONResponseBodyError) Valid() bool

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

type DeleteSocialProvider403JSONResponseBodyError 

type DeleteSocialProvider403JSONResponseBodyError string

DeleteSocialProvider403JSONResponseBodyError defines parameters for DeleteSocialProvider. 

const (
	DeleteSocialProvider403JSONResponseBodyErrorInsufficientScope DeleteSocialProvider403JSONResponseBodyError = "insufficient_scope"
)

Defines values for DeleteSocialProvider403JSONResponseBodyError.

func (DeleteSocialProvider403JSONResponseBodyError) Valid 

func (e DeleteSocialProvider403JSONResponseBodyError) Valid() bool

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

type GetClient401JSONResponseBodyError 

type GetClient401JSONResponseBodyError string

GetClient401JSONResponseBodyError defines parameters for GetClient. 

const (
	GetClient401JSONResponseBodyErrorInvalidToken GetClient401JSONResponseBodyError = "invalid_token"
)

Defines values for GetClient401JSONResponseBodyError.

func (GetClient401JSONResponseBodyError) Valid 

func (e GetClient401JSONResponseBodyError) Valid() bool

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

type GetClient403JSONResponseBodyError 

type GetClient403JSONResponseBodyError string

GetClient403JSONResponseBodyError defines parameters for GetClient. 

const (
	GetClient403JSONResponseBodyErrorInsufficientScope GetClient403JSONResponseBodyError = "insufficient_scope"
)

Defines values for GetClient403JSONResponseBodyError.

func (GetClient403JSONResponseBodyError) Valid 

func (e GetClient403JSONResponseBodyError) Valid() bool

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

type GetClientSecret401JSONResponseBodyError 

type GetClientSecret401JSONResponseBodyError string

GetClientSecret401JSONResponseBodyError defines parameters for GetClientSecret. 

const (
	GetClientSecret401JSONResponseBodyErrorInvalidToken GetClientSecret401JSONResponseBodyError = "invalid_token"
)

Defines values for GetClientSecret401JSONResponseBodyError.

func (GetClientSecret401JSONResponseBodyError) Valid 

func (e GetClientSecret401JSONResponseBodyError) Valid() bool

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

type GetClientSecret403JSONResponseBodyError 

type GetClientSecret403JSONResponseBodyError string

GetClientSecret403JSONResponseBodyError defines parameters for GetClientSecret. 

const (
	GetClientSecret403JSONResponseBodyErrorInsufficientScope GetClientSecret403JSONResponseBodyError = "insufficient_scope"
)

Defines values for GetClientSecret403JSONResponseBodyError.

func (GetClientSecret403JSONResponseBodyError) Valid 

func (e GetClientSecret403JSONResponseBodyError) Valid() bool

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

type GetResource401JSONResponseBodyError 

type GetResource401JSONResponseBodyError string

GetResource401JSONResponseBodyError defines parameters for GetResource. 

const (
	GetResource401JSONResponseBodyErrorInvalidToken GetResource401JSONResponseBodyError = "invalid_token"
)

Defines values for GetResource401JSONResponseBodyError.

func (GetResource401JSONResponseBodyError) Valid 

func (e GetResource401JSONResponseBodyError) Valid() bool

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

type GetResource403JSONResponseBodyError 

type GetResource403JSONResponseBodyError string

GetResource403JSONResponseBodyError defines parameters for GetResource. 

const (
	GetResource403JSONResponseBodyErrorInsufficientScope GetResource403JSONResponseBodyError = "insufficient_scope"
)

Defines values for GetResource403JSONResponseBodyError.

func (GetResource403JSONResponseBodyError) Valid 

func (e GetResource403JSONResponseBodyError) Valid() bool

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

type GetSocialProvider401JSONResponseBodyError 

type GetSocialProvider401JSONResponseBodyError string

GetSocialProvider401JSONResponseBodyError defines parameters for GetSocialProvider. 

const (
	GetSocialProvider401JSONResponseBodyErrorInvalidToken GetSocialProvider401JSONResponseBodyError = "invalid_token"
)

Defines values for GetSocialProvider401JSONResponseBodyError.

func (GetSocialProvider401JSONResponseBodyError) Valid 

func (e GetSocialProvider401JSONResponseBodyError) Valid() bool

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

type GetSocialProvider403JSONResponseBodyError 

type GetSocialProvider403JSONResponseBodyError string

GetSocialProvider403JSONResponseBodyError defines parameters for GetSocialProvider. 

const (
	GetSocialProvider403JSONResponseBodyErrorInsufficientScope GetSocialProvider403JSONResponseBodyError = "insufficient_scope"
)

Defines values for GetSocialProvider403JSONResponseBodyError.

func (GetSocialProvider403JSONResponseBodyError) Valid 

func (e GetSocialProvider403JSONResponseBodyError) Valid() bool

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

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type ListClients401JSONResponseBodyError 

type ListClients401JSONResponseBodyError string

ListClients401JSONResponseBodyError defines parameters for ListClients. 

const (
	ListClients401JSONResponseBodyErrorInvalidToken ListClients401JSONResponseBodyError = "invalid_token"
)

Defines values for ListClients401JSONResponseBodyError.

func (ListClients401JSONResponseBodyError) Valid 

func (e ListClients401JSONResponseBodyError) Valid() bool

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

type ListClients403JSONResponseBodyError 

type ListClients403JSONResponseBodyError string

ListClients403JSONResponseBodyError defines parameters for ListClients. 

const (
	ListClients403JSONResponseBodyErrorInsufficientScope ListClients403JSONResponseBodyError = "insufficient_scope"
)

Defines values for ListClients403JSONResponseBodyError.

func (ListClients403JSONResponseBodyError) Valid 

func (e ListClients403JSONResponseBodyError) Valid() bool

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

type ListClientsParams 

type ListClientsParams struct {
	// Sort Available sorts are `name`, `client_id`, `created_at`. You can sort by multiple options by separating them with a comma. To sort in descending order, use `-` sign in front of the sort, for example: `-name`.
	Sort *[]ListClientsParamsSort `form:"sort,omitempty" json:"sort,omitempty"`

	// FilterName Filter by `name`. Matches values containing the given text, case-insensitively. Separate multiple values with a comma; records matching any value qualify.
	FilterName *[]string `form:"filter[name],omitempty" json:"filter[name],omitempty"`

	// FilterClientID Filter by `client_id`. Matches the exact value. Separate multiple values with a comma; records matching any value qualify.
	FilterClientID *[]string `form:"filter[client_id],omitempty" json:"filter[client_id],omitempty"`

	// FilterTokenEndpointAuthMethod Filter by `token_endpoint_auth_method`. Matches the exact value. Separate multiple values with a comma; records matching any value qualify.
	FilterTokenEndpointAuthMethod *[]string `form:"filter[token_endpoint_auth_method],omitempty" json:"filter[token_endpoint_auth_method],omitempty"`

	// FilterRevoked Filter by `revoked`.
	FilterRevoked *string `form:"filter[revoked],omitempty" json:"filter[revoked],omitempty"`

	// Page The page number to retrieve.
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// PerPage The number of items to retrieve per page.
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`
}

ListClientsParams defines parameters for ListClients.

type ListClientsParamsSort 

type ListClientsParamsSort string

ListClientsParamsSort defines parameters for ListClients. 

const (
	ListClientsParamsSortClientID       ListClientsParamsSort = "client_id"
	ListClientsParamsSortCreatedAt      ListClientsParamsSort = "created_at"
	ListClientsParamsSortMinusClientID  ListClientsParamsSort = "-client_id"
	ListClientsParamsSortMinusCreatedAt ListClientsParamsSort = "-created_at"
	ListClientsParamsSortMinusName      ListClientsParamsSort = "-name"
	ListClientsParamsSortName           ListClientsParamsSort = "name"
)

Defines values for ListClientsParamsSort.

func (ListClientsParamsSort) Valid 

func (e ListClientsParamsSort) Valid() bool

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

type ListResources401JSONResponseBodyError 

type ListResources401JSONResponseBodyError string

ListResources401JSONResponseBodyError defines parameters for ListResources. 

const (
	ListResources401JSONResponseBodyErrorInvalidToken ListResources401JSONResponseBodyError = "invalid_token"
)

Defines values for ListResources401JSONResponseBodyError.

func (ListResources401JSONResponseBodyError) Valid 

func (e ListResources401JSONResponseBodyError) Valid() bool

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

type ListResources403JSONResponseBodyError 

type ListResources403JSONResponseBodyError string

ListResources403JSONResponseBodyError defines parameters for ListResources. 

const (
	ListResources403JSONResponseBodyErrorInsufficientScope ListResources403JSONResponseBodyError = "insufficient_scope"
)

Defines values for ListResources403JSONResponseBodyError.

func (ListResources403JSONResponseBodyError) Valid 

func (e ListResources403JSONResponseBodyError) Valid() bool

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

type ListResourcesParams 

type ListResourcesParams struct {
	// Sort Available sorts are `name`, `identifier`, `created_at`. You can sort by multiple options by separating them with a comma. To sort in descending order, use `-` sign in front of the sort, for example: `-name`.
	Sort *[]ListResourcesParamsSort `form:"sort,omitempty" json:"sort,omitempty"`

	// FilterName Filter by `name`. Matches values containing the given text, case-insensitively. Separate multiple values with a comma; records matching any value qualify.
	FilterName *[]string `form:"filter[name],omitempty" json:"filter[name],omitempty"`

	// FilterIdentifier Filter by `identifier`. Matches the exact value. Separate multiple values with a comma; records matching any value qualify.
	FilterIdentifier *[]string `form:"filter[identifier],omitempty" json:"filter[identifier],omitempty"`

	// Page The page number to retrieve.
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// PerPage The number of items to retrieve per page.
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`
}

ListResourcesParams defines parameters for ListResources.

type ListResourcesParamsSort 

type ListResourcesParamsSort string

ListResourcesParamsSort defines parameters for ListResources. 

const (
	ListResourcesParamsSortCreatedAt       ListResourcesParamsSort = "created_at"
	ListResourcesParamsSortIdentifier      ListResourcesParamsSort = "identifier"
	ListResourcesParamsSortMinusCreatedAt  ListResourcesParamsSort = "-created_at"
	ListResourcesParamsSortMinusIdentifier ListResourcesParamsSort = "-identifier"
	ListResourcesParamsSortMinusName       ListResourcesParamsSort = "-name"
	ListResourcesParamsSortName            ListResourcesParamsSort = "name"
)

Defines values for ListResourcesParamsSort.

func (ListResourcesParamsSort) Valid 

func (e ListResourcesParamsSort) Valid() bool

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

type ListSocialProviders401JSONResponseBodyError 

type ListSocialProviders401JSONResponseBodyError string

ListSocialProviders401JSONResponseBodyError defines parameters for ListSocialProviders. 

const (
	ListSocialProviders401JSONResponseBodyErrorInvalidToken ListSocialProviders401JSONResponseBodyError = "invalid_token"
)

Defines values for ListSocialProviders401JSONResponseBodyError.

func (ListSocialProviders401JSONResponseBodyError) Valid 

func (e ListSocialProviders401JSONResponseBodyError) Valid() bool

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

type ListSocialProviders403JSONResponseBodyError 

type ListSocialProviders403JSONResponseBodyError string

ListSocialProviders403JSONResponseBodyError defines parameters for ListSocialProviders. 

const (
	ListSocialProviders403JSONResponseBodyErrorInsufficientScope ListSocialProviders403JSONResponseBodyError = "insufficient_scope"
)

Defines values for ListSocialProviders403JSONResponseBodyError.

func (ListSocialProviders403JSONResponseBodyError) Valid 

func (e ListSocialProviders403JSONResponseBodyError) Valid() bool

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

type ListSocialProvidersParams 

type ListSocialProvidersParams struct {
	// Sort Available sorts are `key`, `driver`, `created_at`. You can sort by multiple options by separating them with a comma. To sort in descending order, use `-` sign in front of the sort, for example: `-key`.
	Sort *[]ListSocialProvidersParamsSort `form:"sort,omitempty" json:"sort,omitempty"`

	// FilterKey Filter by `key`. Matches the exact value. Separate multiple values with a comma; records matching any value qualify.
	FilterKey *[]string `form:"filter[key],omitempty" json:"filter[key],omitempty"`

	// FilterDriver Filter by `driver`. Matches the exact value. Separate multiple values with a comma; records matching any value qualify.
	FilterDriver *[]string `form:"filter[driver],omitempty" json:"filter[driver],omitempty"`

	// FilterEnabled Filter by `enabled`. Matches the exact value. Separate multiple values with a comma; records matching any value qualify.
	FilterEnabled *[]string `form:"filter[enabled],omitempty" json:"filter[enabled],omitempty"`

	// Page The page number to retrieve.
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// PerPage The number of items to retrieve per page.
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`
}

ListSocialProvidersParams defines parameters for ListSocialProviders.

type ListSocialProvidersParamsSort 

type ListSocialProvidersParamsSort string

ListSocialProvidersParamsSort defines parameters for ListSocialProviders. 

const (
	ListSocialProvidersParamsSortCreatedAt      ListSocialProvidersParamsSort = "created_at"
	ListSocialProvidersParamsSortDriver         ListSocialProvidersParamsSort = "driver"
	ListSocialProvidersParamsSortKey            ListSocialProvidersParamsSort = "key"
	ListSocialProvidersParamsSortMinusCreatedAt ListSocialProvidersParamsSort = "-created_at"
	ListSocialProvidersParamsSortMinusDriver    ListSocialProvidersParamsSort = "-driver"
	ListSocialProvidersParamsSortMinusKey       ListSocialProvidersParamsSort = "-key"
)

Defines values for ListSocialProvidersParamsSort.

func (ListSocialProvidersParamsSort) Valid 

func (e ListSocialProvidersParamsSort) Valid() bool

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

type ModelNotFoundException 

type ModelNotFoundException struct {
	// Message Error overview.
	Message string `json:"message"`
}

ModelNotFoundException defines model for ModelNotFoundException.

type PatchClient401JSONResponseBodyError 

type PatchClient401JSONResponseBodyError string

PatchClient401JSONResponseBodyError defines parameters for PatchClient. 

const (
	PatchClient401JSONResponseBodyErrorInvalidToken PatchClient401JSONResponseBodyError = "invalid_token"
)

Defines values for PatchClient401JSONResponseBodyError.

func (PatchClient401JSONResponseBodyError) Valid 

func (e PatchClient401JSONResponseBodyError) Valid() bool

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

type PatchClient403JSONResponseBodyError 

type PatchClient403JSONResponseBodyError string

PatchClient403JSONResponseBodyError defines parameters for PatchClient. 

const (
	PatchClient403JSONResponseBodyErrorInsufficientScope PatchClient403JSONResponseBodyError = "insufficient_scope"
)

Defines values for PatchClient403JSONResponseBodyError.

func (PatchClient403JSONResponseBodyError) Valid 

func (e PatchClient403JSONResponseBodyError) Valid() bool

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

type PatchClientJSONRequestBody 

type PatchClientJSONRequestBody = UpdateClientData

PatchClientJSONRequestBody defines body for PatchClient for application/json ContentType.

type PatchResource401JSONResponseBodyError 

type PatchResource401JSONResponseBodyError string

PatchResource401JSONResponseBodyError defines parameters for PatchResource. 

const (
	PatchResource401JSONResponseBodyErrorInvalidToken PatchResource401JSONResponseBodyError = "invalid_token"
)

Defines values for PatchResource401JSONResponseBodyError.

func (PatchResource401JSONResponseBodyError) Valid 

func (e PatchResource401JSONResponseBodyError) Valid() bool

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

type PatchResource403JSONResponseBodyError 

type PatchResource403JSONResponseBodyError string

PatchResource403JSONResponseBodyError defines parameters for PatchResource. 

const (
	PatchResource403JSONResponseBodyErrorInsufficientScope PatchResource403JSONResponseBodyError = "insufficient_scope"
)

Defines values for PatchResource403JSONResponseBodyError.

func (PatchResource403JSONResponseBodyError) Valid 

func (e PatchResource403JSONResponseBodyError) Valid() bool

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

type PatchResourceJSONRequestBody 

type PatchResourceJSONRequestBody = UpdateResourceData

PatchResourceJSONRequestBody defines body for PatchResource for application/json ContentType.

type PatchSocialProvider401JSONResponseBodyError 

type PatchSocialProvider401JSONResponseBodyError string

PatchSocialProvider401JSONResponseBodyError defines parameters for PatchSocialProvider. 

const (
	PatchSocialProvider401JSONResponseBodyErrorInvalidToken PatchSocialProvider401JSONResponseBodyError = "invalid_token"
)

Defines values for PatchSocialProvider401JSONResponseBodyError.

func (PatchSocialProvider401JSONResponseBodyError) Valid 

func (e PatchSocialProvider401JSONResponseBodyError) Valid() bool

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

type PatchSocialProvider403JSONResponseBodyError 

type PatchSocialProvider403JSONResponseBodyError string

PatchSocialProvider403JSONResponseBodyError defines parameters for PatchSocialProvider. 

const (
	PatchSocialProvider403JSONResponseBodyErrorInsufficientScope PatchSocialProvider403JSONResponseBodyError = "insufficient_scope"
)

Defines values for PatchSocialProvider403JSONResponseBodyError.

func (PatchSocialProvider403JSONResponseBodyError) Valid 

func (e PatchSocialProvider403JSONResponseBodyError) Valid() bool

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

type PatchSocialProviderJSONRequestBody 

type PatchSocialProviderJSONRequestBody = UpdateSocialProviderData

PatchSocialProviderJSONRequestBody defines body for PatchSocialProvider for application/json ContentType.

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ResourceCollection 

type ResourceCollection struct {
	Data  []ResourceData `json:"data"`
	Links []struct {
		Active bool                      `json:"active"`
		Label  string                    `json:"label"`
		URL    nullable.Nullable[string] `json:"url"`
	} `json:"links"`
	Meta struct {
		CurrentPage  int                       `json:"current_page"`
		FirstPageURL nullable.Nullable[string] `json:"first_page_url"`
		From         nullable.Nullable[int]    `json:"from"`
		LastPage     int                       `json:"last_page"`
		LastPageURL  nullable.Nullable[string] `json:"last_page_url"`
		NextPageURL  nullable.Nullable[string] `json:"next_page_url"`
		Path         nullable.Nullable[string] `json:"path"`
		PerPage      int                       `json:"per_page"`
		PrevPageURL  nullable.Nullable[string] `json:"prev_page_url"`
		To           nullable.Nullable[int]    `json:"to"`
		Total        int                       `json:"total"`
	} `json:"meta"`
}

ResourceCollection defines model for ResourceCollection.

type ResourceData 

type ResourceData struct {
	// CreatedAt When the resource was created.
	CreatedAt nullable.Nullable[string] `json:"created_at,omitempty"`

	// ID The UUID of the protected resource, used in this API’s paths.
	ID string `json:"id"`

	// Identifier A path relative to the realm issuer, or an absolute URI naming the resource server.
	Identifier string `json:"identifier"`

	// Name Human readable name of the protected resource.
	Name string `json:"name"`

	// Realm The slug of the realm the resource belongs to.
	Realm string `json:"realm"`

	// Scopes Scopes belonging to this resource, identified by value.
	Scopes []ResourceScopeData `json:"scopes"`

	// UpdatedAt When the resource was last changed.
	UpdatedAt nullable.Nullable[string] `json:"updated_at,omitempty"`
}

ResourceData defines model for ResourceData.

type ResourceResponse 

type ResourceResponse struct {
	Data ResourceData `json:"data"`
}

ResourceResponse defines model for ResourceResponse.

type ResourceScopeChangeData 

type ResourceScopeChangeData struct {
	// Delete Set to true to delete the scope named by value.
	Delete *bool `json:"delete,omitempty"`

	// Description Human readable description. Omit to keep the current description; null clears it.
	Description nullable.Nullable[string] `json:"description,omitempty"`

	// Value Scope name, unique within its resource. An existing value updates that scope; a new value creates one.
	Value string `json:"value"`
}

ResourceScopeChangeData defines model for ResourceScopeChangeData.

type ResourceScopeData 

type ResourceScopeData struct {
	// CreatedAt When the scope was created.
	CreatedAt nullable.Nullable[string] `json:"created_at,omitempty"`

	// Description Human readable description of the scope.
	Description nullable.Nullable[string] `json:"description,omitempty"`

	// UpdatedAt When the scope was last changed.
	UpdatedAt nullable.Nullable[string] `json:"updated_at,omitempty"`

	// Value Scope value, unique within its resource.
	Value string `json:"value"`
}

ResourceScopeData defines model for ResourceScopeData.

type Response 

type Response = lock.Response

type RotateClientSecret401JSONResponseBodyError 

type RotateClientSecret401JSONResponseBodyError string

RotateClientSecret401JSONResponseBodyError defines parameters for RotateClientSecret. 

const (
	RotateClientSecret401JSONResponseBodyErrorInvalidToken RotateClientSecret401JSONResponseBodyError = "invalid_token"
)

Defines values for RotateClientSecret401JSONResponseBodyError.

func (RotateClientSecret401JSONResponseBodyError) Valid 

func (e RotateClientSecret401JSONResponseBodyError) Valid() bool

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

type RotateClientSecret403JSONResponseBodyError 

type RotateClientSecret403JSONResponseBodyError string

RotateClientSecret403JSONResponseBodyError defines parameters for RotateClientSecret. 

const (
	RotateClientSecret403JSONResponseBodyErrorInsufficientScope RotateClientSecret403JSONResponseBodyError = "insufficient_scope"
)

Defines values for RotateClientSecret403JSONResponseBodyError.

func (RotateClientSecret403JSONResponseBodyError) Valid 

func (e RotateClientSecret403JSONResponseBodyError) Valid() bool

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

type SocialProviderCollection 

type SocialProviderCollection struct {
	Data  []SocialProviderData `json:"data"`
	Links []struct {
		Active bool                      `json:"active"`
		Label  string                    `json:"label"`
		URL    nullable.Nullable[string] `json:"url"`
	} `json:"links"`
	Meta struct {
		CurrentPage  int                       `json:"current_page"`
		FirstPageURL nullable.Nullable[string] `json:"first_page_url"`
		From         nullable.Nullable[int]    `json:"from"`
		LastPage     int                       `json:"last_page"`
		LastPageURL  nullable.Nullable[string] `json:"last_page_url"`
		NextPageURL  nullable.Nullable[string] `json:"next_page_url"`
		Path         nullable.Nullable[string] `json:"path"`
		PerPage      int                       `json:"per_page"`
		PrevPageURL  nullable.Nullable[string] `json:"prev_page_url"`
		To           nullable.Nullable[int]    `json:"to"`
		Total        int                       `json:"total"`
	} `json:"meta"`
}

SocialProviderCollection defines model for SocialProviderCollection.

type SocialProviderCredentialsData 

type SocialProviderCredentialsData struct {
	// ClientID Client ID required by every driver.
	ClientID *string `json:"client_id,omitempty"`

	// ClientSecret Write-only secret for Google, GitHub and OIDC. Required on creation; blank or null keeps the stored secret on update.
	ClientSecret nullable.Nullable[string] `json:"client_secret,omitempty"`

	// Issuer Issuer URL required by the OIDC driver.
	Issuer *string `json:"issuer,omitempty"`

	// KeyID Key ID required by the Apple driver.
	KeyID *string `json:"key_id,omitempty"`

	// PrivateKey Write-only private key for Apple. Required on creation; blank or null keeps the stored key on update.
	PrivateKey nullable.Nullable[string] `json:"private_key,omitempty"`

	// TeamID Team ID required by the Apple driver.
	TeamID *string `json:"team_id,omitempty"`
}

SocialProviderCredentialsData defines model for SocialProviderCredentialsData.

type SocialProviderData 

type SocialProviderData struct {
	// CallbackURL Callback URL to register with the upstream provider.
	CallbackURL string `json:"callback_url"`

	// Config Public configuration only. Client secrets and private keys are never returned.
	Config SocialProviderPublicConfigData `json:"config"`

	// CreatedAt When the provider was created.
	CreatedAt nullable.Nullable[string] `json:"created_at,omitempty"`

	// Driver Immutable upstream provider implementation.
	Driver SocialProviderDriver `json:"driver"`

	// Enabled Whether sign-ins through this provider are enabled.
	Enabled bool `json:"enabled"`

	// ID Provider UUID used in API paths.
	ID string `json:"id"`

	// Key Immutable provider key used for social login and linked accounts.
	Key string `json:"key"`

	// Realm Realm slug.
	Realm string `json:"realm"`

	// UpdatedAt When the provider was last changed.
	UpdatedAt nullable.Nullable[string] `json:"updated_at,omitempty"`
}

SocialProviderData defines model for SocialProviderData.

type SocialProviderDriver 

type SocialProviderDriver string

SocialProviderDriver The brokering drivers use-lock/server's SocialProviderRegistry ships. Each one needs a different set of credentials, which is why the stored config is a map rather than columns. 

const (
	Apple  SocialProviderDriver = "apple"
	Github SocialProviderDriver = "github"
	Google SocialProviderDriver = "google"
	Oidc   SocialProviderDriver = "oidc"
)

Defines values for SocialProviderDriver.

func (SocialProviderDriver) Valid 

func (e SocialProviderDriver) Valid() bool

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

type SocialProviderPublicConfigData 

type SocialProviderPublicConfigData struct {
	// ClientID Upstream client ID.
	ClientID string `json:"client_id"`

	// Issuer Issuer URL for OIDC providers.
	Issuer *string `json:"issuer,omitempty"`

	// KeyID Key ID for Apple providers.
	KeyID *string `json:"key_id,omitempty"`

	// TeamID Team ID for Apple providers.
	TeamID *string `json:"team_id,omitempty"`
}

SocialProviderPublicConfigData defines model for SocialProviderPublicConfigData.

type SocialProviderResponse 

type SocialProviderResponse struct {
	Data SocialProviderData `json:"data"`
}

SocialProviderResponse defines model for SocialProviderResponse.

type TokenEndpointAuthMethod 

type TokenEndpointAuthMethod string

TokenEndpointAuthMethod RFC 7591 §2 / OIDC Registration §2: how a client authenticates at the token, introspection and revocation endpoints. Enforced exactly: a client registered for one method is refused when it presents another. 

const (
	ClientSecretBasic TokenEndpointAuthMethod = "client_secret_basic"
	ClientSecretPost  TokenEndpointAuthMethod = "client_secret_post"
	None              TokenEndpointAuthMethod = "none"
)

Defines values for TokenEndpointAuthMethod.

func (TokenEndpointAuthMethod) Valid 

func (e TokenEndpointAuthMethod) Valid() bool

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

type UpdateClient401JSONResponseBodyError 

type UpdateClient401JSONResponseBodyError string

UpdateClient401JSONResponseBodyError defines parameters for UpdateClient. 

const (
	UpdateClient401JSONResponseBodyErrorInvalidToken UpdateClient401JSONResponseBodyError = "invalid_token"
)

Defines values for UpdateClient401JSONResponseBodyError.

func (UpdateClient401JSONResponseBodyError) Valid 

func (e UpdateClient401JSONResponseBodyError) Valid() bool

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

type UpdateClient403JSONResponseBodyError 

type UpdateClient403JSONResponseBodyError string

UpdateClient403JSONResponseBodyError defines parameters for UpdateClient. 

const (
	UpdateClient403JSONResponseBodyErrorInsufficientScope UpdateClient403JSONResponseBodyError = "insufficient_scope"
)

Defines values for UpdateClient403JSONResponseBodyError.

func (UpdateClient403JSONResponseBodyError) Valid 

func (e UpdateClient403JSONResponseBodyError) Valid() bool

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

type UpdateClientData 

type UpdateClientData struct {
	// BackchannelLogoutURI Where a back-channel logout token is delivered; `null` clears it.
	BackchannelLogoutURI nullable.Nullable[string] `json:"backchannel_logout_uri,omitempty"`

	// ConsentRequired Whether the identity is asked to consent before the client is granted its scopes.
	ConsentRequired *bool `json:"consent_required,omitempty"`

	// GrantTypes The grants the client may use. Replaces the current set.
	GrantTypes *[]UpdateClientDataGrantTypes `json:"grant_types,omitempty"`

	// Name Human readable name, shown to the identity on the consent screen.
	Name *string `json:"name,omitempty"`

	// PostLogoutRedirectUris Where an end-session request may return to. Replaces the current list.
	PostLogoutRedirectUris *[]string `json:"post_logout_redirect_uris,omitempty"`

	// RedirectUris Where an authorization response may be sent back to. Replaces the current list.
	RedirectUris *[]string `json:"redirect_uris,omitempty"`

	// TokenEndpointAuthMethod How the client authenticates at the token endpoint. Turning a public client confidential mints a secret; the other way around drops it.
	TokenEndpointAuthMethod *TokenEndpointAuthMethod `json:"token_endpoint_auth_method,omitempty"`
}

UpdateClientData defines model for UpdateClientData.

type UpdateClientDataGrantTypes 

type UpdateClientDataGrantTypes string

UpdateClientDataGrantTypes defines model for UpdateClientData.GrantTypes. 

const (
	UpdateClientDataGrantTypesAuthorizationCode UpdateClientDataGrantTypes = "authorization_code"
	UpdateClientDataGrantTypesClientCredentials UpdateClientDataGrantTypes = "client_credentials"
	UpdateClientDataGrantTypesRefreshToken      UpdateClientDataGrantTypes = "refresh_token"
)

Defines values for UpdateClientDataGrantTypes.

func (UpdateClientDataGrantTypes) Valid 

func (e UpdateClientDataGrantTypes) Valid() bool

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

type UpdateClientJSONRequestBody 

type UpdateClientJSONRequestBody = UpdateClientData

UpdateClientJSONRequestBody defines body for UpdateClient for application/json ContentType.

type UpdateResource401JSONResponseBodyError 

type UpdateResource401JSONResponseBodyError string

UpdateResource401JSONResponseBodyError defines parameters for UpdateResource. 

const (
	UpdateResource401JSONResponseBodyErrorInvalidToken UpdateResource401JSONResponseBodyError = "invalid_token"
)

Defines values for UpdateResource401JSONResponseBodyError.

func (UpdateResource401JSONResponseBodyError) Valid 

func (e UpdateResource401JSONResponseBodyError) Valid() bool

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

type UpdateResource403JSONResponseBodyError 

type UpdateResource403JSONResponseBodyError string

UpdateResource403JSONResponseBodyError defines parameters for UpdateResource. 

const (
	UpdateResource403JSONResponseBodyErrorInsufficientScope UpdateResource403JSONResponseBodyError = "insufficient_scope"
)

Defines values for UpdateResource403JSONResponseBodyError.

func (UpdateResource403JSONResponseBodyError) Valid 

func (e UpdateResource403JSONResponseBodyError) Valid() bool

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

type UpdateResourceData 

type UpdateResourceData struct {
	// Identifier A path relative to the realm issuer, or an absolute URI with a host and no fragment.
	Identifier *string `json:"identifier,omitempty"`

	// Name Human readable name of the protected resource.
	Name *string `json:"name,omitempty"`

	// Scopes Scope changes keyed by value: new values create, existing values update, delete: true removes. Omitted entries remain unchanged; an empty array changes nothing.
	Scopes *[]ResourceScopeChangeData `json:"scopes,omitempty"`
}

UpdateResourceData defines model for UpdateResourceData.

type UpdateResourceJSONRequestBody 

type UpdateResourceJSONRequestBody = UpdateResourceData

UpdateResourceJSONRequestBody defines body for UpdateResource for application/json ContentType.

type UpdateSocialProvider401JSONResponseBodyError 

type UpdateSocialProvider401JSONResponseBodyError string

UpdateSocialProvider401JSONResponseBodyError defines parameters for UpdateSocialProvider. 

const (
	UpdateSocialProvider401JSONResponseBodyErrorInvalidToken UpdateSocialProvider401JSONResponseBodyError = "invalid_token"
)

Defines values for UpdateSocialProvider401JSONResponseBodyError.

func (UpdateSocialProvider401JSONResponseBodyError) Valid 

func (e UpdateSocialProvider401JSONResponseBodyError) Valid() bool

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

type UpdateSocialProvider403JSONResponseBodyError 

type UpdateSocialProvider403JSONResponseBodyError string

UpdateSocialProvider403JSONResponseBodyError defines parameters for UpdateSocialProvider. 

const (
	UpdateSocialProvider403JSONResponseBodyErrorInsufficientScope UpdateSocialProvider403JSONResponseBodyError = "insufficient_scope"
)

Defines values for UpdateSocialProvider403JSONResponseBodyError.

func (UpdateSocialProvider403JSONResponseBodyError) Valid 

func (e UpdateSocialProvider403JSONResponseBodyError) Valid() bool

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

type UpdateSocialProviderData 

type UpdateSocialProviderData struct {
	// Config Credentials to replace. Omitted values and blank secrets keep their stored value.
	Config *SocialProviderCredentialsData `json:"config,omitempty"`

	// Enabled Whether the realm accepts sign-ins through this provider.
	Enabled *bool `json:"enabled,omitempty"`
}

UpdateSocialProviderData defines model for UpdateSocialProviderData.

type UpdateSocialProviderJSONRequestBody 

type UpdateSocialProviderJSONRequestBody = UpdateSocialProviderData

UpdateSocialProviderJSONRequestBody defines body for UpdateSocialProvider for application/json ContentType.

type ValidationException 

type ValidationException struct {
	// Errors A detailed description of each field that failed validation.
	Errors map[string][]string `json:"errors"`

	// Message Errors overview.
	Message string `json:"message"`
}

ValidationException defines model for ValidationException.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.