public

package
v1.10.1 Latest Latest
Warning

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

Go to latest
Published: Mar 25, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for public API

func (*Client) DisconnectUser

func (a *Client) DisconnectUser(params *DisconnectUserParams, opts ...ClientOption) error
DisconnectUser opens ID connect front backchannel enabled logout

This endpoint initiates and completes user logout at ORY Hydra and initiates OpenID Connect Front-/Back-channel logout:

https://openid.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html

func (*Client) DiscoverOpenIDConfiguration

func (a *Client) DiscoverOpenIDConfiguration(params *DiscoverOpenIDConfigurationParams, opts ...ClientOption) (*DiscoverOpenIDConfigurationOK, error)
DiscoverOpenIDConfiguration opens ID connect discovery

The well known endpoint an be used to retrieve information for OpenID Connect clients. We encourage you to not roll

your own OpenID Connect client but to use an OpenID Connect client library instead. You can learn more on this flow at https://openid.net/specs/openid-connect-discovery-1_0.html .

Popular libraries for OpenID Connect clients include oidc-client-js (JavaScript), go-oidc (Golang), and others. For a full list of clients go here: https://openid.net/developers/certified/

func (*Client) IsInstanceReady

func (a *Client) IsInstanceReady(params *IsInstanceReadyParams, opts ...ClientOption) (*IsInstanceReadyOK, error)
IsInstanceReady checks readiness status

This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g.

the database) are responsive as well.

If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.

func (*Client) Oauth2Token

func (a *Client) Oauth2Token(params *Oauth2TokenParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*Oauth2TokenOK, error)
Oauth2Token thes o auth 2 0 token endpoint

The client makes a request to the token endpoint by sending the

following parameters using the "application/x-www-form-urlencoded" HTTP request entity-body.

> Do not implement a client for this endpoint yourself. Use a library. There are many libraries > available for any programming language. You can find a list of libraries here: https://oauth.net/code/ > > Do note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!

func (*Client) OauthAuth

func (a *Client) OauthAuth(params *OauthAuthParams, opts ...ClientOption) error
OauthAuth thes o auth 2 0 authorize endpoint

This endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows.

OAuth2 is a very popular protocol and a library for your programming language will exists.

To learn more about this flow please refer to the specification: https://tools.ietf.org/html/rfc6749

func (*Client) RevokeOAuth2Token

func (a *Client) RevokeOAuth2Token(params *RevokeOAuth2TokenParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RevokeOAuth2TokenOK, error)
RevokeOAuth2Token revokes o auth2 tokens

Revoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no

longer be used to make access requests, and a revoked refresh token can no longer be used to refresh an access token. Revoking a refresh token also invalidates the access token that was created with it. A token may only be revoked by the client the token was generated for.

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

func (*Client) Userinfo

func (a *Client) Userinfo(params *UserinfoParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UserinfoOK, error)
Userinfo opens ID connect userinfo

This endpoint returns the payload of the ID Token, including the idTokenExtra values, of

the provided OAuth 2.0 Access Token.

For more information please [refer to the spec](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo).

func (*Client) WellKnown

func (a *Client) WellKnown(params *WellKnownParams, opts ...ClientOption) (*WellKnownOK, error)
WellKnown JSONs web keys discovery

This endpoint returns JSON Web Keys to be used as public keys for verifying OpenID Connect ID Tokens and,

