Documentation
¶
Index ¶
- type Client
- func (a *Client) LoginSSOClient(params *LoginSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LoginSSOClientOK, error)deprecated
- func (a *Client) LoginSSOClientShort(params *LoginSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LoginSSOClientOK, error)
- func (a *Client) LogoutSSOClient(params *LogoutSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LogoutSSOClientNoContent, *LogoutSSOClientNotFound, ...)deprecated
- func (a *Client) LogoutSSOClientShort(params *LogoutSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LogoutSSOClientNoContent, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- type ClientService
- type LoginSSOClientOK
- type LoginSSOClientParams
- func NewLoginSSOClientParams() *LoginSSOClientParams
- func NewLoginSSOClientParamsWithContext(ctx context.Context) *LoginSSOClientParams
- func NewLoginSSOClientParamsWithHTTPClient(client *http.Client) *LoginSSOClientParams
- func NewLoginSSOClientParamsWithTimeout(timeout time.Duration) *LoginSSOClientParams
- func (o *LoginSSOClientParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
- func (o *LoginSSOClientParams) SetContext(ctx context.Context)
- func (o *LoginSSOClientParams) SetHTTPClient(client *http.Client)
- func (o *LoginSSOClientParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
- func (o *LoginSSOClientParams) SetPayload(payload *string)
- func (o *LoginSSOClientParams) SetPlatformID(platformID string)
- func (o *LoginSSOClientParams) SetTimeout(timeout time.Duration)
- func (o *LoginSSOClientParams) WithContext(ctx context.Context) *LoginSSOClientParams
- func (o *LoginSSOClientParams) WithHTTPClient(client *http.Client) *LoginSSOClientParams
- func (o *LoginSSOClientParams) WithPayload(payload *string) *LoginSSOClientParams
- func (o *LoginSSOClientParams) WithPlatformID(platformID string) *LoginSSOClientParams
- func (o *LoginSSOClientParams) WithTimeout(timeout time.Duration) *LoginSSOClientParams
- func (o *LoginSSOClientParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type LoginSSOClientReader
- type LogoutSSOClientInternalServerError
- type LogoutSSOClientNoContent
- type LogoutSSOClientNotFound
- type LogoutSSOClientParams
- func NewLogoutSSOClientParams() *LogoutSSOClientParams
- func NewLogoutSSOClientParamsWithContext(ctx context.Context) *LogoutSSOClientParams
- func NewLogoutSSOClientParamsWithHTTPClient(client *http.Client) *LogoutSSOClientParams
- func NewLogoutSSOClientParamsWithTimeout(timeout time.Duration) *LogoutSSOClientParams
- func (o *LogoutSSOClientParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
- func (o *LogoutSSOClientParams) SetContext(ctx context.Context)
- func (o *LogoutSSOClientParams) SetHTTPClient(client *http.Client)
- func (o *LogoutSSOClientParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
- func (o *LogoutSSOClientParams) SetPlatformID(platformID string)
- func (o *LogoutSSOClientParams) SetTimeout(timeout time.Duration)
- func (o *LogoutSSOClientParams) WithContext(ctx context.Context) *LogoutSSOClientParams
- func (o *LogoutSSOClientParams) WithHTTPClient(client *http.Client) *LogoutSSOClientParams
- func (o *LogoutSSOClientParams) WithPlatformID(platformID string) *LogoutSSOClientParams
- func (o *LogoutSSOClientParams) WithTimeout(timeout time.Duration) *LogoutSSOClientParams
- func (o *LogoutSSOClientParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type LogoutSSOClientReader
- type LogoutSSOClientUnprocessableEntity
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 sso API
func (*Client) LoginSSOClient
deprecated
func (a *Client) LoginSSOClient(params *LoginSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LoginSSOClientOK, error)
Deprecated: Use LoginSSOClientShort instead.
LoginSSOClient logins to SSO client with provided platform Id
func (*Client) LoginSSOClientShort ¶
func (a *Client) LoginSSOClientShort(params *LoginSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LoginSSOClientOK, error)
LoginSSOClientShort logins to SSO client with provided platform Id
func (*Client) LogoutSSOClient
deprecated
func (a *Client) LogoutSSOClient(params *LogoutSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LogoutSSOClientNoContent, *LogoutSSOClientNotFound, *LogoutSSOClientUnprocessableEntity, *LogoutSSOClientInternalServerError, error)
Deprecated: Use LogoutSSOClientShort instead.
LogoutSSOClient logouts Logout user's session on platform that logged in using SSO.
Supported platforms: - discourse
func (*Client) LogoutSSOClientShort ¶
func (a *Client) LogoutSSOClientShort(params *LogoutSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LogoutSSOClientNoContent, error)
LogoutSSOClientShort logouts Logout user's session on platform that logged in using SSO.
Supported platforms: - discourse
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientService ¶
type ClientService interface { LoginSSOClient(params *LoginSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LoginSSOClientOK, error) LoginSSOClientShort(params *LoginSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LoginSSOClientOK, error) LogoutSSOClient(params *LogoutSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LogoutSSOClientNoContent, *LogoutSSOClientNotFound, *LogoutSSOClientUnprocessableEntity, *LogoutSSOClientInternalServerError, error) LogoutSSOClientShort(params *LogoutSSOClientParams, authInfo runtime.ClientAuthInfoWriter) (*LogoutSSOClientNoContent, 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 sso API client.
type LoginSSOClientOK ¶
type LoginSSOClientOK struct { }
LoginSSOClientOK handles this case with default header values.
OK
func NewLoginSSOClientOK ¶
func NewLoginSSOClientOK() *LoginSSOClientOK
NewLoginSSOClientOK creates a LoginSSOClientOK with default headers values
func (*LoginSSOClientOK) Error ¶
func (o *LoginSSOClientOK) Error() string
type LoginSSOClientParams ¶
type LoginSSOClientParams struct { /*RetryPolicy*/ RetryPolicy *utils.Retry /*Payload Key value payload received from SSO client, if any, and must be escaped */ Payload *string /*PlatformID SSO Client ID */ PlatformID string AuthInfoWriter runtime.ClientAuthInfoWriter Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
LoginSSOClientParams contains all the parameters to send to the API endpoint for the login SSO client operation typically these are written to a http.Request
func NewLoginSSOClientParams ¶
func NewLoginSSOClientParams() *LoginSSOClientParams
NewLoginSSOClientParams creates a new LoginSSOClientParams object with the default values initialized.
func NewLoginSSOClientParamsWithContext ¶
func NewLoginSSOClientParamsWithContext(ctx context.Context) *LoginSSOClientParams
NewLoginSSOClientParamsWithContext creates a new LoginSSOClientParams object with the default values initialized, and the ability to set a context for a request
func NewLoginSSOClientParamsWithHTTPClient ¶
func NewLoginSSOClientParamsWithHTTPClient(client *http.Client) *LoginSSOClientParams
NewLoginSSOClientParamsWithHTTPClient creates a new LoginSSOClientParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewLoginSSOClientParamsWithTimeout ¶
func NewLoginSSOClientParamsWithTimeout(timeout time.Duration) *LoginSSOClientParams
NewLoginSSOClientParamsWithTimeout creates a new LoginSSOClientParams object with the default values initialized, and the ability to set a timeout on a request
func (*LoginSSOClientParams) SetAuthInfoWriter ¶
func (o *LoginSSOClientParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
SetAuthInfoWriter adds the authInfoWriter to the login SSO client params
func (*LoginSSOClientParams) SetContext ¶
func (o *LoginSSOClientParams) SetContext(ctx context.Context)
SetContext adds the context to the login SSO client params
func (*LoginSSOClientParams) SetHTTPClient ¶
func (o *LoginSSOClientParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the login SSO client params
func (*LoginSSOClientParams) SetHTTPClientTransport ¶
func (o *LoginSSOClientParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
SetHTTPClient adds the HTTPClient Transport to the login SSO client params
func (*LoginSSOClientParams) SetPayload ¶
func (o *LoginSSOClientParams) SetPayload(payload *string)
SetPayload adds the payload to the login SSO client params
func (*LoginSSOClientParams) SetPlatformID ¶
func (o *LoginSSOClientParams) SetPlatformID(platformID string)
SetPlatformID adds the platformId to the login SSO client params
func (*LoginSSOClientParams) SetTimeout ¶
func (o *LoginSSOClientParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the login SSO client params
func (*LoginSSOClientParams) WithContext ¶
func (o *LoginSSOClientParams) WithContext(ctx context.Context) *LoginSSOClientParams
WithContext adds the context to the login SSO client params
func (*LoginSSOClientParams) WithHTTPClient ¶
func (o *LoginSSOClientParams) WithHTTPClient(client *http.Client) *LoginSSOClientParams
WithHTTPClient adds the HTTPClient to the login SSO client params
func (*LoginSSOClientParams) WithPayload ¶
func (o *LoginSSOClientParams) WithPayload(payload *string) *LoginSSOClientParams
WithPayload adds the payload to the login SSO client params
func (*LoginSSOClientParams) WithPlatformID ¶
func (o *LoginSSOClientParams) WithPlatformID(platformID string) *LoginSSOClientParams
WithPlatformID adds the platformID to the login SSO client params
func (*LoginSSOClientParams) WithTimeout ¶
func (o *LoginSSOClientParams) WithTimeout(timeout time.Duration) *LoginSSOClientParams
WithTimeout adds the timeout to the login SSO client params
func (*LoginSSOClientParams) WriteToRequest ¶
func (o *LoginSSOClientParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type LoginSSOClientReader ¶
type LoginSSOClientReader struct {
// contains filtered or unexported fields
}
LoginSSOClientReader is a Reader for the LoginSSOClient structure.
func (*LoginSSOClientReader) ReadResponse ¶
func (o *LoginSSOClientReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type LogoutSSOClientInternalServerError ¶
type LogoutSSOClientInternalServerError struct {
Payload *iamclientmodels.RestErrorResponse
}
LogoutSSOClientInternalServerError handles this case with default header values.
<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20000</td><td>internal server error</td></tr></table>
func NewLogoutSSOClientInternalServerError ¶
func NewLogoutSSOClientInternalServerError() *LogoutSSOClientInternalServerError
NewLogoutSSOClientInternalServerError creates a LogoutSSOClientInternalServerError with default headers values
func (*LogoutSSOClientInternalServerError) Error ¶
func (o *LogoutSSOClientInternalServerError) Error() string
func (*LogoutSSOClientInternalServerError) GetPayload ¶
func (o *LogoutSSOClientInternalServerError) GetPayload() *iamclientmodels.RestErrorResponse
func (*LogoutSSOClientInternalServerError) ToJSONString ¶
func (o *LogoutSSOClientInternalServerError) ToJSONString() string
type LogoutSSOClientNoContent ¶
type LogoutSSOClientNoContent struct { }
LogoutSSOClientNoContent handles this case with default header values.
No Content
func NewLogoutSSOClientNoContent ¶
func NewLogoutSSOClientNoContent() *LogoutSSOClientNoContent
NewLogoutSSOClientNoContent creates a LogoutSSOClientNoContent with default headers values
func (*LogoutSSOClientNoContent) Error ¶
func (o *LogoutSSOClientNoContent) Error() string
type LogoutSSOClientNotFound ¶
type LogoutSSOClientNotFound struct {
Payload *iamclientmodels.RestErrorResponse
}
LogoutSSOClientNotFound handles this case with default header values.
Not Found
func NewLogoutSSOClientNotFound ¶
func NewLogoutSSOClientNotFound() *LogoutSSOClientNotFound
NewLogoutSSOClientNotFound creates a LogoutSSOClientNotFound with default headers values
func (*LogoutSSOClientNotFound) Error ¶
func (o *LogoutSSOClientNotFound) Error() string
func (*LogoutSSOClientNotFound) GetPayload ¶
func (o *LogoutSSOClientNotFound) GetPayload() *iamclientmodels.RestErrorResponse
func (*LogoutSSOClientNotFound) ToJSONString ¶
func (o *LogoutSSOClientNotFound) ToJSONString() string
type LogoutSSOClientParams ¶
type LogoutSSOClientParams struct { /*RetryPolicy*/ RetryPolicy *utils.Retry /*PlatformID SSO Client ID */ PlatformID string AuthInfoWriter runtime.ClientAuthInfoWriter Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
LogoutSSOClientParams contains all the parameters to send to the API endpoint for the logout SSO client operation typically these are written to a http.Request
func NewLogoutSSOClientParams ¶
func NewLogoutSSOClientParams() *LogoutSSOClientParams
NewLogoutSSOClientParams creates a new LogoutSSOClientParams object with the default values initialized.
func NewLogoutSSOClientParamsWithContext ¶
func NewLogoutSSOClientParamsWithContext(ctx context.Context) *LogoutSSOClientParams
NewLogoutSSOClientParamsWithContext creates a new LogoutSSOClientParams object with the default values initialized, and the ability to set a context for a request
func NewLogoutSSOClientParamsWithHTTPClient ¶
func NewLogoutSSOClientParamsWithHTTPClient(client *http.Client) *LogoutSSOClientParams
NewLogoutSSOClientParamsWithHTTPClient creates a new LogoutSSOClientParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewLogoutSSOClientParamsWithTimeout ¶
func NewLogoutSSOClientParamsWithTimeout(timeout time.Duration) *LogoutSSOClientParams
NewLogoutSSOClientParamsWithTimeout creates a new LogoutSSOClientParams object with the default values initialized, and the ability to set a timeout on a request
func (*LogoutSSOClientParams) SetAuthInfoWriter ¶
func (o *LogoutSSOClientParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
SetAuthInfoWriter adds the authInfoWriter to the logout SSO client params
func (*LogoutSSOClientParams) SetContext ¶
func (o *LogoutSSOClientParams) SetContext(ctx context.Context)
SetContext adds the context to the logout SSO client params
func (*LogoutSSOClientParams) SetHTTPClient ¶
func (o *LogoutSSOClientParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the logout SSO client params
func (*LogoutSSOClientParams) SetHTTPClientTransport ¶
func (o *LogoutSSOClientParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
SetHTTPClient adds the HTTPClient Transport to the logout SSO client params
func (*LogoutSSOClientParams) SetPlatformID ¶
func (o *LogoutSSOClientParams) SetPlatformID(platformID string)
SetPlatformID adds the platformId to the logout SSO client params
func (*LogoutSSOClientParams) SetTimeout ¶
func (o *LogoutSSOClientParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the logout SSO client params
func (*LogoutSSOClientParams) WithContext ¶
func (o *LogoutSSOClientParams) WithContext(ctx context.Context) *LogoutSSOClientParams
WithContext adds the context to the logout SSO client params
func (*LogoutSSOClientParams) WithHTTPClient ¶
func (o *LogoutSSOClientParams) WithHTTPClient(client *http.Client) *LogoutSSOClientParams
WithHTTPClient adds the HTTPClient to the logout SSO client params
func (*LogoutSSOClientParams) WithPlatformID ¶
func (o *LogoutSSOClientParams) WithPlatformID(platformID string) *LogoutSSOClientParams
WithPlatformID adds the platformID to the logout SSO client params
func (*LogoutSSOClientParams) WithTimeout ¶
func (o *LogoutSSOClientParams) WithTimeout(timeout time.Duration) *LogoutSSOClientParams
WithTimeout adds the timeout to the logout SSO client params
func (*LogoutSSOClientParams) WriteToRequest ¶
func (o *LogoutSSOClientParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type LogoutSSOClientReader ¶
type LogoutSSOClientReader struct {
// contains filtered or unexported fields
}
LogoutSSOClientReader is a Reader for the LogoutSSOClient structure.
func (*LogoutSSOClientReader) ReadResponse ¶
func (o *LogoutSSOClientReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type LogoutSSOClientUnprocessableEntity ¶
type LogoutSSOClientUnprocessableEntity struct {
Payload *iamclientmodels.RestErrorResponse
}
LogoutSSOClientUnprocessableEntity handles this case with default header values.
Unprocessable Entity
func NewLogoutSSOClientUnprocessableEntity ¶
func NewLogoutSSOClientUnprocessableEntity() *LogoutSSOClientUnprocessableEntity
NewLogoutSSOClientUnprocessableEntity creates a LogoutSSOClientUnprocessableEntity with default headers values
func (*LogoutSSOClientUnprocessableEntity) Error ¶
func (o *LogoutSSOClientUnprocessableEntity) Error() string
func (*LogoutSSOClientUnprocessableEntity) GetPayload ¶
func (o *LogoutSSOClientUnprocessableEntity) GetPayload() *iamclientmodels.RestErrorResponse
func (*LogoutSSOClientUnprocessableEntity) ToJSONString ¶
func (o *LogoutSSOClientUnprocessableEntity) ToJSONString() string