client

package module
v1.11.8 Latest Latest
Warning

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

Go to latest
Published: May 4, 2022 License: Apache-2.0 Imports: 22 Imported by: 14

README

ory/hydra-client-go

This is the official Ory Hydra SDK for go.

Please do not make any pull requests against this repository! Its contents are fully auto-generated by the ory/sdk repository. Any changes to this repository will be overwritten on the next CI run!

Installation

package repository is missing, please open an issue about this.

Generation

This code base, including this README, is auto-generated using OpenAPI Generator. If you find bugs in the SDK please check if there is an open issue at OpenAPITools/openapi-generator or ory/sdk already before opening an issue here.

If you have general feedback on the generated SDK please open an issue in ory/sdk.

Documentation

Unfortunately this SDK is not yet documented. If you are looking for contributing documentation please open an issue first to discuss your ideas. We are greatly appreciating any help!

In the meanwhile, check out the meta-documentation for Ory's SDKs:

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient

type APIClient struct {
	AdminApi AdminApi

	MetadataApi MetadataApi

	PublicApi PublicApi
	// contains filtered or unexported fields
}

APIClient manages communication with the Ory Hydra API API vv1.11.8 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AcceptConsentRequest

type AcceptConsentRequest struct {
	GrantAccessTokenAudience []string   `json:"grant_access_token_audience,omitempty"`
	GrantScope               []string   `json:"grant_scope,omitempty"`
	HandledAt                *time.Time `json:"handled_at,omitempty"`
	// Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope.
	Remember *bool `json:"remember,omitempty"`
	// RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely.
	RememberFor *int64                 `json:"remember_for,omitempty"`
	Session     *ConsentRequestSession `json:"session,omitempty"`
}

AcceptConsentRequest struct for AcceptConsentRequest

func NewAcceptConsentRequest

func NewAcceptConsentRequest() *AcceptConsentRequest

NewAcceptConsentRequest instantiates a new AcceptConsentRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAcceptConsentRequestWithDefaults

func NewAcceptConsentRequestWithDefaults() *AcceptConsentRequest

NewAcceptConsentRequestWithDefaults instantiates a new AcceptConsentRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AcceptConsentRequest) GetGrantAccessTokenAudience

func (o *AcceptConsentRequest) GetGrantAccessTokenAudience() []string

GetGrantAccessTokenAudience returns the GrantAccessTokenAudience field value if set, zero value otherwise.

func (*AcceptConsentRequest) GetGrantAccessTokenAudienceOk

func (o *AcceptConsentRequest) GetGrantAccessTokenAudienceOk() ([]string, bool)

GetGrantAccessTokenAudienceOk returns a tuple with the GrantAccessTokenAudience field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptConsentRequest) GetGrantScope

func (o *AcceptConsentRequest) GetGrantScope() []string

GetGrantScope returns the GrantScope field value if set, zero value otherwise.

func (*AcceptConsentRequest) GetGrantScopeOk

func (o *AcceptConsentRequest) GetGrantScopeOk() ([]string, bool)

GetGrantScopeOk returns a tuple with the GrantScope field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptConsentRequest) GetHandledAt

func (o *AcceptConsentRequest) GetHandledAt() time.Time

GetHandledAt returns the HandledAt field value if set, zero value otherwise.

func (*AcceptConsentRequest) GetHandledAtOk

func (o *AcceptConsentRequest) GetHandledAtOk() (*time.Time, bool)

GetHandledAtOk returns a tuple with the HandledAt field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptConsentRequest) GetRemember

func (o *AcceptConsentRequest) GetRemember() bool

GetRemember returns the Remember field value if set, zero value otherwise.

func (*AcceptConsentRequest) GetRememberFor

func (o *AcceptConsentRequest) GetRememberFor() int64

GetRememberFor returns the RememberFor field value if set, zero value otherwise.

func (*AcceptConsentRequest) GetRememberForOk

func (o *AcceptConsentRequest) GetRememberForOk() (*int64, bool)

GetRememberForOk returns a tuple with the RememberFor field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptConsentRequest) GetRememberOk

func (o *AcceptConsentRequest) GetRememberOk() (*bool, bool)

GetRememberOk returns a tuple with the Remember field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptConsentRequest) GetSession

GetSession returns the Session field value if set, zero value otherwise.

func (*AcceptConsentRequest) GetSessionOk

func (o *AcceptConsentRequest) GetSessionOk() (*ConsentRequestSession, bool)

GetSessionOk returns a tuple with the Session field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptConsentRequest) HasGrantAccessTokenAudience

func (o *AcceptConsentRequest) HasGrantAccessTokenAudience() bool

HasGrantAccessTokenAudience returns a boolean if a field has been set.

func (*AcceptConsentRequest) HasGrantScope

func (o *AcceptConsentRequest) HasGrantScope() bool

HasGrantScope returns a boolean if a field has been set.

func (*AcceptConsentRequest) HasHandledAt

func (o *AcceptConsentRequest) HasHandledAt() bool

HasHandledAt returns a boolean if a field has been set.

func (*AcceptConsentRequest) HasRemember

func (o *AcceptConsentRequest) HasRemember() bool

HasRemember returns a boolean if a field has been set.

func (*AcceptConsentRequest) HasRememberFor

func (o *AcceptConsentRequest) HasRememberFor() bool

HasRememberFor returns a boolean if a field has been set.

func (*AcceptConsentRequest) HasSession

func (o *AcceptConsentRequest) HasSession() bool

HasSession returns a boolean if a field has been set.

func (AcceptConsentRequest) MarshalJSON

func (o AcceptConsentRequest) MarshalJSON() ([]byte, error)

func (*AcceptConsentRequest) SetGrantAccessTokenAudience

func (o *AcceptConsentRequest) SetGrantAccessTokenAudience(v []string)

SetGrantAccessTokenAudience gets a reference to the given []string and assigns it to the GrantAccessTokenAudience field.

func (*AcceptConsentRequest) SetGrantScope

func (o *AcceptConsentRequest) SetGrantScope(v []string)

SetGrantScope gets a reference to the given []string and assigns it to the GrantScope field.

func (*AcceptConsentRequest) SetHandledAt

func (o *AcceptConsentRequest) SetHandledAt(v time.Time)

SetHandledAt gets a reference to the given time.Time and assigns it to the HandledAt field.

func (*AcceptConsentRequest) SetRemember

func (o *AcceptConsentRequest) SetRemember(v bool)

SetRemember gets a reference to the given bool and assigns it to the Remember field.

func (*AcceptConsentRequest) SetRememberFor

func (o *AcceptConsentRequest) SetRememberFor(v int64)

SetRememberFor gets a reference to the given int64 and assigns it to the RememberFor field.

func (*AcceptConsentRequest) SetSession

SetSession gets a reference to the given ConsentRequestSession and assigns it to the Session field.

type AcceptLoginRequest

type AcceptLoginRequest struct {
	// ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication.
	Acr     *string                `json:"acr,omitempty"`
	Amr     []string               `json:"amr,omitempty"`
	Context map[string]interface{} `json:"context,omitempty"`
	// ForceSubjectIdentifier forces the \"pairwise\" user ID of the end-user that authenticated. The \"pairwise\" user ID refers to the (Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID Connect specification. It allows you to set an obfuscated subject (\"user\") identifier that is unique to the client.  Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection.  Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if `pairwise` is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client's configuration).  Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value).  If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail.
	ForceSubjectIdentifier *string `json:"force_subject_identifier,omitempty"`
	// Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again.
	Remember *bool `json:"remember,omitempty"`
	// RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie).
	RememberFor *int64 `json:"remember_for,omitempty"`
	// Subject is the user ID of the end-user that authenticated.
	Subject string `json:"subject"`
}

AcceptLoginRequest struct for AcceptLoginRequest

func NewAcceptLoginRequest

func NewAcceptLoginRequest(subject string) *AcceptLoginRequest

NewAcceptLoginRequest instantiates a new AcceptLoginRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAcceptLoginRequestWithDefaults

func NewAcceptLoginRequestWithDefaults() *AcceptLoginRequest

NewAcceptLoginRequestWithDefaults instantiates a new AcceptLoginRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AcceptLoginRequest) GetAcr

func (o *AcceptLoginRequest) GetAcr() string

GetAcr returns the Acr field value if set, zero value otherwise.

func (*AcceptLoginRequest) GetAcrOk

func (o *AcceptLoginRequest) GetAcrOk() (*string, bool)

GetAcrOk returns a tuple with the Acr field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptLoginRequest) GetAmr

func (o *AcceptLoginRequest) GetAmr() []string

GetAmr returns the Amr field value if set, zero value otherwise.

func (*AcceptLoginRequest) GetAmrOk

func (o *AcceptLoginRequest) GetAmrOk() ([]string, bool)

GetAmrOk returns a tuple with the Amr field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptLoginRequest) GetContext

func (o *AcceptLoginRequest) GetContext() map[string]interface{}

GetContext returns the Context field value if set, zero value otherwise.

func (*AcceptLoginRequest) GetContextOk

func (o *AcceptLoginRequest) GetContextOk() (map[string]interface{}, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptLoginRequest) GetForceSubjectIdentifier

func (o *AcceptLoginRequest) GetForceSubjectIdentifier() string

GetForceSubjectIdentifier returns the ForceSubjectIdentifier field value if set, zero value otherwise.

func (*AcceptLoginRequest) GetForceSubjectIdentifierOk

func (o *AcceptLoginRequest) GetForceSubjectIdentifierOk() (*string, bool)

GetForceSubjectIdentifierOk returns a tuple with the ForceSubjectIdentifier field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptLoginRequest) GetRemember

func (o *AcceptLoginRequest) GetRemember() bool

GetRemember returns the Remember field value if set, zero value otherwise.

func (*AcceptLoginRequest) GetRememberFor

func (o *AcceptLoginRequest) GetRememberFor() int64

GetRememberFor returns the RememberFor field value if set, zero value otherwise.

func (*AcceptLoginRequest) GetRememberForOk

func (o *AcceptLoginRequest) GetRememberForOk() (*int64, bool)

GetRememberForOk returns a tuple with the RememberFor field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptLoginRequest) GetRememberOk

func (o *AcceptLoginRequest) GetRememberOk() (*bool, bool)

GetRememberOk returns a tuple with the Remember field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AcceptLoginRequest) GetSubject

func (o *AcceptLoginRequest) GetSubject() string

GetSubject returns the Subject field value

func (*AcceptLoginRequest) GetSubjectOk

func (o *AcceptLoginRequest) GetSubjectOk() (*string, bool)

GetSubjectOk returns a tuple with the Subject field value and a boolean to check if the value has been set.

func (*AcceptLoginRequest) HasAcr

func (o *AcceptLoginRequest) HasAcr() bool

HasAcr returns a boolean if a field has been set.

func (*AcceptLoginRequest) HasAmr

func (o *AcceptLoginRequest) HasAmr() bool

HasAmr returns a boolean if a field has been set.

func (*AcceptLoginRequest) HasContext

func (o *AcceptLoginRequest) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*AcceptLoginRequest) HasForceSubjectIdentifier

func (o *AcceptLoginRequest) HasForceSubjectIdentifier() bool

HasForceSubjectIdentifier returns a boolean if a field has been set.

func (*AcceptLoginRequest) HasRemember

func (o *AcceptLoginRequest) HasRemember() bool

HasRemember returns a boolean if a field has been set.

func (*AcceptLoginRequest) HasRememberFor

func (o *AcceptLoginRequest) HasRememberFor() bool

HasRememberFor returns a boolean if a field has been set.

func (AcceptLoginRequest) MarshalJSON

func (o AcceptLoginRequest) MarshalJSON() ([]byte, error)

func (*AcceptLoginRequest) SetAcr

func (o *AcceptLoginRequest) SetAcr(v string)

SetAcr gets a reference to the given string and assigns it to the Acr field.

func (*AcceptLoginRequest) SetAmr

func (o *AcceptLoginRequest) SetAmr(v []string)

SetAmr gets a reference to the given []string and assigns it to the Amr field.

func (*AcceptLoginRequest) SetContext

func (o *AcceptLoginRequest) SetContext(v map[string]interface{})

SetContext gets a reference to the given map[string]interface{} and assigns it to the Context field.

func (*AcceptLoginRequest) SetForceSubjectIdentifier

func (o *AcceptLoginRequest) SetForceSubjectIdentifier(v string)

SetForceSubjectIdentifier gets a reference to the given string and assigns it to the ForceSubjectIdentifier field.

func (*AcceptLoginRequest) SetRemember

func (o *AcceptLoginRequest) SetRemember(v bool)

SetRemember gets a reference to the given bool and assigns it to the Remember field.

func (*AcceptLoginRequest) SetRememberFor

func (o *AcceptLoginRequest) SetRememberFor(v int64)

SetRememberFor gets a reference to the given int64 and assigns it to the RememberFor field.

func (*AcceptLoginRequest) SetSubject

func (o *AcceptLoginRequest) SetSubject(v string)

SetSubject sets field value

type AdminApi

