# 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:
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
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.
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.
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.
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.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewCompletedRequest instantiates a new CompletedRequest 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.
NewCompletedRequestWithDefaults instantiates a new CompletedRequest 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.
NewConfiguration returns a new Configuration object.
NewConsentRequest instantiates a new ConsentRequest 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.
NewConsentRequestSession instantiates a new ConsentRequestSession 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.
NewConsentRequestSessionWithDefaults instantiates a new ConsentRequestSession 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.
NewConsentRequestWithDefaults instantiates a new ConsentRequest 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.
NewFlushInactiveOAuth2TokensRequest instantiates a new FlushInactiveOAuth2TokensRequest 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.
NewFlushInactiveOAuth2TokensRequestWithDefaults instantiates a new FlushInactiveOAuth2TokensRequest 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.
NewFlushLoginConsentRequest instantiates a new FlushLoginConsentRequest 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.
NewFlushLoginConsentRequestWithDefaults instantiates a new FlushLoginConsentRequest 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.
NewGenericError instantiates a new GenericError 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.
NewGenericErrorWithDefaults instantiates a new GenericError 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.
NewHealthNotReadyStatus instantiates a new HealthNotReadyStatus 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.
NewHealthNotReadyStatusWithDefaults instantiates a new HealthNotReadyStatus 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.
NewHealthStatus instantiates a new HealthStatus 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.
NewHealthStatusWithDefaults instantiates a new HealthStatus 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.
NewInlineResponse200 instantiates a new InlineResponse200 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.
NewInlineResponse2001 instantiates a new InlineResponse2001 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.
NewInlineResponse2001WithDefaults instantiates a new InlineResponse2001 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.
NewInlineResponse200WithDefaults instantiates a new InlineResponse200 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.
NewInlineResponse503 instantiates a new InlineResponse503 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.
NewInlineResponse503WithDefaults instantiates a new InlineResponse503 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.
NewJsonError instantiates a new JsonError 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.
NewJsonErrorWithDefaults instantiates a new JsonError 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.
NewJSONWebKey instantiates a new JSONWebKey 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.
NewJSONWebKeySet instantiates a new JSONWebKeySet 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.
NewJsonWebKeySetGeneratorRequest instantiates a new JsonWebKeySetGeneratorRequest 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.
NewJsonWebKeySetGeneratorRequestWithDefaults instantiates a new JsonWebKeySetGeneratorRequest 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.
NewJSONWebKeySetWithDefaults instantiates a new JSONWebKeySet 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.
NewJSONWebKeyWithDefaults instantiates a new JSONWebKey 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.
NewLoginRequest instantiates a new LoginRequest 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.
NewLoginRequestWithDefaults instantiates a new LoginRequest 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.
NewLogoutRequest instantiates a new LogoutRequest 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.
NewLogoutRequestWithDefaults instantiates a new LogoutRequest 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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewOAuth2Client instantiates a new OAuth2Client 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.
NewOAuth2ClientWithDefaults instantiates a new OAuth2Client 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.
NewOAuth2TokenIntrospection instantiates a new OAuth2TokenIntrospection 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.
NewOAuth2TokenIntrospectionWithDefaults instantiates a new OAuth2TokenIntrospection 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.
NewOauth2TokenResponse instantiates a new Oauth2TokenResponse 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.
NewOauth2TokenResponseWithDefaults instantiates a new Oauth2TokenResponse 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.
NewOauthTokenResponse instantiates a new OauthTokenResponse 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.
NewOauthTokenResponseWithDefaults instantiates a new OauthTokenResponse 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.
NewOpenIDConnectContext instantiates a new OpenIDConnectContext 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.
NewOpenIDConnectContextWithDefaults instantiates a new OpenIDConnectContext 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.
NewPatchDocument instantiates a new PatchDocument 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.
NewPatchDocumentWithDefaults instantiates a new PatchDocument 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.
NewPreviousConsentSession instantiates a new PreviousConsentSession 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.
NewPreviousConsentSessionWithDefaults instantiates a new PreviousConsentSession 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.
NewRefreshTokenHookRequest instantiates a new RefreshTokenHookRequest 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.
NewRefreshTokenHookRequestWithDefaults instantiates a new RefreshTokenHookRequest 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.
NewRefreshTokenHookResponse instantiates a new RefreshTokenHookResponse 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.
NewRefreshTokenHookResponseWithDefaults instantiates a new RefreshTokenHookResponse 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.
NewRejectRequest instantiates a new RejectRequest 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.
NewRejectRequestWithDefaults instantiates a new RejectRequest 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.
NewRequestWasHandledResponse instantiates a new RequestWasHandledResponse 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.
NewRequestWasHandledResponseWithDefaults instantiates a new RequestWasHandledResponse 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.
NewTrustedJsonWebKey instantiates a new TrustedJsonWebKey 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.
NewTrustedJsonWebKeyWithDefaults instantiates a new TrustedJsonWebKey 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.
NewTrustedJwtGrantIssuer instantiates a new TrustedJwtGrantIssuer 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.
NewTrustedJwtGrantIssuerWithDefaults instantiates a new TrustedJwtGrantIssuer 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.
NewTrustJwtGrantIssuerBody instantiates a new TrustJwtGrantIssuerBody 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.
NewTrustJwtGrantIssuerBodyWithDefaults instantiates a new TrustJwtGrantIssuerBody 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.
NewUserinfoResponse instantiates a new UserinfoResponse 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.
NewUserinfoResponseWithDefaults instantiates a new UserinfoResponse 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.
NewVersion instantiates a new Version 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.
NewVersionWithDefaults instantiates a new Version 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.
NewWellKnown instantiates a new WellKnown 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.
NewWellKnownWithDefaults instantiates a new WellKnown 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.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
# Structs
AcceptConsentRequest struct for AcceptConsentRequest.
AcceptLoginRequest struct for AcceptLoginRequest.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIClient manages communication with the Ory Hydra API API vv1.11.8 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CompletedRequest struct for CompletedRequest.
Configuration stores the configuration of the API client.
ConsentRequest struct for ConsentRequest.
ConsentRequestSession struct for ConsentRequestSession.
FlushInactiveOAuth2TokensRequest struct for FlushInactiveOAuth2TokensRequest.
FlushLoginConsentRequest struct for FlushLoginConsentRequest.
GenericError struct for GenericError.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
HealthNotReadyStatus struct for HealthNotReadyStatus.
HealthStatus struct for HealthStatus.
InlineResponse200 struct for InlineResponse200.
InlineResponse2001 struct for InlineResponse2001.
InlineResponse503 struct for InlineResponse503.
JsonError Error responses are sent when an error (e.g.
JSONWebKey It is important that this model object is named JSONWebKey for \"swagger generate spec\" to generate only on definition of a JSONWebKey.
JSONWebKeySet It is important that this model object is named JSONWebKeySet for \"swagger generate spec\" to generate only on definition of a JSONWebKeySet.
JsonWebKeySetGeneratorRequest struct for JsonWebKeySetGeneratorRequest.
LoginRequest struct for LoginRequest.
LogoutRequest struct for LogoutRequest.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OAuth2Client struct for OAuth2Client.
OAuth2TokenIntrospection https://tools.ietf.org/html/rfc7662.
Oauth2TokenResponse The Access Token Response.
OauthTokenResponse The token response.
OpenIDConnectContext struct for OpenIDConnectContext.
PatchDocument A JSONPatch document as defined by RFC 6902.
PreviousConsentSession The response used to return used consent requests same as HandledLoginRequest, just with consent_request exposed as json.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RefreshTokenHookRequest struct for RefreshTokenHookRequest.
RefreshTokenHookResponse struct for RefreshTokenHookResponse.
RejectRequest struct for RejectRequest.
RequestWasHandledResponse struct for RequestWasHandledResponse.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
TrustedJsonWebKey struct for TrustedJsonWebKey.
TrustedJwtGrantIssuer struct for TrustedJwtGrantIssuer.
TrustJwtGrantIssuerBody struct for TrustJwtGrantIssuerBody.
UserinfoResponse The userinfo response.
Version struct for Version.
WellKnown It includes links to several endpoints (e.g.
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
AdminApiService AdminApi service.
MetadataApiService MetadataApi service.
PublicApiService PublicApi service.
ServerConfigurations stores multiple ServerConfiguration items.