Documentation
¶
Index ¶
- type Client
- func (a *Client) PlatformAuthenticateSAMLV3Handler(params *PlatformAuthenticateSAMLV3HandlerParams, ...) (*PlatformAuthenticateSAMLV3HandlerFound, error)
- func (a *Client) PlatformAuthenticateSAMLV3HandlerShort(params *PlatformAuthenticateSAMLV3HandlerParams, ...) (*PlatformAuthenticateSAMLV3HandlerFound, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- type ClientService
- type PlatformAuthenticateSAMLV3HandlerFound
- type PlatformAuthenticateSAMLV3HandlerParams
- func NewPlatformAuthenticateSAMLV3HandlerParams() *PlatformAuthenticateSAMLV3HandlerParams
- func NewPlatformAuthenticateSAMLV3HandlerParamsWithContext(ctx context.Context) *PlatformAuthenticateSAMLV3HandlerParams
- func NewPlatformAuthenticateSAMLV3HandlerParamsWithHTTPClient(client *http.Client) *PlatformAuthenticateSAMLV3HandlerParams
- func NewPlatformAuthenticateSAMLV3HandlerParamsWithTimeout(timeout time.Duration) *PlatformAuthenticateSAMLV3HandlerParams
- func (o *PlatformAuthenticateSAMLV3HandlerParams) SetCode(code *string)
- func (o *PlatformAuthenticateSAMLV3HandlerParams) SetContext(ctx context.Context)
- func (o *PlatformAuthenticateSAMLV3HandlerParams) SetError(error *string)
- func (o *PlatformAuthenticateSAMLV3HandlerParams) SetHTTPClient(client *http.Client)
- func (o *PlatformAuthenticateSAMLV3HandlerParams) SetPlatformID(platformID string)
- func (o *PlatformAuthenticateSAMLV3HandlerParams) SetState(state string)
- func (o *PlatformAuthenticateSAMLV3HandlerParams) SetTimeout(timeout time.Duration)
- func (o *PlatformAuthenticateSAMLV3HandlerParams) WithCode(code *string) *PlatformAuthenticateSAMLV3HandlerParams
- func (o *PlatformAuthenticateSAMLV3HandlerParams) WithContext(ctx context.Context) *PlatformAuthenticateSAMLV3HandlerParams
- func (o *PlatformAuthenticateSAMLV3HandlerParams) WithError(error *string) *PlatformAuthenticateSAMLV3HandlerParams
- func (o *PlatformAuthenticateSAMLV3HandlerParams) WithHTTPClient(client *http.Client) *PlatformAuthenticateSAMLV3HandlerParams
- func (o *PlatformAuthenticateSAMLV3HandlerParams) WithPlatformID(platformID string) *PlatformAuthenticateSAMLV3HandlerParams
- func (o *PlatformAuthenticateSAMLV3HandlerParams) WithState(state string) *PlatformAuthenticateSAMLV3HandlerParams
- func (o *PlatformAuthenticateSAMLV3HandlerParams) WithTimeout(timeout time.Duration) *PlatformAuthenticateSAMLV3HandlerParams
- func (o *PlatformAuthenticateSAMLV3HandlerParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type PlatformAuthenticateSAMLV3HandlerReader
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 s s o s a m l 2 0 API
func (*Client) PlatformAuthenticateSAMLV3Handler ¶
func (a *Client) PlatformAuthenticateSAMLV3Handler(params *PlatformAuthenticateSAMLV3HandlerParams, authInfo runtime.ClientAuthInfoWriter) (*PlatformAuthenticateSAMLV3HandlerFound, error)
PlatformAuthenticateSAMLV3Handler s a m l platform authentication API
This endpoint authenticates user platform for SAML protocol. It validates user to its
respective platforms. Deactivated or login-banned users are unable to login. <br> <h2>Supported platforms:</h2><ul> <li><strong>azure</strong></li>Microsoft login page will redirects to this endpoint after login success as previously defined on authentication request SAML </ul>
func (*Client) PlatformAuthenticateSAMLV3HandlerShort ¶ added in v0.8.0
func (a *Client) PlatformAuthenticateSAMLV3HandlerShort(params *PlatformAuthenticateSAMLV3HandlerParams, authInfo runtime.ClientAuthInfoWriter) (*PlatformAuthenticateSAMLV3HandlerFound, error)
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientService ¶
type ClientService interface { PlatformAuthenticateSAMLV3Handler(params *PlatformAuthenticateSAMLV3HandlerParams, authInfo runtime.ClientAuthInfoWriter) (*PlatformAuthenticateSAMLV3HandlerFound, error) PlatformAuthenticateSAMLV3HandlerShort(params *PlatformAuthenticateSAMLV3HandlerParams, authInfo runtime.ClientAuthInfoWriter) (*PlatformAuthenticateSAMLV3HandlerFound, 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 s s o s a m l 2 0 API client.
type PlatformAuthenticateSAMLV3HandlerFound ¶
type PlatformAuthenticateSAMLV3HandlerFound struct { /*The Location header */ Location string }
PlatformAuthenticateSAMLV3HandlerFound handles this case with default header values.
Found. Redirect to clients redirection URL with either code or error on the query parameter
func NewPlatformAuthenticateSAMLV3HandlerFound ¶
func NewPlatformAuthenticateSAMLV3HandlerFound() *PlatformAuthenticateSAMLV3HandlerFound
NewPlatformAuthenticateSAMLV3HandlerFound creates a PlatformAuthenticateSAMLV3HandlerFound with default headers values
func (*PlatformAuthenticateSAMLV3HandlerFound) Error ¶
func (o *PlatformAuthenticateSAMLV3HandlerFound) Error() string
type PlatformAuthenticateSAMLV3HandlerParams ¶
type PlatformAuthenticateSAMLV3HandlerParams struct { /*Code The authorization code from 3rd party OAuth server */ Code *string /*Error The error message from Identity Provider (IdP) */ Error *string /*PlatformID Platform ID */ PlatformID string /*State State that contains request ID retrieved from authorize endpoint ([GET] iam/v3/oauth/authorize) */ State string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
PlatformAuthenticateSAMLV3HandlerParams contains all the parameters to send to the API endpoint for the platform authenticate s a m l v3 handler operation typically these are written to a http.Request
func NewPlatformAuthenticateSAMLV3HandlerParams ¶
func NewPlatformAuthenticateSAMLV3HandlerParams() *PlatformAuthenticateSAMLV3HandlerParams
NewPlatformAuthenticateSAMLV3HandlerParams creates a new PlatformAuthenticateSAMLV3HandlerParams object with the default values initialized.
func NewPlatformAuthenticateSAMLV3HandlerParamsWithContext ¶
func NewPlatformAuthenticateSAMLV3HandlerParamsWithContext(ctx context.Context) *PlatformAuthenticateSAMLV3HandlerParams
NewPlatformAuthenticateSAMLV3HandlerParamsWithContext creates a new PlatformAuthenticateSAMLV3HandlerParams object with the default values initialized, and the ability to set a context for a request
func NewPlatformAuthenticateSAMLV3HandlerParamsWithHTTPClient ¶
func NewPlatformAuthenticateSAMLV3HandlerParamsWithHTTPClient(client *http.Client) *PlatformAuthenticateSAMLV3HandlerParams
NewPlatformAuthenticateSAMLV3HandlerParamsWithHTTPClient creates a new PlatformAuthenticateSAMLV3HandlerParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewPlatformAuthenticateSAMLV3HandlerParamsWithTimeout ¶
func NewPlatformAuthenticateSAMLV3HandlerParamsWithTimeout(timeout time.Duration) *PlatformAuthenticateSAMLV3HandlerParams
NewPlatformAuthenticateSAMLV3HandlerParamsWithTimeout creates a new PlatformAuthenticateSAMLV3HandlerParams object with the default values initialized, and the ability to set a timeout on a request
func (*PlatformAuthenticateSAMLV3HandlerParams) SetCode ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) SetCode(code *string)
SetCode adds the code to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) SetContext ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) SetContext(ctx context.Context)
SetContext adds the context to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) SetError ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) SetError(error *string)
SetError adds the error to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) SetHTTPClient ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) SetPlatformID ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) SetPlatformID(platformID string)
SetPlatformID adds the platformId to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) SetState ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) SetState(state string)
SetState adds the state to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) SetTimeout ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) WithCode ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) WithCode(code *string) *PlatformAuthenticateSAMLV3HandlerParams
WithCode adds the code to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) WithContext ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) WithContext(ctx context.Context) *PlatformAuthenticateSAMLV3HandlerParams
WithContext adds the context to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) WithError ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) WithError(error *string) *PlatformAuthenticateSAMLV3HandlerParams
WithError adds the error to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) WithHTTPClient ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) WithHTTPClient(client *http.Client) *PlatformAuthenticateSAMLV3HandlerParams
WithHTTPClient adds the HTTPClient to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) WithPlatformID ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) WithPlatformID(platformID string) *PlatformAuthenticateSAMLV3HandlerParams
WithPlatformID adds the platformID to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) WithState ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) WithState(state string) *PlatformAuthenticateSAMLV3HandlerParams
WithState adds the state to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) WithTimeout ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) WithTimeout(timeout time.Duration) *PlatformAuthenticateSAMLV3HandlerParams
WithTimeout adds the timeout to the platform authenticate s a m l v3 handler params
func (*PlatformAuthenticateSAMLV3HandlerParams) WriteToRequest ¶
func (o *PlatformAuthenticateSAMLV3HandlerParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type PlatformAuthenticateSAMLV3HandlerReader ¶
type PlatformAuthenticateSAMLV3HandlerReader struct {
// contains filtered or unexported fields
}
PlatformAuthenticateSAMLV3HandlerReader is a Reader for the PlatformAuthenticateSAMLV3Handler structure.
func (*PlatformAuthenticateSAMLV3HandlerReader) ReadResponse ¶
func (o *PlatformAuthenticateSAMLV3HandlerReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.