type AdminApi interface {

	/*
		 * AcceptConsentRequest Accept a Consent Request
		 * When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider
	to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if
	the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.

	The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to
	grant or deny the client access to the requested scope ("Application my-dropbox-app wants write access to all your private files").

	The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent
	provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted
	or rejected the request.

	This endpoint tells ORY Hydra that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf.
	The consent provider includes additional information, such as session data for access and ID tokens, and if the
	consent request should be used as basis for future requests.

	The response contains a redirect URL which the consent provider should redirect the user-agent to.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiAcceptConsentRequestRequest
	*/
	AcceptConsentRequest(ctx context.Context) AdminApiApiAcceptConsentRequestRequest

	/*
	 * AcceptConsentRequestExecute executes the request
	 * @return CompletedRequest
	 */
	AcceptConsentRequestExecute(r AdminApiApiAcceptConsentRequestRequest) (*CompletedRequest, *http.Response, error)

	/*
		 * AcceptLoginRequest Accept a Login Request
		 * When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider
	(sometimes called "identity provider") to authenticate the subject and then tell ORY Hydra now about it. The login
	provider is an web-app you write and host, and it must be able to authenticate ("show the subject a login screen")
	a subject (in OAuth2 the proper name for subject is "resource owner").

	The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login
	provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.

	This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as
	the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting
	a cookie.

	The response contains a redirect URL which the login provider should redirect the user-agent to.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiAcceptLoginRequestRequest
	*/
	AcceptLoginRequest(ctx context.Context) AdminApiApiAcceptLoginRequestRequest

	/*
	 * AcceptLoginRequestExecute executes the request
	 * @return CompletedRequest
	 */
	AcceptLoginRequestExecute(r AdminApiApiAcceptLoginRequestRequest) (*CompletedRequest, *http.Response, error)

	/*
		 * AcceptLogoutRequest Accept a Logout Request
		 * When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request.
	No body is required.

	The response contains a redirect URL which the consent provider should redirect the user-agent to.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiAcceptLogoutRequestRequest
	*/
	AcceptLogoutRequest(ctx context.Context) AdminApiApiAcceptLogoutRequestRequest

	/*
	 * AcceptLogoutRequestExecute executes the request
	 * @return CompletedRequest
	 */
	AcceptLogoutRequestExecute(r AdminApiApiAcceptLogoutRequestRequest) (*CompletedRequest, *http.Response, error)

	/*
		 * CreateJsonWebKeySet Generate a New JSON Web Key
		 * This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created.

	A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param set The set
		 * @return AdminApiApiCreateJsonWebKeySetRequest
	*/
	CreateJsonWebKeySet(ctx context.Context, set string) AdminApiApiCreateJsonWebKeySetRequest

	/*
	 * CreateJsonWebKeySetExecute executes the request
	 * @return JSONWebKeySet
	 */
	CreateJsonWebKeySetExecute(r AdminApiApiCreateJsonWebKeySetRequest) (*JSONWebKeySet, *http.Response, error)

	/*
		 * CreateOAuth2Client Create an OAuth 2.0 Client
		 * Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret
	will be generated. The secret will be returned in the response and you will not be able to retrieve it later on.
	Write the secret down and keep it somwhere safe.

	OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are
	generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiCreateOAuth2ClientRequest
	*/
	CreateOAuth2Client(ctx context.Context) AdminApiApiCreateOAuth2ClientRequest

	/*
	 * CreateOAuth2ClientExecute executes the request
	 * @return OAuth2Client
	 */
	CreateOAuth2ClientExecute(r AdminApiApiCreateOAuth2ClientRequest) (*OAuth2Client, *http.Response, error)

	/*
		 * DeleteJsonWebKey Delete a JSON Web Key
		 * Use this endpoint to delete a single JSON Web Key.

	A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param kid The kid of the desired key
		 * @param set The set
		 * @return AdminApiApiDeleteJsonWebKeyRequest
	*/
	DeleteJsonWebKey(ctx context.Context, kid string, set string) AdminApiApiDeleteJsonWebKeyRequest

	/*
	 * DeleteJsonWebKeyExecute executes the request
	 */
	DeleteJsonWebKeyExecute(r AdminApiApiDeleteJsonWebKeyRequest) (*http.Response, error)

	/*
		 * DeleteJsonWebKeySet Delete a JSON Web Key Set
		 * Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set.

	A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param set The set
		 * @return AdminApiApiDeleteJsonWebKeySetRequest
	*/
	DeleteJsonWebKeySet(ctx context.Context, set string) AdminApiApiDeleteJsonWebKeySetRequest

	/*
	 * DeleteJsonWebKeySetExecute executes the request
	 */
	DeleteJsonWebKeySetExecute(r AdminApiApiDeleteJsonWebKeySetRequest) (*http.Response, error)

	/*
		 * DeleteOAuth2Client Deletes an OAuth 2.0 Client
		 * Delete an existing OAuth 2.0 Client by its ID.

	OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are
	generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

	Make sure that this endpoint is well protected and only callable by first-party components.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param id The id of the OAuth 2.0 Client.
		 * @return AdminApiApiDeleteOAuth2ClientRequest
	*/
	DeleteOAuth2Client(ctx context.Context, id string) AdminApiApiDeleteOAuth2ClientRequest

	/*
	 * DeleteOAuth2ClientExecute executes the request
	 */
	DeleteOAuth2ClientExecute(r AdminApiApiDeleteOAuth2ClientRequest) (*http.Response, error)

	/*
	 * DeleteOAuth2Token Delete OAuth2 Access Tokens from a Client
	 * This endpoint deletes OAuth2 access tokens issued for a client from the database
	 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return AdminApiApiDeleteOAuth2TokenRequest
	 */
	DeleteOAuth2Token(ctx context.Context) AdminApiApiDeleteOAuth2TokenRequest

	/*
	 * DeleteOAuth2TokenExecute executes the request
	 */
	DeleteOAuth2TokenExecute(r AdminApiApiDeleteOAuth2TokenRequest) (*http.Response, error)

	/*
		 * DeleteTrustedJwtGrantIssuer Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
		 * Use this endpoint to delete trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you
	created the trust relationship.

	Once deleted, the associated issuer will no longer be able to perform the JSON Web Token (JWT) Profile
	for OAuth 2.0 Client Authentication and Authorization Grant.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param id The id of the desired grant
		 * @return AdminApiApiDeleteTrustedJwtGrantIssuerRequest
	*/
	DeleteTrustedJwtGrantIssuer(ctx context.Context, id string) AdminApiApiDeleteTrustedJwtGrantIssuerRequest

	/*
	 * DeleteTrustedJwtGrantIssuerExecute executes the request
	 */
	DeleteTrustedJwtGrantIssuerExecute(r AdminApiApiDeleteTrustedJwtGrantIssuerRequest) (*http.Response, error)

	/*
		 * FlushInactiveOAuth2Tokens Flush Expired OAuth2 Access Tokens
		 * This endpoint flushes expired OAuth2 access tokens from the database. You can set a time after which no tokens will be
	not be touched, in case you want to keep recent tokens for auditing. Refresh tokens can not be flushed as they are deleted
	automatically when performing the refresh flow.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiFlushInactiveOAuth2TokensRequest
	*/
	FlushInactiveOAuth2Tokens(ctx context.Context) AdminApiApiFlushInactiveOAuth2TokensRequest

	/*
	 * FlushInactiveOAuth2TokensExecute executes the request
	 */
	FlushInactiveOAuth2TokensExecute(r AdminApiApiFlushInactiveOAuth2TokensRequest) (*http.Response, error)

	/*
		 * GetConsentRequest Get Consent Request Information
		 * When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider
	to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if
	the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.

	The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to
	grant or deny the client access to the requested scope ("Application my-dropbox-app wants write access to all your private files").

	The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent
	provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted
	or rejected the request.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiGetConsentRequestRequest
	*/
	GetConsentRequest(ctx context.Context) AdminApiApiGetConsentRequestRequest

	/*
	 * GetConsentRequestExecute executes the request
	 * @return ConsentRequest
	 */
	GetConsentRequestExecute(r AdminApiApiGetConsentRequestRequest) (*ConsentRequest, *http.Response, error)

	/*
	 * GetJsonWebKey Fetch a JSON Web Key
	 * This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid).
	 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param kid The kid of the desired key
	 * @param set The set
	 * @return AdminApiApiGetJsonWebKeyRequest
	 */
	GetJsonWebKey(ctx context.Context, kid string, set string) AdminApiApiGetJsonWebKeyRequest

	/*
	 * GetJsonWebKeyExecute executes the request
	 * @return JSONWebKeySet
	 */
	GetJsonWebKeyExecute(r AdminApiApiGetJsonWebKeyRequest) (*JSONWebKeySet, *http.Response, error)

	/*
		 * GetJsonWebKeySet Retrieve a JSON Web Key Set
		 * This endpoint can be used to retrieve JWK Sets stored in ORY Hydra.

	A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param set The set
		 * @return AdminApiApiGetJsonWebKeySetRequest
	*/
	GetJsonWebKeySet(ctx context.Context, set string) AdminApiApiGetJsonWebKeySetRequest

	/*
	 * GetJsonWebKeySetExecute executes the request
	 * @return JSONWebKeySet
	 */
	GetJsonWebKeySetExecute(r AdminApiApiGetJsonWebKeySetRequest) (*JSONWebKeySet, *http.Response, error)

	/*
		 * GetLoginRequest Get a Login Request
		 * When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider
	(sometimes called "identity provider") to authenticate the subject and then tell ORY Hydra now about it. The login
	provider is an web-app you write and host, and it must be able to authenticate ("show the subject a login screen")
	a subject (in OAuth2 the proper name for subject is "resource owner").

	The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login
	provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiGetLoginRequestRequest
	*/
	GetLoginRequest(ctx context.Context) AdminApiApiGetLoginRequestRequest

	/*
	 * GetLoginRequestExecute executes the request
	 * @return LoginRequest
	 */
	GetLoginRequestExecute(r AdminApiApiGetLoginRequestRequest) (*LoginRequest, *http.Response, error)

	/*
	 * GetLogoutRequest Get a Logout Request
	 * Use this endpoint to fetch a logout request.
	 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return AdminApiApiGetLogoutRequestRequest
	 */
	GetLogoutRequest(ctx context.Context) AdminApiApiGetLogoutRequestRequest

	/*
	 * GetLogoutRequestExecute executes the request
	 * @return LogoutRequest
	 */
	GetLogoutRequestExecute(r AdminApiApiGetLogoutRequestRequest) (*LogoutRequest, *http.Response, error)

	/*
		 * GetOAuth2Client Get an OAuth 2.0 Client
		 * Get an OAuth 2.0 client by its ID. This endpoint never returns the client secret.

	OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are
	generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param id The id of the OAuth 2.0 Client.
		 * @return AdminApiApiGetOAuth2ClientRequest
	*/
	GetOAuth2Client(ctx context.Context, id string) AdminApiApiGetOAuth2ClientRequest

	/*
	 * GetOAuth2ClientExecute executes the request
	 * @return OAuth2Client
	 */
	GetOAuth2ClientExecute(r AdminApiApiGetOAuth2ClientRequest) (*OAuth2Client, *http.Response, error)

	/*
		 * GetTrustedJwtGrantIssuer Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
		 * Use this endpoint to get a trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you
	created the trust relationship.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param id The id of the desired grant
		 * @return AdminApiApiGetTrustedJwtGrantIssuerRequest
	*/
	GetTrustedJwtGrantIssuer(ctx context.Context, id string) AdminApiApiGetTrustedJwtGrantIssuerRequest

	/*
	 * GetTrustedJwtGrantIssuerExecute executes the request
	 * @return TrustedJwtGrantIssuer
	 */
	GetTrustedJwtGrantIssuerExecute(r AdminApiApiGetTrustedJwtGrantIssuerRequest) (*TrustedJwtGrantIssuer, *http.Response, error)

	/*
		 * IntrospectOAuth2Token Introspect OAuth2 Tokens
		 * The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token
	is neither expired nor revoked. If a token is active, additional information on the token will be included. You can
	set additional data for a token by setting `accessTokenExtra` during the consent flow.

	For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiIntrospectOAuth2TokenRequest
	*/
	IntrospectOAuth2Token(ctx context.Context) AdminApiApiIntrospectOAuth2TokenRequest

	/*
	 * IntrospectOAuth2TokenExecute executes the request
	 * @return OAuth2TokenIntrospection
	 */
	IntrospectOAuth2TokenExecute(r AdminApiApiIntrospectOAuth2TokenRequest) (*OAuth2TokenIntrospection, *http.Response, error)

	/*
		 * ListOAuth2Clients List OAuth 2.0 Clients
		 * This endpoint lists all clients in the database, and never returns client secrets.
	As a default it lists the first 100 clients. The `limit` parameter can be used to retrieve more clients,
	but it has an upper bound at 500 objects. Pagination should be used to retrieve more than 500 objects.

	OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are
	generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

	The "Link" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/clients?limit={limit}&offset={offset}>; rel="{page}"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'.
	Multiple links can be included in this header, and will be separated by a comma.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiListOAuth2ClientsRequest
	*/
	ListOAuth2Clients(ctx context.Context) AdminApiApiListOAuth2ClientsRequest

	/*
	 * ListOAuth2ClientsExecute executes the request
	 * @return []OAuth2Client
	 */
	ListOAuth2ClientsExecute(r AdminApiApiListOAuth2ClientsRequest) ([]OAuth2Client, *http.Response, error)

	/*
		 * ListSubjectConsentSessions Lists All Consent Sessions of a Subject
		 * This endpoint lists all subject's granted consent sessions, including client and granted scope.
	If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an
	empty JSON array with status code 200 OK.


	The "Link" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&limit={limit}&offset={offset}>; rel="{page}"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'.
	Multiple links can be included in this header, and will be separated by a comma.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiListSubjectConsentSessionsRequest
	*/
	ListSubjectConsentSessions(ctx context.Context) AdminApiApiListSubjectConsentSessionsRequest

	/*
	 * ListSubjectConsentSessionsExecute executes the request
	 * @return []PreviousConsentSession
	 */
	ListSubjectConsentSessionsExecute(r AdminApiApiListSubjectConsentSessionsRequest) ([]PreviousConsentSession, *http.Response, error)

	/*
	 * ListTrustedJwtGrantIssuers List Trusted OAuth2 JWT Bearer Grant Type Issuers
	 * Use this endpoint to list all trusted JWT Bearer Grant Type Issuers.
	 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return AdminApiApiListTrustedJwtGrantIssuersRequest
	 */
	ListTrustedJwtGrantIssuers(ctx context.Context) AdminApiApiListTrustedJwtGrantIssuersRequest

	/*
	 * ListTrustedJwtGrantIssuersExecute executes the request
	 * @return []TrustedJwtGrantIssuer
	 */
	ListTrustedJwtGrantIssuersExecute(r AdminApiApiListTrustedJwtGrantIssuersRequest) ([]TrustedJwtGrantIssuer, *http.Response, error)

	/*
		 * PatchOAuth2Client Patch an OAuth 2.0 Client
		 * Patch an existing OAuth 2.0 Client. If you pass `client_secret`
	the secret will be updated and returned via the API. This is the
	only time you will be able to retrieve the client secret, so write it down and keep it safe.

	OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are
	generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param id The id of the OAuth 2.0 Client.
		 * @return AdminApiApiPatchOAuth2ClientRequest
	*/
	PatchOAuth2Client(ctx context.Context, id string) AdminApiApiPatchOAuth2ClientRequest

	/*
	 * PatchOAuth2ClientExecute executes the request
	 * @return OAuth2Client
	 */
	PatchOAuth2ClientExecute(r AdminApiApiPatchOAuth2ClientRequest) (*OAuth2Client, *http.Response, error)

	/*
		 * RejectConsentRequest Reject a Consent Request
		 * When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider
	to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if
	the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.

	The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to
	grant or deny the client access to the requested scope ("Application my-dropbox-app wants write access to all your private files").

	The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent
	provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted
	or rejected the request.

	This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf.
	The consent provider must include a reason why the consent was not granted.

	The response contains a redirect URL which the consent provider should redirect the user-agent to.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiRejectConsentRequestRequest
	*/
	RejectConsentRequest(ctx context.Context) AdminApiApiRejectConsentRequestRequest

	/*
	 * RejectConsentRequestExecute executes the request
	 * @return CompletedRequest
	 */
	RejectConsentRequestExecute(r AdminApiApiRejectConsentRequestRequest) (*CompletedRequest, *http.Response, error)

	/*
		 * RejectLoginRequest Reject a Login Request
		 * When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider
	(sometimes called "identity provider") to authenticate the subject and then tell ORY Hydra now about it. The login
	provider is an web-app you write and host, and it must be able to authenticate ("show the subject a login screen")
	a subject (in OAuth2 the proper name for subject is "resource owner").

	The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login
	provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.

	This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication
	was be denied.

	The response contains a redirect URL which the login provider should redirect the user-agent to.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiRejectLoginRequestRequest
	*/
	RejectLoginRequest(ctx context.Context) AdminApiApiRejectLoginRequestRequest

	/*
	 * RejectLoginRequestExecute executes the request
	 * @return CompletedRequest
	 */
	RejectLoginRequestExecute(r AdminApiApiRejectLoginRequestRequest) (*CompletedRequest, *http.Response, error)

	/*
		 * RejectLogoutRequest Reject a Logout Request
		 * When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request.
	No body is required.

	The response is empty as the logout provider has to chose what action to perform next.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiRejectLogoutRequestRequest
	*/
	RejectLogoutRequest(ctx context.Context) AdminApiApiRejectLogoutRequestRequest

	/*
	 * RejectLogoutRequestExecute executes the request
	 */
	RejectLogoutRequestExecute(r AdminApiApiRejectLogoutRequestRequest) (*http.Response, error)

	/*
		 * RevokeAuthenticationSession Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
		 * This endpoint invalidates a subject's authentication session. After revoking the authentication session, the subject
	has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect
	Front- or Back-channel logout.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiRevokeAuthenticationSessionRequest
	*/
	RevokeAuthenticationSession(ctx context.Context) AdminApiApiRevokeAuthenticationSessionRequest

	/*
	 * RevokeAuthenticationSessionExecute executes the request
	 */
	RevokeAuthenticationSessionExecute(r AdminApiApiRevokeAuthenticationSessionRequest) (*http.Response, error)

	/*
		 * RevokeConsentSessions Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
		 * This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all
	associated OAuth 2.0 Access Tokens.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiRevokeConsentSessionsRequest
	*/
	RevokeConsentSessions(ctx context.Context) AdminApiApiRevokeConsentSessionsRequest

	/*
	 * RevokeConsentSessionsExecute executes the request
	 */
	RevokeConsentSessionsExecute(r AdminApiApiRevokeConsentSessionsRequest) (*http.Response, error)

	/*
		 * TrustJwtGrantIssuer Trust an OAuth2 JWT Bearer Grant Type Issuer
		 * Use this endpoint to establish a trust relationship for a JWT issuer
	to perform JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication
	and Authorization Grants [RFC7523](https://datatracker.ietf.org/doc/html/rfc7523).
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return AdminApiApiTrustJwtGrantIssuerRequest
	*/
	TrustJwtGrantIssuer(ctx context.Context) AdminApiApiTrustJwtGrantIssuerRequest

	/*
	 * TrustJwtGrantIssuerExecute executes the request
	 * @return TrustedJwtGrantIssuer
	 */
	TrustJwtGrantIssuerExecute(r AdminApiApiTrustJwtGrantIssuerRequest) (*TrustedJwtGrantIssuer, *http.Response, error)

	/*
		 * UpdateJsonWebKey Update a JSON Web Key
		 * Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.

	A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param kid The kid of the desired key
		 * @param set The set
		 * @return AdminApiApiUpdateJsonWebKeyRequest
	*/
	UpdateJsonWebKey(ctx context.Context, kid string, set string) AdminApiApiUpdateJsonWebKeyRequest

	/*
	 * UpdateJsonWebKeyExecute executes the request
	 * @return JSONWebKey
	 */
	UpdateJsonWebKeyExecute(r AdminApiApiUpdateJsonWebKeyRequest) (*JSONWebKey, *http.Response, error)

	/*
		 * UpdateJsonWebKeySet Update a JSON Web Key Set
		 * Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.

	A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param set The set
		 * @return AdminApiApiUpdateJsonWebKeySetRequest
	*/
	UpdateJsonWebKeySet(ctx context.Context, set string) AdminApiApiUpdateJsonWebKeySetRequest

	/*
	 * UpdateJsonWebKeySetExecute executes the request
	 * @return JSONWebKeySet
	 */
	UpdateJsonWebKeySetExecute(r AdminApiApiUpdateJsonWebKeySetRequest) (*JSONWebKeySet, *http.Response, error)

	/*
		 * UpdateOAuth2Client Update an OAuth 2.0 Client
		 * Update an existing OAuth 2.0 Client. If you pass `client_secret` the secret will be updated and returned via the API.
	This is the only time you will be able to retrieve the client secret, so write it down and keep it safe.

	OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are
	generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @param id The id of the OAuth 2.0 Client.
		 * @return AdminApiApiUpdateOAuth2ClientRequest
	*/
	UpdateOAuth2Client(ctx context.Context, id string) AdminApiApiUpdateOAuth2ClientRequest

	/*
	 * UpdateOAuth2ClientExecute executes the request
	 * @return OAuth2Client
	 */
	UpdateOAuth2ClientExecute(r AdminApiApiUpdateOAuth2ClientRequest) (*OAuth2Client, *http.Response, error)
}

type AdminApiApiAcceptConsentRequestRequest

type AdminApiApiAcceptConsentRequestRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiAcceptConsentRequestRequest) AcceptConsentRequest

func (AdminApiApiAcceptConsentRequestRequest) ConsentChallenge

func (AdminApiApiAcceptConsentRequestRequest) Execute

type AdminApiApiAcceptLoginRequestRequest

type AdminApiApiAcceptLoginRequestRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiAcceptLoginRequestRequest) AcceptLoginRequest

func (AdminApiApiAcceptLoginRequestRequest) Execute

func (AdminApiApiAcceptLoginRequestRequest) LoginChallenge

type AdminApiApiAcceptLogoutRequestRequest

type AdminApiApiAcceptLogoutRequestRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiAcceptLogoutRequestRequest) Execute

func (AdminApiApiAcceptLogoutRequestRequest) LogoutChallenge

type AdminApiApiCreateJsonWebKeySetRequest

type AdminApiApiCreateJsonWebKeySetRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiCreateJsonWebKeySetRequest) Execute

func (AdminApiApiCreateJsonWebKeySetRequest) JsonWebKeySetGeneratorRequest

func (r AdminApiApiCreateJsonWebKeySetRequest) JsonWebKeySetGeneratorRequest(jsonWebKeySetGeneratorRequest JsonWebKeySetGeneratorRequest) AdminApiApiCreateJsonWebKeySetRequest

type AdminApiApiCreateOAuth2ClientRequest

type AdminApiApiCreateOAuth2ClientRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiCreateOAuth2ClientRequest) Execute

func (AdminApiApiCreateOAuth2ClientRequest) OAuth2Client

type AdminApiApiDeleteJsonWebKeyRequest

type AdminApiApiDeleteJsonWebKeyRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiDeleteJsonWebKeyRequest) Execute

type AdminApiApiDeleteJsonWebKeySetRequest

type AdminApiApiDeleteJsonWebKeySetRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiDeleteJsonWebKeySetRequest) Execute

type AdminApiApiDeleteOAuth2ClientRequest

type AdminApiApiDeleteOAuth2ClientRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiDeleteOAuth2ClientRequest) Execute

type AdminApiApiDeleteOAuth2TokenRequest

type AdminApiApiDeleteOAuth2TokenRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiDeleteOAuth2TokenRequest) ClientId

func (AdminApiApiDeleteOAuth2TokenRequest) Execute

type AdminApiApiDeleteTrustedJwtGrantIssuerRequest

type AdminApiApiDeleteTrustedJwtGrantIssuerRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiDeleteTrustedJwtGrantIssuerRequest) Execute

type AdminApiApiFlushInactiveOAuth2TokensRequest

type AdminApiApiFlushInactiveOAuth2TokensRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiFlushInactiveOAuth2TokensRequest) Execute