if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used with client libraries like [node-jwks-rsa](https://github.com/auth0/node-jwks-rsa) among others.

type ClientOption added in v1.10.0

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService added in v1.3.0

type ClientService interface {
	DisconnectUser(params *DisconnectUserParams, opts ...ClientOption) error

	DiscoverOpenIDConfiguration(params *DiscoverOpenIDConfigurationParams, opts ...ClientOption) (*DiscoverOpenIDConfigurationOK, error)

	IsInstanceReady(params *IsInstanceReadyParams, opts ...ClientOption) (*IsInstanceReadyOK, error)

	Oauth2Token(params *Oauth2TokenParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*Oauth2TokenOK, error)

	OauthAuth(params *OauthAuthParams, opts ...ClientOption) error

	RevokeOAuth2Token(params *RevokeOAuth2TokenParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RevokeOAuth2TokenOK, error)

	Userinfo(params *UserinfoParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UserinfoOK, error)

	WellKnown(params *WellKnownParams, opts ...ClientOption) (*WellKnownOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new public API client.

type DisconnectUserFound

type DisconnectUserFound struct {
}
DisconnectUserFound describes a response with status code 302, with default header values.

Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is

typically 201.

func NewDisconnectUserFound

func NewDisconnectUserFound() *DisconnectUserFound

NewDisconnectUserFound creates a DisconnectUserFound with default headers values

func (*DisconnectUserFound) Error

func (o *DisconnectUserFound) Error() string

type DisconnectUserParams

type DisconnectUserParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

DisconnectUserParams contains all the parameters to send to the API endpoint

for the disconnect user operation.

Typically these are written to a http.Request.

func NewDisconnectUserParams

func NewDisconnectUserParams() *DisconnectUserParams

NewDisconnectUserParams creates a new DisconnectUserParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewDisconnectUserParamsWithContext

func NewDisconnectUserParamsWithContext(ctx context.Context) *DisconnectUserParams

NewDisconnectUserParamsWithContext creates a new DisconnectUserParams object with the ability to set a context for a request.

func NewDisconnectUserParamsWithHTTPClient

func NewDisconnectUserParamsWithHTTPClient(client *http.Client) *DisconnectUserParams

NewDisconnectUserParamsWithHTTPClient creates a new DisconnectUserParams object with the ability to set a custom HTTPClient for a request.

func NewDisconnectUserParamsWithTimeout

func NewDisconnectUserParamsWithTimeout(timeout time.Duration) *DisconnectUserParams

NewDisconnectUserParamsWithTimeout creates a new DisconnectUserParams object with the ability to set a timeout on a request.

func (*DisconnectUserParams) SetContext

func (o *DisconnectUserParams) SetContext(ctx context.Context)

SetContext adds the context to the disconnect user params

func (*DisconnectUserParams) SetDefaults added in v1.10.0

func (o *DisconnectUserParams) SetDefaults()

SetDefaults hydrates default values in the disconnect user params (not the query body).

All values with no default are reset to their zero value.

func (*DisconnectUserParams) SetHTTPClient

func (o *DisconnectUserParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the disconnect user params

func (*DisconnectUserParams) SetTimeout

func (o *DisconnectUserParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the disconnect user params

func (*DisconnectUserParams) WithContext

WithContext adds the context to the disconnect user params

func (*DisconnectUserParams) WithDefaults added in v1.10.0

func (o *DisconnectUserParams) WithDefaults() *DisconnectUserParams

WithDefaults hydrates default values in the disconnect user params (not the query body).

All values with no default are reset to their zero value.

func (*DisconnectUserParams) WithHTTPClient

func (o *DisconnectUserParams) WithHTTPClient(client *http.Client) *DisconnectUserParams

WithHTTPClient adds the HTTPClient to the disconnect user params

func (*DisconnectUserParams) WithTimeout

func (o *DisconnectUserParams) WithTimeout(timeout time.Duration) *DisconnectUserParams

WithTimeout adds the timeout to the disconnect user params

func (*DisconnectUserParams) WriteToRequest

func (o *DisconnectUserParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type DisconnectUserReader

type DisconnectUserReader struct {
	// contains filtered or unexported fields
}

DisconnectUserReader is a Reader for the DisconnectUser structure.

func (*DisconnectUserReader) ReadResponse

func (o *DisconnectUserReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type DiscoverOpenIDConfigurationInternalServerError

type DiscoverOpenIDConfigurationInternalServerError struct {
	Payload *models.GenericError
}
DiscoverOpenIDConfigurationInternalServerError describes a response with status code 500, with default header values.

genericError

func NewDiscoverOpenIDConfigurationInternalServerError

func NewDiscoverOpenIDConfigurationInternalServerError() *DiscoverOpenIDConfigurationInternalServerError

NewDiscoverOpenIDConfigurationInternalServerError creates a DiscoverOpenIDConfigurationInternalServerError with default headers values

func (*DiscoverOpenIDConfigurationInternalServerError) Error

func (*DiscoverOpenIDConfigurationInternalServerError) GetPayload

type DiscoverOpenIDConfigurationOK

type DiscoverOpenIDConfigurationOK struct {
	Payload *models.WellKnown
}
DiscoverOpenIDConfigurationOK describes a response with status code 200, with default header values.

wellKnown

func NewDiscoverOpenIDConfigurationOK

func NewDiscoverOpenIDConfigurationOK() *DiscoverOpenIDConfigurationOK

NewDiscoverOpenIDConfigurationOK creates a DiscoverOpenIDConfigurationOK with default headers values

func (*DiscoverOpenIDConfigurationOK) Error

func (*DiscoverOpenIDConfigurationOK) GetPayload

type DiscoverOpenIDConfigurationParams

type DiscoverOpenIDConfigurationParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

DiscoverOpenIDConfigurationParams contains all the parameters to send to the API endpoint

for the discover open ID configuration operation.

Typically these are written to a http.Request.

func NewDiscoverOpenIDConfigurationParams

func NewDiscoverOpenIDConfigurationParams() *DiscoverOpenIDConfigurationParams

NewDiscoverOpenIDConfigurationParams creates a new DiscoverOpenIDConfigurationParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewDiscoverOpenIDConfigurationParamsWithContext

func NewDiscoverOpenIDConfigurationParamsWithContext(ctx context.Context) *DiscoverOpenIDConfigurationParams

NewDiscoverOpenIDConfigurationParamsWithContext creates a new DiscoverOpenIDConfigurationParams object with the ability to set a context for a request.

func NewDiscoverOpenIDConfigurationParamsWithHTTPClient

func NewDiscoverOpenIDConfigurationParamsWithHTTPClient(client *http.Client) *DiscoverOpenIDConfigurationParams

NewDiscoverOpenIDConfigurationParamsWithHTTPClient creates a new DiscoverOpenIDConfigurationParams object with the ability to set a custom HTTPClient for a request.

func NewDiscoverOpenIDConfigurationParamsWithTimeout

func NewDiscoverOpenIDConfigurationParamsWithTimeout(timeout time.Duration) *DiscoverOpenIDConfigurationParams

NewDiscoverOpenIDConfigurationParamsWithTimeout creates a new DiscoverOpenIDConfigurationParams object with the ability to set a timeout on a request.

func (*DiscoverOpenIDConfigurationParams) SetContext

SetContext adds the context to the discover open ID configuration params

func (*DiscoverOpenIDConfigurationParams) SetDefaults added in v1.10.0

func (o *DiscoverOpenIDConfigurationParams) SetDefaults()

SetDefaults hydrates default values in the discover open ID configuration params (not the query body).

All values with no default are reset to their zero value.

func (*DiscoverOpenIDConfigurationParams) SetHTTPClient

func (o *DiscoverOpenIDConfigurationParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the discover open ID configuration params

func (*DiscoverOpenIDConfigurationParams) SetTimeout

func (o *DiscoverOpenIDConfigurationParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the discover open ID configuration params

func (*DiscoverOpenIDConfigurationParams) WithContext

WithContext adds the context to the discover open ID configuration params

func (*DiscoverOpenIDConfigurationParams) WithDefaults added in v1.10.0

WithDefaults hydrates default values in the discover open ID configuration params (not the query body).

All values with no default are reset to their zero value.

func (*DiscoverOpenIDConfigurationParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the discover open ID configuration params

func (*DiscoverOpenIDConfigurationParams) WithTimeout

WithTimeout adds the timeout to the discover open ID configuration params

func (*DiscoverOpenIDConfigurationParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type DiscoverOpenIDConfigurationReader

type DiscoverOpenIDConfigurationReader struct {
	// contains filtered or unexported fields
}

DiscoverOpenIDConfigurationReader is a Reader for the DiscoverOpenIDConfiguration structure.

func (*DiscoverOpenIDConfigurationReader) ReadResponse

func (o *DiscoverOpenIDConfigurationReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type DiscoverOpenIDConfigurationUnauthorized

type DiscoverOpenIDConfigurationUnauthorized struct {
	Payload *models.GenericError
}
DiscoverOpenIDConfigurationUnauthorized describes a response with status code 401, with default header values.

genericError

func NewDiscoverOpenIDConfigurationUnauthorized

func NewDiscoverOpenIDConfigurationUnauthorized() *DiscoverOpenIDConfigurationUnauthorized

NewDiscoverOpenIDConfigurationUnauthorized creates a DiscoverOpenIDConfigurationUnauthorized with default headers values

func (*DiscoverOpenIDConfigurationUnauthorized) Error

func (*DiscoverOpenIDConfigurationUnauthorized) GetPayload

type IsInstanceReadyOK

type IsInstanceReadyOK struct {
	Payload *models.HealthStatus
}
IsInstanceReadyOK describes a response with status code 200, with default header values.

healthStatus

func NewIsInstanceReadyOK

func NewIsInstanceReadyOK() *IsInstanceReadyOK

NewIsInstanceReadyOK creates a IsInstanceReadyOK with default headers values

func (*IsInstanceReadyOK) Error

func (o *IsInstanceReadyOK) Error() string

func (*IsInstanceReadyOK) GetPayload

func (o *IsInstanceReadyOK) GetPayload() *models.HealthStatus

type IsInstanceReadyParams

type IsInstanceReadyParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

IsInstanceReadyParams contains all the parameters to send to the API endpoint

for the is instance ready operation.

Typically these are written to a http.Request.

func NewIsInstanceReadyParams

func NewIsInstanceReadyParams() *IsInstanceReadyParams

NewIsInstanceReadyParams creates a new IsInstanceReadyParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewIsInstanceReadyParamsWithContext

func NewIsInstanceReadyParamsWithContext(ctx context.Context) *IsInstanceReadyParams

NewIsInstanceReadyParamsWithContext creates a new IsInstanceReadyParams object with the ability to set a context for a request.

func NewIsInstanceReadyParamsWithHTTPClient

func NewIsInstanceReadyParamsWithHTTPClient(client *http.Client) *IsInstanceReadyParams

NewIsInstanceReadyParamsWithHTTPClient creates a new IsInstanceReadyParams object with the ability to set a custom HTTPClient for a request.

func NewIsInstanceReadyParamsWithTimeout

func NewIsInstanceReadyParamsWithTimeout(timeout time.Duration) *IsInstanceReadyParams

NewIsInstanceReadyParamsWithTimeout creates a new IsInstanceReadyParams object with the ability to set a timeout on a request.

func (*IsInstanceReadyParams) SetContext

func (o *IsInstanceReadyParams) SetContext(ctx context.Context)

SetContext adds the context to the is instance ready params

func (*IsInstanceReadyParams) SetDefaults added in v1.10.0

func (o *IsInstanceReadyParams) SetDefaults()

SetDefaults hydrates default values in the is instance ready params (not the query body).

All values with no default are reset to their zero value.

func (*IsInstanceReadyParams) SetHTTPClient

func (o *IsInstanceReadyParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the is instance ready params

func (*IsInstanceReadyParams) SetTimeout

func (o *IsInstanceReadyParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the is instance ready params

func (*IsInstanceReadyParams) WithContext

WithContext adds the context to the is instance ready params

func (*IsInstanceReadyParams) WithDefaults added in v1.10.0

func (o *IsInstanceReadyParams) WithDefaults() *IsInstanceReadyParams

WithDefaults hydrates default values in the is instance ready params (not the query body).

All values with no default are reset to their zero value.

func (*IsInstanceReadyParams) WithHTTPClient

func (o *IsInstanceReadyParams) WithHTTPClient(client *http.Client) *IsInstanceReadyParams

WithHTTPClient adds the HTTPClient to the is instance ready params

func (*IsInstanceReadyParams) WithTimeout

func (o *IsInstanceReadyParams) WithTimeout(timeout time.Duration) *IsInstanceReadyParams

WithTimeout adds the timeout to the is instance ready params

func (*IsInstanceReadyParams) WriteToRequest

func (o *IsInstanceReadyParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type IsInstanceReadyReader

type IsInstanceReadyReader struct {
	// contains filtered or unexported fields
}

IsInstanceReadyReader is a Reader for the IsInstanceReady structure.

func (*IsInstanceReadyReader) ReadResponse

func (o *IsInstanceReadyReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type IsInstanceReadyServiceUnavailable

type IsInstanceReadyServiceUnavailable struct {
	Payload *models.HealthNotReadyStatus
}
IsInstanceReadyServiceUnavailable describes a response with status code 503, with default header values.

healthNotReadyStatus

func NewIsInstanceReadyServiceUnavailable

func NewIsInstanceReadyServiceUnavailable() *IsInstanceReadyServiceUnavailable

NewIsInstanceReadyServiceUnavailable creates a IsInstanceReadyServiceUnavailable with default headers values

func (*IsInstanceReadyServiceUnavailable) Error

func (*IsInstanceReadyServiceUnavailable) GetPayload

type Oauth2TokenBadRequest added in v1.9.0

type Oauth2TokenBadRequest struct {
	Payload *models.GenericError
}
Oauth2TokenBadRequest describes a response with status code 400, with default header values.

genericError

func NewOauth2TokenBadRequest added in v1.9.0

func NewOauth2TokenBadRequest() *Oauth2TokenBadRequest

NewOauth2TokenBadRequest creates a Oauth2TokenBadRequest with default headers values

func (*Oauth2TokenBadRequest) Error added in v1.9.0

func (o *Oauth2TokenBadRequest) Error() string

func (*Oauth2TokenBadRequest) GetPayload added in v1.9.0

func (o *Oauth2TokenBadRequest) GetPayload() *models.GenericError

type Oauth2TokenInternalServerError

type Oauth2TokenInternalServerError struct {
	Payload *models.GenericError
}
Oauth2TokenInternalServerError describes a response with status code 500, with default header values.

genericError

func NewOauth2TokenInternalServerError

func NewOauth2TokenInternalServerError() *Oauth2TokenInternalServerError

NewOauth2TokenInternalServerError creates a Oauth2TokenInternalServerError with default headers values

func (*Oauth2TokenInternalServerError) Error

func (*Oauth2TokenInternalServerError) GetPayload

type Oauth2TokenOK

type Oauth2TokenOK struct {
	Payload *models.Oauth2TokenResponse
}
Oauth2TokenOK describes a response with status code 200, with default header values.

oauth2TokenResponse

func NewOauth2TokenOK

func NewOauth2TokenOK() *Oauth2TokenOK

NewOauth2TokenOK creates a Oauth2TokenOK with default headers values

func (*Oauth2TokenOK) Error

func (o *Oauth2TokenOK) Error() string

func (*Oauth2TokenOK) GetPayload

func (o *Oauth2TokenOK) GetPayload() *models.Oauth2TokenResponse

type Oauth2TokenParams

type Oauth2TokenParams struct {

	// ClientID.
	ClientID *string

	// Code.
	Code *string

	// GrantType.
	GrantType string

	// RedirectURI.
	RedirectURI *string

	// RefreshToken.
	RefreshToken *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

Oauth2TokenParams contains all the parameters to send to the API endpoint

for the oauth2 token operation.

Typically these are written to a http.Request.

func NewOauth2TokenParams

func NewOauth2TokenParams() *Oauth2TokenParams

NewOauth2TokenParams creates a new Oauth2TokenParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewOauth2TokenParamsWithContext

func NewOauth2TokenParamsWithContext(ctx context.Context) *Oauth2TokenParams

NewOauth2TokenParamsWithContext creates a new Oauth2TokenParams object with the ability to set a context for a request.

func NewOauth2TokenParamsWithHTTPClient

func NewOauth2TokenParamsWithHTTPClient(client *http.Client) *Oauth2TokenParams

NewOauth2TokenParamsWithHTTPClient creates a new Oauth2TokenParams object with the ability to set a custom HTTPClient for a request.

func NewOauth2TokenParamsWithTimeout

func NewOauth2TokenParamsWithTimeout(timeout time.Duration) *Oauth2TokenParams

NewOauth2TokenParamsWithTimeout creates a new Oauth2TokenParams object with the ability to set a timeout on a request.

func (*Oauth2TokenParams) SetClientID

func (o *Oauth2TokenParams) SetClientID(clientID *string)

SetClientID adds the clientId to the oauth2 token params

func (*Oauth2TokenParams) SetCode

func (o *Oauth2TokenParams) SetCode(code *string)

SetCode adds the code to the oauth2 token params

func (*Oauth2TokenParams) SetContext

func (o *Oauth2TokenParams) SetContext(ctx context.Context)

SetContext adds the context to the oauth2 token params

func (*Oauth2TokenParams) SetDefaults added in v1.10.0

func (o *Oauth2TokenParams) SetDefaults()

SetDefaults hydrates default values in the oauth2 token params (not the query body).

All values with no default are reset to their zero value.

func (*Oauth2TokenParams) SetGrantType

func (o *Oauth2TokenParams) SetGrantType(grantType string)

SetGrantType adds the grantType to the oauth2 token params

func (*Oauth2TokenParams) SetHTTPClient

func (o *Oauth2TokenParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the oauth2 token params

func (*Oauth2TokenParams) SetRedirectURI

func (o *Oauth2TokenParams) SetRedirectURI(redirectURI *string)

SetRedirectURI adds the redirectUri to the oauth2 token params

func (*Oauth2TokenParams) SetRefreshToken

func (o *Oauth2TokenParams) SetRefreshToken(refreshToken *string)

SetRefreshToken adds the refreshToken to the oauth2 token params

func (*Oauth2TokenParams) SetTimeout

func (o *Oauth2TokenParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the oauth2 token params

func (*Oauth2TokenParams) WithClientID

func (o *Oauth2TokenParams) WithClientID(clientID *string) *Oauth2TokenParams

WithClientID adds the clientID to the oauth2 token params

func (*Oauth2TokenParams) WithCode

func (o *Oauth2TokenParams) WithCode(code *string) *Oauth2TokenParams

WithCode adds the code to the oauth2 token params

func (*Oauth2TokenParams) WithContext

func (o *Oauth2TokenParams) WithContext(ctx context.Context) *Oauth2TokenParams

WithContext adds the context to the oauth2 token params

func (*Oauth2TokenParams) WithDefaults added in v1.10.0

func (o *Oauth2TokenParams) WithDefaults() *Oauth2TokenParams

WithDefaults hydrates default values in the oauth2 token params (not the query body).

All values with no default are reset to their zero value.

func (*Oauth2TokenParams) WithGrantType

func (o *Oauth2TokenParams) WithGrantType(grantType string) *Oauth2TokenParams

WithGrantType adds the grantType to the oauth2 token params

func (*Oauth2TokenParams) WithHTTPClient

func (o *Oauth2TokenParams) WithHTTPClient(client *http.Client) *Oauth2TokenParams

WithHTTPClient adds the HTTPClient to the oauth2 token params

func (*Oauth2TokenParams) WithRedirectURI

func (o *Oauth2TokenParams) WithRedirectURI(redirectURI *string) *Oauth2TokenParams

WithRedirectURI adds the redirectURI to the oauth2 token params

func (*Oauth2TokenParams) WithRefreshToken

func (o *Oauth2TokenParams) WithRefreshToken(refreshToken *string) *Oauth2TokenParams

WithRefreshToken adds the refreshToken to the oauth2 token params

func (*Oauth2TokenParams) WithTimeout

func (o *Oauth2TokenParams) WithTimeout(timeout time.Duration) *Oauth2TokenParams

WithTimeout adds the timeout to the oauth2 token params

func (*Oauth2TokenParams) WriteToRequest

func (o *Oauth2TokenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type Oauth2TokenReader

type Oauth2TokenReader struct {
	// contains filtered or unexported fields
}

Oauth2TokenReader is a Reader for the Oauth2Token structure.

func (*Oauth2TokenReader) ReadResponse

func (o *Oauth2TokenReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type Oauth2TokenUnauthorized

type Oauth2TokenUnauthorized struct {
	Payload *models.GenericError
}
Oauth2TokenUnauthorized describes a response with status code 401, with default header values.

genericError

func NewOauth2TokenUnauthorized

func NewOauth2TokenUnauthorized() *Oauth2TokenUnauthorized

NewOauth2TokenUnauthorized creates a Oauth2TokenUnauthorized with default headers values

func (*Oauth2TokenUnauthorized) Error

func (o *Oauth2TokenUnauthorized) Error() string

func (*Oauth2TokenUnauthorized) GetPayload

func (o *Oauth2TokenUnauthorized) GetPayload() *models.GenericError

type OauthAuthFound

type OauthAuthFound struct {
}
OauthAuthFound describes a response with status code 302, with default header values.

Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is

typically 201.

func NewOauthAuthFound

func NewOauthAuthFound() *OauthAuthFound

NewOauthAuthFound creates a OauthAuthFound with default headers values

func (*OauthAuthFound) Error

func (o *OauthAuthFound) Error() string

type OauthAuthInternalServerError

type OauthAuthInternalServerError struct {
	Payload *models.GenericError
}
OauthAuthInternalServerError describes a response with status code 500, with default header values.

genericError

func NewOauthAuthInternalServerError

func NewOauthAuthInternalServerError() *OauthAuthInternalServerError

NewOauthAuthInternalServerError creates a OauthAuthInternalServerError with default headers values

func (*OauthAuthInternalServerError) Error

func (*OauthAuthInternalServerError) GetPayload

type OauthAuthParams

type OauthAuthParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

OauthAuthParams contains all the parameters to send to the API endpoint

for the oauth auth operation.

Typically these are written to a http.Request.

func NewOauthAuthParams

func NewOauthAuthParams() *OauthAuthParams

NewOauthAuthParams creates a new OauthAuthParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewOauthAuthParamsWithContext

func NewOauthAuthParamsWithContext(ctx context.Context) *OauthAuthParams

NewOauthAuthParamsWithContext creates a new OauthAuthParams object with the ability to set a context for a request.

func NewOauthAuthParamsWithHTTPClient

func NewOauthAuthParamsWithHTTPClient(client *http.Client) *OauthAuthParams

NewOauthAuthParamsWithHTTPClient creates a new OauthAuthParams object with the ability to set a custom HTTPClient for a request.

func NewOauthAuthParamsWithTimeout

func NewOauthAuthParamsWithTimeout(timeout time.Duration) *OauthAuthParams

NewOauthAuthParamsWithTimeout creates a new OauthAuthParams object with the ability to set a timeout on a request.

func (*OauthAuthParams) SetContext

func (o *OauthAuthParams) SetContext(ctx context.Context)

SetContext adds the context to the oauth auth params

func (*OauthAuthParams) SetDefaults added in v1.10.0

func (o *OauthAuthParams) SetDefaults()

SetDefaults hydrates default values in the oauth auth params (not the query body).

All values with no default are reset to their zero value.

func (*OauthAuthParams) SetHTTPClient

func (o *OauthAuthParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the oauth auth params

func (*OauthAuthParams) SetTimeout

func (o *OauthAuthParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the oauth auth params

func (*OauthAuthParams) WithContext

func (o *OauthAuthParams) WithContext(ctx context.Context) *OauthAuthParams

WithContext adds the context to the oauth auth params

func (*OauthAuthParams) WithDefaults added in v1.10.0

func (o *OauthAuthParams) WithDefaults() *OauthAuthParams

WithDefaults hydrates default values in the oauth auth params (not the query body).

All values with no default are reset to their zero value.

func (*OauthAuthParams) WithHTTPClient

func (o *OauthAuthParams) WithHTTPClient(client *http.Client) *OauthAuthParams

WithHTTPClient adds the HTTPClient to the oauth auth params

func (*OauthAuthParams) WithTimeout

func (o *OauthAuthParams) WithTimeout(timeout time.Duration) *OauthAuthParams

WithTimeout adds the timeout to the oauth auth params

func (*OauthAuthParams) WriteToRequest

func (o *OauthAuthParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type OauthAuthReader

type OauthAuthReader struct {
	// contains filtered or unexported fields
}

OauthAuthReader is a Reader for the OauthAuth structure.

func (*OauthAuthReader) ReadResponse

func (o *OauthAuthReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type OauthAuthUnauthorized

type OauthAuthUnauthorized struct {
	Payload *models.GenericError
}
OauthAuthUnauthorized describes a response with status code 401, with default header values.

genericError

func NewOauthAuthUnauthorized

func NewOauthAuthUnauthorized() *OauthAuthUnauthorized

NewOauthAuthUnauthorized creates a OauthAuthUnauthorized with default headers values

func (*OauthAuthUnauthorized) Error

func (o *OauthAuthUnauthorized) Error() string

func (*OauthAuthUnauthorized) GetPayload

func (o *OauthAuthUnauthorized) GetPayload() *models.GenericError

type RevokeOAuth2TokenInternalServerError

type RevokeOAuth2TokenInternalServerError struct {
	Payload *models.GenericError
}
RevokeOAuth2TokenInternalServerError describes a response with status code 500, with default header values.

genericError

func NewRevokeOAuth2TokenInternalServerError

func NewRevokeOAuth2TokenInternalServerError() *RevokeOAuth2TokenInternalServerError

NewRevokeOAuth2TokenInternalServerError creates a RevokeOAuth2TokenInternalServerError with default headers values

func (*RevokeOAuth2TokenInternalServerError) Error

func (*RevokeOAuth2TokenInternalServerError) GetPayload

type RevokeOAuth2TokenOK

type RevokeOAuth2TokenOK struct {
}
RevokeOAuth2TokenOK describes a response with status code 200, with default header values.

Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is

typically 201.

func NewRevokeOAuth2TokenOK

func NewRevokeOAuth2TokenOK() *RevokeOAuth2TokenOK

NewRevokeOAuth2TokenOK creates a RevokeOAuth2TokenOK with default headers values

func (*RevokeOAuth2TokenOK) Error

func (o *RevokeOAuth2TokenOK) Error() string

type RevokeOAuth2TokenParams

type RevokeOAuth2TokenParams struct {

	// Token.
	Token string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

RevokeOAuth2TokenParams contains all the parameters to send to the API endpoint

for the revoke o auth2 token operation.

Typically these are written to a http.Request.

func NewRevokeOAuth2TokenParams

func NewRevokeOAuth2TokenParams() *RevokeOAuth2TokenParams

NewRevokeOAuth2TokenParams creates a new RevokeOAuth2TokenParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewRevokeOAuth2TokenParamsWithContext

func NewRevokeOAuth2TokenParamsWithContext(ctx context.Context) *RevokeOAuth2TokenParams

NewRevokeOAuth2TokenParamsWithContext creates a new RevokeOAuth2TokenParams object with the ability to set a context for a request.

func NewRevokeOAuth2TokenParamsWithHTTPClient

func NewRevokeOAuth2TokenParamsWithHTTPClient(client *http.Client) *RevokeOAuth2TokenParams

NewRevokeOAuth2TokenParamsWithHTTPClient creates a new RevokeOAuth2TokenParams object with the ability to set a custom HTTPClient for a request.

func NewRevokeOAuth2TokenParamsWithTimeout

func NewRevokeOAuth2TokenParamsWithTimeout(timeout time.Duration) *RevokeOAuth2TokenParams

NewRevokeOAuth2TokenParamsWithTimeout creates a new RevokeOAuth2TokenParams object with the ability to set a timeout on a request.

func (*RevokeOAuth2TokenParams) SetContext

func (o *RevokeOAuth2TokenParams) SetContext(ctx context.Context)

SetContext adds the context to the revoke o auth2 token params

func (*RevokeOAuth2TokenParams) SetDefaults added in v1.10.0

func (o *RevokeOAuth2TokenParams) SetDefaults()

SetDefaults hydrates default values in the revoke o auth2 token params (not the query body).

All values with no default are reset to their zero value.

func (*RevokeOAuth2TokenParams) SetHTTPClient

func (o *RevokeOAuth2TokenParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the revoke o auth2 token params

func (*RevokeOAuth2TokenParams) SetTimeout

func (o *RevokeOAuth2TokenParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the revoke o auth2 token params

func (*RevokeOAuth2TokenParams) SetToken

func (o *RevokeOAuth2TokenParams) SetToken(token string)

SetToken adds the token to the revoke o auth2 token params

func (*RevokeOAuth2TokenParams) WithContext

WithContext adds the context to the revoke o auth2 token params

func (*RevokeOAuth2TokenParams) WithDefaults added in v1.10.0

WithDefaults hydrates default values in the revoke o auth2 token params (not the query body).

All values with no default are reset to their zero value.

func (*RevokeOAuth2TokenParams) WithHTTPClient

func (o *RevokeOAuth2TokenParams) WithHTTPClient(client *http.Client) *RevokeOAuth2TokenParams

WithHTTPClient adds the HTTPClient to the revoke o auth2 token params

func (*RevokeOAuth2TokenParams) WithTimeout

WithTimeout adds the timeout to the revoke o auth2 token params

func (*RevokeOAuth2TokenParams) WithToken

WithToken adds the token to the revoke o auth2 token params

func (*RevokeOAuth2TokenParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type RevokeOAuth2TokenReader

type RevokeOAuth2TokenReader struct {
	// contains filtered or unexported fields
}

RevokeOAuth2TokenReader is a Reader for the RevokeOAuth2Token structure.

func (*RevokeOAuth2TokenReader) ReadResponse

func (o *RevokeOAuth2TokenReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type RevokeOAuth2TokenUnauthorized

type RevokeOAuth2TokenUnauthorized struct {
	Payload *models.GenericError
}
RevokeOAuth2TokenUnauthorized describes a response with status code 401, with default header values.

genericError

func NewRevokeOAuth2TokenUnauthorized

func NewRevokeOAuth2TokenUnauthorized() *RevokeOAuth2TokenUnauthorized

NewRevokeOAuth2TokenUnauthorized creates a RevokeOAuth2TokenUnauthorized with default headers values

func (*RevokeOAuth2TokenUnauthorized) Error

func (*RevokeOAuth2TokenUnauthorized) GetPayload

type UserinfoInternalServerError

type UserinfoInternalServerError struct {
	Payload *models.GenericError
}
UserinfoInternalServerError describes a response with status code 500, with default header values.

genericError

func NewUserinfoInternalServerError

func NewUserinfoInternalServerError() *UserinfoInternalServerError

NewUserinfoInternalServerError creates a UserinfoInternalServerError with default headers values

func (*UserinfoInternalServerError) Error

func (*UserinfoInternalServerError) GetPayload

type UserinfoOK

type UserinfoOK struct {
	Payload *models.UserinfoResponse
}
UserinfoOK describes a response with status code 200, with default header values.

userinfoResponse

func NewUserinfoOK

func NewUserinfoOK() *UserinfoOK

NewUserinfoOK creates a UserinfoOK with default headers values

func (*UserinfoOK) Error

func (o *UserinfoOK) Error() string

func (*UserinfoOK) GetPayload

func (o *UserinfoOK) GetPayload() *models.UserinfoResponse

type UserinfoParams

type UserinfoParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

UserinfoParams contains all the parameters to send to the API endpoint

for the userinfo operation.

Typically these are written to a http.Request.

func NewUserinfoParams

func NewUserinfoParams() *UserinfoParams

NewUserinfoParams creates a new UserinfoParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewUserinfoParamsWithContext

func NewUserinfoParamsWithContext(ctx context.Context) *UserinfoParams

NewUserinfoParamsWithContext creates a new UserinfoParams object with the ability to set a context for a request.

func NewUserinfoParamsWithHTTPClient

func NewUserinfoParamsWithHTTPClient(client *http.Client) *UserinfoParams

NewUserinfoParamsWithHTTPClient creates a new UserinfoParams object with the ability to set a custom HTTPClient for a request.

func NewUserinfoParamsWithTimeout

func NewUserinfoParamsWithTimeout(timeout time.Duration) *UserinfoParams

NewUserinfoParamsWithTimeout creates a new UserinfoParams object with the ability to set a timeout on a request.

func (*UserinfoParams) SetContext

func (o *UserinfoParams) SetContext(ctx context.Context)

SetContext adds the context to the userinfo params

func (*UserinfoParams) SetDefaults added in v1.10.0

func (o *UserinfoParams) SetDefaults()

SetDefaults hydrates default values in the userinfo params (not the query body).

All values with no default are reset to their zero value.

func (*UserinfoParams) SetHTTPClient

func (o *UserinfoParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the userinfo params

func (*UserinfoParams) SetTimeout

func (o *UserinfoParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the userinfo params

func (*UserinfoParams) WithContext

func (o *UserinfoParams) WithContext(ctx context.Context) *UserinfoParams

WithContext adds the context to the userinfo params

func (*UserinfoParams) WithDefaults added in v1.10.0

func (o *UserinfoParams) WithDefaults() *UserinfoParams

WithDefaults hydrates default values in the userinfo params (not the query body).

All values with no default are reset to their zero value.

func (*UserinfoParams) WithHTTPClient

func (o *UserinfoParams) WithHTTPClient(client *http.Client) *UserinfoParams

WithHTTPClient adds the HTTPClient to the userinfo params

func (*UserinfoParams) WithTimeout

func (o *UserinfoParams) WithTimeout(timeout time.Duration) *UserinfoParams

WithTimeout adds the timeout to the userinfo params

func (*UserinfoParams) WriteToRequest

func (o *UserinfoParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type UserinfoReader

type UserinfoReader struct {
	// contains filtered or unexported fields
}

UserinfoReader is a Reader for the Userinfo structure.

func (*UserinfoReader) ReadResponse

func (o *UserinfoReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type UserinfoUnauthorized

type UserinfoUnauthorized struct {
	Payload *models.GenericError
}
UserinfoUnauthorized describes a response with status code 401, with default header values.

genericError

func NewUserinfoUnauthorized

func NewUserinfoUnauthorized() *UserinfoUnauthorized

NewUserinfoUnauthorized creates a UserinfoUnauthorized with default headers values

func (*UserinfoUnauthorized) Error

func (o *UserinfoUnauthorized) Error() string

func (*UserinfoUnauthorized) GetPayload

func (o *UserinfoUnauthorized) GetPayload() *models.GenericError

type WellKnownInternalServerError

type WellKnownInternalServerError struct {
	Payload *models.GenericError
}
WellKnownInternalServerError describes a response with status code 500, with default header values.

genericError

func NewWellKnownInternalServerError

func NewWellKnownInternalServerError() *WellKnownInternalServerError

NewWellKnownInternalServerError creates a WellKnownInternalServerError with default headers values

func (*WellKnownInternalServerError) Error

func (*WellKnownInternalServerError) GetPayload

type WellKnownOK

type WellKnownOK struct {
	Payload *models.JSONWebKeySet
}
WellKnownOK describes a response with status code 200, with default header values.

JSONWebKeySet

func NewWellKnownOK

func NewWellKnownOK() *WellKnownOK

NewWellKnownOK creates a WellKnownOK with default headers values

func (*WellKnownOK) Error

func (o *WellKnownOK) Error() string

func (*WellKnownOK) GetPayload

func (o *WellKnownOK) GetPayload() *models.JSONWebKeySet

type WellKnownParams

type WellKnownParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

WellKnownParams contains all the parameters to send to the API endpoint

for the well known operation.

Typically these are written to a http.Request.

func NewWellKnownParams

func NewWellKnownParams() *WellKnownParams

NewWellKnownParams creates a new WellKnownParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewWellKnownParamsWithContext

func NewWellKnownParamsWithContext(ctx context.Context) *WellKnownParams

NewWellKnownParamsWithContext creates a new WellKnownParams object with the ability to set a context for a request.

func NewWellKnownParamsWithHTTPClient

func NewWellKnownParamsWithHTTPClient(client *http.Client) *WellKnownParams

NewWellKnownParamsWithHTTPClient creates a new WellKnownParams object with the ability to set a custom HTTPClient for a request.

func NewWellKnownParamsWithTimeout

func NewWellKnownParamsWithTimeout(timeout time.Duration) *WellKnownParams

NewWellKnownParamsWithTimeout creates a new WellKnownParams object with the ability to set a timeout on a request.

func (*WellKnownParams) SetContext

func (o *WellKnownParams) SetContext(ctx context.Context)

SetContext adds the context to the well known params

func (*WellKnownParams) SetDefaults added in v1.10.0

func (o *WellKnownParams) SetDefaults()

SetDefaults hydrates default values in the well known params (not the query body).

All values with no default are reset to their zero value.

func (*WellKnownParams) SetHTTPClient

func (o *WellKnownParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the well known params

func (*WellKnownParams) SetTimeout

func (o *WellKnownParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the well known params

func (*WellKnownParams) WithContext

func (o *WellKnownParams) WithContext(ctx context.Context) *WellKnownParams

WithContext adds the context to the well known params

func (*WellKnownParams) WithDefaults added in v1.10.0

func (o *WellKnownParams) WithDefaults() *WellKnownParams

WithDefaults hydrates default values in the well known params (not the query body).

All values with no default are reset to their zero value.

func (*WellKnownParams) WithHTTPClient

func (o *WellKnownParams) WithHTTPClient(client *http.Client) *WellKnownParams

WithHTTPClient adds the HTTPClient to the well known params

func (*WellKnownParams) WithTimeout

func (o *WellKnownParams) WithTimeout(timeout time.Duration) *WellKnownParams

WithTimeout adds the timeout to the well known params

func (*WellKnownParams) WriteToRequest

func (o *WellKnownParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type WellKnownReader

type WellKnownReader struct {
	// contains filtered or unexported fields
}

WellKnownReader is a Reader for the WellKnown structure.

func (*WellKnownReader) ReadResponse

func (o *WellKnownReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL