management

type APIError = lock.APIError

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
}

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"`
}

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"`
}

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

type ClientOption func(*Client) error

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

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"`
}

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

type CreateClient401JSONResponseBodyError string

type CreateClient403JSONResponseBodyError string

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"`
}

type CreateClientDataGrantTypes string

type CreateClientJSONRequestBody = CreateClientData

type CreateResource401JSONResponseBodyError string

type CreateResource403JSONResponseBodyError string

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"`
}

type CreateResourceJSONRequestBody = CreateResourceData

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"`
}

type CreateSocialProvider401JSONResponseBodyError string

type CreateSocialProvider403JSONResponseBodyError string

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"`
}

type CreateSocialProviderJSONRequestBody = CreateSocialProviderData

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"`
}

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

type DeleteClient401JSONResponseBodyError string

type DeleteClient403JSONResponseBodyError string

type DeleteResource401JSONResponseBodyError string

type DeleteResource403JSONResponseBodyError string

type DeleteSocialProvider401JSONResponseBodyError string

type DeleteSocialProvider403JSONResponseBodyError string

type GetClient401JSONResponseBodyError string

type GetClient403JSONResponseBodyError string

type GetClientSecret401JSONResponseBodyError string

type GetClientSecret403JSONResponseBodyError string

type GetResource401JSONResponseBodyError string

type GetResource403JSONResponseBodyError string

type GetSocialProvider401JSONResponseBodyError string

type GetSocialProvider403JSONResponseBodyError string

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

type ListClients401JSONResponseBodyError string

type ListClients403JSONResponseBodyError string

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"`
}

type ListClientsParamsSort string

type ListResources401JSONResponseBodyError string

type ListResources403JSONResponseBodyError string

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"`
}

type ListResourcesParamsSort string

type ListSocialProviders401JSONResponseBodyError string

type ListSocialProviders403JSONResponseBodyError string

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"`
}

type ListSocialProvidersParamsSort string

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

type PatchClient401JSONResponseBodyError string

type PatchClient403JSONResponseBodyError string

type PatchClientJSONRequestBody = UpdateClientData

type PatchResource401JSONResponseBodyError string

type PatchResource403JSONResponseBodyError string

type PatchResourceJSONRequestBody = UpdateResourceData

type PatchSocialProvider401JSONResponseBodyError string

type PatchSocialProvider403JSONResponseBodyError string

type PatchSocialProviderJSONRequestBody = UpdateSocialProviderData

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

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"`
}

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"`
}

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

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"`
}

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"`
}

type Response = lock.Response

type RotateClientSecret401JSONResponseBodyError string

type RotateClientSecret403JSONResponseBodyError string

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"`
}

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"`
}

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"`
}

type SocialProviderDriver string

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"`
}

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

type TokenEndpointAuthMethod string

type UpdateClient401JSONResponseBodyError string

type UpdateClient403JSONResponseBodyError string

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"`
}

type UpdateClientDataGrantTypes string

type UpdateClientJSONRequestBody = UpdateClientData

type UpdateResource401JSONResponseBodyError string

type UpdateResource403JSONResponseBodyError string

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"`
}

type UpdateResourceJSONRequestBody = UpdateResourceData

type UpdateSocialProvider401JSONResponseBodyError string

type UpdateSocialProvider403JSONResponseBodyError string

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"`
}

type UpdateSocialProviderJSONRequestBody = UpdateSocialProviderData

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"`
}