func (AdminApiApiFlushInactiveOAuth2TokensRequest) FlushInactiveOAuth2TokensRequest

func (r AdminApiApiFlushInactiveOAuth2TokensRequest) FlushInactiveOAuth2TokensRequest(flushInactiveOAuth2TokensRequest FlushInactiveOAuth2TokensRequest) AdminApiApiFlushInactiveOAuth2TokensRequest

type AdminApiApiGetConsentRequestRequest

type AdminApiApiGetConsentRequestRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiGetConsentRequestRequest) ConsentChallenge

func (AdminApiApiGetConsentRequestRequest) Execute

type AdminApiApiGetJsonWebKeyRequest

type AdminApiApiGetJsonWebKeyRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiGetJsonWebKeyRequest) Execute

type AdminApiApiGetJsonWebKeySetRequest

type AdminApiApiGetJsonWebKeySetRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiGetJsonWebKeySetRequest) Execute

type AdminApiApiGetLoginRequestRequest

type AdminApiApiGetLoginRequestRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiGetLoginRequestRequest) Execute

func (AdminApiApiGetLoginRequestRequest) LoginChallenge

type AdminApiApiGetLogoutRequestRequest

type AdminApiApiGetLogoutRequestRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiGetLogoutRequestRequest) Execute

func (AdminApiApiGetLogoutRequestRequest) LogoutChallenge

type AdminApiApiGetOAuth2ClientRequest

type AdminApiApiGetOAuth2ClientRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiGetOAuth2ClientRequest) Execute

type AdminApiApiGetTrustedJwtGrantIssuerRequest

type AdminApiApiGetTrustedJwtGrantIssuerRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiGetTrustedJwtGrantIssuerRequest) Execute

type AdminApiApiIntrospectOAuth2TokenRequest

type AdminApiApiIntrospectOAuth2TokenRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiIntrospectOAuth2TokenRequest) Execute

func (AdminApiApiIntrospectOAuth2TokenRequest) Scope

func (AdminApiApiIntrospectOAuth2TokenRequest) Token

type AdminApiApiListOAuth2ClientsRequest

type AdminApiApiListOAuth2ClientsRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiListOAuth2ClientsRequest) ClientName

func (AdminApiApiListOAuth2ClientsRequest) Execute

func (AdminApiApiListOAuth2ClientsRequest) Limit

func (AdminApiApiListOAuth2ClientsRequest) Offset

func (AdminApiApiListOAuth2ClientsRequest) Owner

type AdminApiApiListSubjectConsentSessionsRequest

type AdminApiApiListSubjectConsentSessionsRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiListSubjectConsentSessionsRequest) Execute

func (AdminApiApiListSubjectConsentSessionsRequest) Limit

func (AdminApiApiListSubjectConsentSessionsRequest) Offset

func (AdminApiApiListSubjectConsentSessionsRequest) Subject

type AdminApiApiListTrustedJwtGrantIssuersRequest

type AdminApiApiListTrustedJwtGrantIssuersRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiListTrustedJwtGrantIssuersRequest) Execute

func (AdminApiApiListTrustedJwtGrantIssuersRequest) Issuer

func (AdminApiApiListTrustedJwtGrantIssuersRequest) Limit

func (AdminApiApiListTrustedJwtGrantIssuersRequest) Offset

type AdminApiApiPatchOAuth2ClientRequest

type AdminApiApiPatchOAuth2ClientRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiPatchOAuth2ClientRequest) Execute

func (AdminApiApiPatchOAuth2ClientRequest) PatchDocument

type AdminApiApiRejectConsentRequestRequest

type AdminApiApiRejectConsentRequestRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiRejectConsentRequestRequest) ConsentChallenge

func (AdminApiApiRejectConsentRequestRequest) Execute

func (AdminApiApiRejectConsentRequestRequest) RejectRequest

type AdminApiApiRejectLoginRequestRequest

type AdminApiApiRejectLoginRequestRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiRejectLoginRequestRequest) Execute

func (AdminApiApiRejectLoginRequestRequest) LoginChallenge

func (AdminApiApiRejectLoginRequestRequest) RejectRequest

type AdminApiApiRejectLogoutRequestRequest

type AdminApiApiRejectLogoutRequestRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiRejectLogoutRequestRequest) Execute

func (AdminApiApiRejectLogoutRequestRequest) LogoutChallenge

func (AdminApiApiRejectLogoutRequestRequest) RejectRequest

type AdminApiApiRevokeAuthenticationSessionRequest

type AdminApiApiRevokeAuthenticationSessionRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiRevokeAuthenticationSessionRequest) Execute

func (AdminApiApiRevokeAuthenticationSessionRequest) Subject

type AdminApiApiRevokeConsentSessionsRequest

type AdminApiApiRevokeConsentSessionsRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiRevokeConsentSessionsRequest) All

func (AdminApiApiRevokeConsentSessionsRequest) Client

func (AdminApiApiRevokeConsentSessionsRequest) Execute

func (AdminApiApiRevokeConsentSessionsRequest) Subject

type AdminApiApiTrustJwtGrantIssuerRequest

type AdminApiApiTrustJwtGrantIssuerRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiTrustJwtGrantIssuerRequest) Execute

func (AdminApiApiTrustJwtGrantIssuerRequest) TrustJwtGrantIssuerBody

type AdminApiApiUpdateJsonWebKeyRequest

type AdminApiApiUpdateJsonWebKeyRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiUpdateJsonWebKeyRequest) Execute

func (AdminApiApiUpdateJsonWebKeyRequest) JSONWebKey

type AdminApiApiUpdateJsonWebKeySetRequest

type AdminApiApiUpdateJsonWebKeySetRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiUpdateJsonWebKeySetRequest) Execute

func (AdminApiApiUpdateJsonWebKeySetRequest) JSONWebKeySet

type AdminApiApiUpdateOAuth2ClientRequest

type AdminApiApiUpdateOAuth2ClientRequest struct {
	ApiService AdminApi
	// contains filtered or unexported fields
}

func (AdminApiApiUpdateOAuth2ClientRequest) Execute

func (AdminApiApiUpdateOAuth2ClientRequest) OAuth2Client

type AdminApiService

type AdminApiService service

AdminApiService AdminApi service

func (*AdminApiService) AcceptConsentRequest

  • AcceptConsentRequest Accept a Consent Request
  • When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider

to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.

The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope ("Application my-dropbox-app wants write access to all your private files").

The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.

This endpoint tells ORY Hydra that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used as basis for future requests.

The response contains a redirect URL which the consent provider should redirect the user-agent to.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiAcceptConsentRequestRequest

func (*AdminApiService) AcceptConsentRequestExecute

* Execute executes the request * @return CompletedRequest

func (*AdminApiService) AcceptLoginRequest

  • AcceptLoginRequest Accept a Login Request
  • When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider

(sometimes called "identity provider") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate ("show the subject a login screen") a subject (in OAuth2 the proper name for subject is "resource owner").

The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.

This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting a cookie.

The response contains a redirect URL which the login provider should redirect the user-agent to.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiAcceptLoginRequestRequest

func (*AdminApiService) AcceptLoginRequestExecute

* Execute executes the request * @return CompletedRequest

func (*AdminApiService) AcceptLogoutRequest

  • AcceptLogoutRequest Accept a Logout Request
  • When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request.

No body is required.

The response contains a redirect URL which the consent provider should redirect the user-agent to.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiAcceptLogoutRequestRequest

func (*AdminApiService) AcceptLogoutRequestExecute

* Execute executes the request * @return CompletedRequest

func (*AdminApiService) CreateJsonWebKeySet

  • CreateJsonWebKeySet Generate a New JSON Web Key
  • This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created.

A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param set The set
  • @return AdminApiApiCreateJsonWebKeySetRequest

func (*AdminApiService) CreateJsonWebKeySetExecute

* Execute executes the request * @return JSONWebKeySet

func (*AdminApiService) CreateOAuth2Client

  • CreateOAuth2Client Create an OAuth 2.0 Client
  • Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret

will be generated. The secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somwhere safe.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiCreateOAuth2ClientRequest

func (*AdminApiService) CreateOAuth2ClientExecute

* Execute executes the request * @return OAuth2Client

func (*AdminApiService) DeleteJsonWebKey

  • DeleteJsonWebKey Delete a JSON Web Key
  • Use this endpoint to delete a single JSON Web Key.

A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param kid The kid of the desired key
  • @param set The set
  • @return AdminApiApiDeleteJsonWebKeyRequest

func (*AdminApiService) DeleteJsonWebKeyExecute

func (a *AdminApiService) DeleteJsonWebKeyExecute(r AdminApiApiDeleteJsonWebKeyRequest) (*http.Response, error)

* Execute executes the request

func (*AdminApiService) DeleteJsonWebKeySet

  • DeleteJsonWebKeySet Delete a JSON Web Key Set
  • Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set.

A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param set The set
  • @return AdminApiApiDeleteJsonWebKeySetRequest

func (*AdminApiService) DeleteJsonWebKeySetExecute

func (a *AdminApiService) DeleteJsonWebKeySetExecute(r AdminApiApiDeleteJsonWebKeySetRequest) (*http.Response, error)

* Execute executes the request

func (*AdminApiService) DeleteOAuth2Client

  • DeleteOAuth2Client Deletes an OAuth 2.0 Client
  • Delete an existing OAuth 2.0 Client by its ID.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

Make sure that this endpoint is well protected and only callable by first-party components.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the OAuth 2.0 Client.
  • @return AdminApiApiDeleteOAuth2ClientRequest

func (*AdminApiService) DeleteOAuth2ClientExecute

func (a *AdminApiService) DeleteOAuth2ClientExecute(r AdminApiApiDeleteOAuth2ClientRequest) (*http.Response, error)

* Execute executes the request

func (*AdminApiService) DeleteOAuth2Token

* DeleteOAuth2Token Delete OAuth2 Access Tokens from a Client * This endpoint deletes OAuth2 access tokens issued for a client from the database * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return AdminApiApiDeleteOAuth2TokenRequest

func (*AdminApiService) DeleteOAuth2TokenExecute

func (a *AdminApiService) DeleteOAuth2TokenExecute(r AdminApiApiDeleteOAuth2TokenRequest) (*http.Response, error)

* Execute executes the request

func (*AdminApiService) DeleteTrustedJwtGrantIssuer

  • DeleteTrustedJwtGrantIssuer Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
  • Use this endpoint to delete trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you

created the trust relationship.

Once deleted, the associated issuer will no longer be able to perform the JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grant.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the desired grant
  • @return AdminApiApiDeleteTrustedJwtGrantIssuerRequest

func (*AdminApiService) DeleteTrustedJwtGrantIssuerExecute

func (a *AdminApiService) DeleteTrustedJwtGrantIssuerExecute(r AdminApiApiDeleteTrustedJwtGrantIssuerRequest) (*http.Response, error)

* Execute executes the request

func (*AdminApiService) FlushInactiveOAuth2Tokens

  • FlushInactiveOAuth2Tokens Flush Expired OAuth2 Access Tokens
  • This endpoint flushes expired OAuth2 access tokens from the database. You can set a time after which no tokens will be

not be touched, in case you want to keep recent tokens for auditing. Refresh tokens can not be flushed as they are deleted automatically when performing the refresh flow.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiFlushInactiveOAuth2TokensRequest

func (*AdminApiService) FlushInactiveOAuth2TokensExecute

func (a *AdminApiService) FlushInactiveOAuth2TokensExecute(r AdminApiApiFlushInactiveOAuth2TokensRequest) (*http.Response, error)

* Execute executes the request

func (*AdminApiService) GetConsentRequest

  • GetConsentRequest Get Consent Request Information
  • When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider

to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.

The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope ("Application my-dropbox-app wants write access to all your private files").

The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiGetConsentRequestRequest

func (*AdminApiService) GetConsentRequestExecute

* Execute executes the request * @return ConsentRequest

func (*AdminApiService) GetJsonWebKey

* GetJsonWebKey Fetch a JSON Web Key * This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid). * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param kid The kid of the desired key * @param set The set * @return AdminApiApiGetJsonWebKeyRequest

func (*AdminApiService) GetJsonWebKeyExecute

* Execute executes the request * @return JSONWebKeySet

func (*AdminApiService) GetJsonWebKeySet

  • GetJsonWebKeySet Retrieve a JSON Web Key Set
  • This endpoint can be used to retrieve JWK Sets stored in ORY Hydra.

A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param set The set
  • @return AdminApiApiGetJsonWebKeySetRequest

func (*AdminApiService) GetJsonWebKeySetExecute

* Execute executes the request * @return JSONWebKeySet

func (*AdminApiService) GetLoginRequest

  • GetLoginRequest Get a Login Request
  • When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider

(sometimes called "identity provider") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate ("show the subject a login screen") a subject (in OAuth2 the proper name for subject is "resource owner").

The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiGetLoginRequestRequest

func (*AdminApiService) GetLoginRequestExecute

* Execute executes the request * @return LoginRequest

func (*AdminApiService) GetLogoutRequest

* GetLogoutRequest Get a Logout Request * Use this endpoint to fetch a logout request. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return AdminApiApiGetLogoutRequestRequest

func (*AdminApiService) GetLogoutRequestExecute

* Execute executes the request * @return LogoutRequest

func (*AdminApiService) GetOAuth2Client

  • GetOAuth2Client Get an OAuth 2.0 Client
  • Get an OAuth 2.0 client by its ID. This endpoint never returns the client secret.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the OAuth 2.0 Client.
  • @return AdminApiApiGetOAuth2ClientRequest

func (*AdminApiService) GetOAuth2ClientExecute

* Execute executes the request * @return OAuth2Client

func (*AdminApiService) GetTrustedJwtGrantIssuer

  • GetTrustedJwtGrantIssuer Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
  • Use this endpoint to get a trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you

created the trust relationship.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the desired grant
  • @return AdminApiApiGetTrustedJwtGrantIssuerRequest

func (*AdminApiService) GetTrustedJwtGrantIssuerExecute

* Execute executes the request * @return TrustedJwtGrantIssuer

func (*AdminApiService) IntrospectOAuth2Token

  • IntrospectOAuth2Token Introspect OAuth2 Tokens
  • The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token

is neither expired nor revoked. If a token is active, additional information on the token will be included. You can set additional data for a token by setting `accessTokenExtra` during the consent flow.

For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiIntrospectOAuth2TokenRequest

func (*AdminApiService) IntrospectOAuth2TokenExecute

* Execute executes the request * @return OAuth2TokenIntrospection

func (*AdminApiService) ListOAuth2Clients

  • ListOAuth2Clients List OAuth 2.0 Clients
  • This endpoint lists all clients in the database, and never returns client secrets.

As a default it lists the first 100 clients. The `limit` parameter can be used to retrieve more clients, but it has an upper bound at 500 objects. Pagination should be used to retrieve more than 500 objects.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

The "Link" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/clients?limit={limit}&offset={offset}>; rel="{page}"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiListOAuth2ClientsRequest

func (*AdminApiService) ListOAuth2ClientsExecute

* Execute executes the request * @return []OAuth2Client

func (*AdminApiService) ListSubjectConsentSessions

  • ListSubjectConsentSessions Lists All Consent Sessions of a Subject
  • This endpoint lists all subject's granted consent sessions, including client and granted scope.

If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an empty JSON array with status code 200 OK.

The "Link" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&limit={limit}&offset={offset}>; rel="{page}"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiListSubjectConsentSessionsRequest

func (*AdminApiService) ListSubjectConsentSessionsExecute

* Execute executes the request * @return []PreviousConsentSession

func (*AdminApiService) ListTrustedJwtGrantIssuers

* ListTrustedJwtGrantIssuers List Trusted OAuth2 JWT Bearer Grant Type Issuers * Use this endpoint to list all trusted JWT Bearer Grant Type Issuers. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return AdminApiApiListTrustedJwtGrantIssuersRequest

func (*AdminApiService) ListTrustedJwtGrantIssuersExecute

* Execute executes the request * @return []TrustedJwtGrantIssuer

func (*AdminApiService) PatchOAuth2Client

  • PatchOAuth2Client Patch an OAuth 2.0 Client
  • Patch an existing OAuth 2.0 Client. If you pass `client_secret`

the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the OAuth 2.0 Client.
  • @return AdminApiApiPatchOAuth2ClientRequest

func (*AdminApiService) PatchOAuth2ClientExecute

* Execute executes the request * @return OAuth2Client

func (*AdminApiService) RejectConsentRequest

  • RejectConsentRequest Reject a Consent Request
  • When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider

to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.

The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope ("Application my-dropbox-app wants write access to all your private files").

The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.

This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider must include a reason why the consent was not granted.

The response contains a redirect URL which the consent provider should redirect the user-agent to.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiRejectConsentRequestRequest

func (*AdminApiService) RejectConsentRequestExecute

* Execute executes the request * @return CompletedRequest

func (*AdminApiService) RejectLoginRequest

  • RejectLoginRequest Reject a Login Request
  • When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider

(sometimes called "identity provider") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate ("show the subject a login screen") a subject (in OAuth2 the proper name for subject is "resource owner").

The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.

This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication was be denied.

The response contains a redirect URL which the login provider should redirect the user-agent to.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiRejectLoginRequestRequest

func (*AdminApiService) RejectLoginRequestExecute

* Execute executes the request * @return CompletedRequest

func (*AdminApiService) RejectLogoutRequest

  • RejectLogoutRequest Reject a Logout Request
  • When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request.

No body is required.

The response is empty as the logout provider has to chose what action to perform next.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiRejectLogoutRequestRequest

func (*AdminApiService) RejectLogoutRequestExecute

func (a *AdminApiService) RejectLogoutRequestExecute(r AdminApiApiRejectLogoutRequestRequest) (*http.Response, error)

* Execute executes the request

func (*AdminApiService) RevokeAuthenticationSession

  • RevokeAuthenticationSession Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
  • This endpoint invalidates a subject's authentication session. After revoking the authentication session, the subject

has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect Front- or Back-channel logout.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiRevokeAuthenticationSessionRequest

func (*AdminApiService) RevokeAuthenticationSessionExecute

func (a *AdminApiService) RevokeAuthenticationSessionExecute(r AdminApiApiRevokeAuthenticationSessionRequest) (*http.Response, error)

* Execute executes the request

func (*AdminApiService) RevokeConsentSessions

  • RevokeConsentSessions Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
  • This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all

associated OAuth 2.0 Access Tokens.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiRevokeConsentSessionsRequest

func (*AdminApiService) RevokeConsentSessionsExecute

func (a *AdminApiService) RevokeConsentSessionsExecute(r AdminApiApiRevokeConsentSessionsRequest) (*http.Response, error)

* Execute executes the request

func (*AdminApiService) TrustJwtGrantIssuer

  • TrustJwtGrantIssuer Trust an OAuth2 JWT Bearer Grant Type Issuer
  • Use this endpoint to establish a trust relationship for a JWT issuer

to perform JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants [RFC7523](https://datatracker.ietf.org/doc/html/rfc7523).

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @return AdminApiApiTrustJwtGrantIssuerRequest

func (*AdminApiService) TrustJwtGrantIssuerExecute

* Execute executes the request * @return TrustedJwtGrantIssuer

func (*AdminApiService) UpdateJsonWebKey

  • UpdateJsonWebKey Update a JSON Web Key
  • Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.

A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens