oauth2

package
v0.2.26 Latest Latest
Warning

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

 Go to latest Published: Aug 19, 2022 License: MIT Imports: 12 Imported by: 1

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 oauth2 API

func (*Client) Oauth2AccessToken 

func (a *Client) Oauth2AccessToken(params *Oauth2AccessTokenParams, opts ...ClientOption) (*Oauth2AccessTokenCreated, error)

Oauth2AccessToken generates an o auth2 access token

func (*Client) Oauth2RevokeToken 

func (a *Client) Oauth2RevokeToken(params *Oauth2RevokeTokenParams, opts ...ClientOption) (*Oauth2RevokeTokenOK, error)

Oauth2RevokeToken revokes a previously issued o auth2 access token before the end of its standard 30 minute lifespan

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

func AuthenticateRevocation added in v0.2.15 

func AuthenticateRevocation(clientId, clientSecret string) ClientOption

AuthenticateRevocation supplies basic authentication to Oauth2RevokeToken method

type ClientService 

type ClientService interface {
	Oauth2AccessToken(params *Oauth2AccessTokenParams, opts ...ClientOption) (*Oauth2AccessTokenCreated, error)

	Oauth2RevokeToken(params *Oauth2RevokeTokenParams, opts ...ClientOption) (*Oauth2RevokeTokenOK, 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 oauth2 API client.

type Oauth2AccessTokenBadRequest 

type Oauth2AccessTokenBadRequest struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.MsaReplyMetaOnly
}

Oauth2AccessTokenBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewOauth2AccessTokenBadRequest 

func NewOauth2AccessTokenBadRequest() *Oauth2AccessTokenBadRequest

NewOauth2AccessTokenBadRequest creates a Oauth2AccessTokenBadRequest with default headers values

func (*Oauth2AccessTokenBadRequest) Error 

func (o *Oauth2AccessTokenBadRequest) Error() string

func (*Oauth2AccessTokenBadRequest) GetPayload 

func (o *Oauth2AccessTokenBadRequest) GetPayload() *models.MsaReplyMetaOnly

type Oauth2AccessTokenCreated 

type Oauth2AccessTokenCreated struct {
	XCSRegion string

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.DomainAccessTokenResponseV1
}

Oauth2AccessTokenCreated describes a response with status code 201, with default header values.

Successfully issued token

func NewOauth2AccessTokenCreated 

func NewOauth2AccessTokenCreated() *Oauth2AccessTokenCreated

NewOauth2AccessTokenCreated creates a Oauth2AccessTokenCreated with default headers values

func (*Oauth2AccessTokenCreated) Error 

func (o *Oauth2AccessTokenCreated) Error() string

func (*Oauth2AccessTokenCreated) GetPayload 

func (o *Oauth2AccessTokenCreated) GetPayload() *models.DomainAccessTokenResponseV1

type Oauth2AccessTokenForbidden 

type Oauth2AccessTokenForbidden struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.MsaReplyMetaOnly
}

Oauth2AccessTokenForbidden describes a response with status code 403, with default header values.

Forbidden

func NewOauth2AccessTokenForbidden 

func NewOauth2AccessTokenForbidden() *Oauth2AccessTokenForbidden

NewOauth2AccessTokenForbidden creates a Oauth2AccessTokenForbidden with default headers values

func (*Oauth2AccessTokenForbidden) Error 

func (o *Oauth2AccessTokenForbidden) Error() string

func (*Oauth2AccessTokenForbidden) GetPayload 

func (o *Oauth2AccessTokenForbidden) GetPayload() *models.MsaReplyMetaOnly

type Oauth2AccessTokenInternalServerError 

type Oauth2AccessTokenInternalServerError struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.MsaReplyMetaOnly
}

Oauth2AccessTokenInternalServerError describes a response with status code 500, with default header values.

Failed to issue token

func NewOauth2AccessTokenInternalServerError 

func NewOauth2AccessTokenInternalServerError() *Oauth2AccessTokenInternalServerError

NewOauth2AccessTokenInternalServerError creates a Oauth2AccessTokenInternalServerError with default headers values

func (*Oauth2AccessTokenInternalServerError) Error 

func (o *Oauth2AccessTokenInternalServerError) Error() string

func (*Oauth2AccessTokenInternalServerError) GetPayload 

func (o *Oauth2AccessTokenInternalServerError) GetPayload() *models.MsaReplyMetaOnly

type Oauth2AccessTokenParams 

type Oauth2AccessTokenParams struct {

	/* ClientID.

	   The API client ID to authenticate your API requests. For information on generating API clients, see [API documentation inside Falcon](https://falcon.crowdstrike.com/support/documentation/1/crowdstrike-api-introduction-for-developers).
	*/
	ClientID string

	/* ClientSecret.

	   The API client secret to authenticate your API requests. For information on generating API clients, see [API documentation inside Falcon](https://falcon.crowdstrike.com/support/documentation/1/crowdstrike-api-introduction-for-developers).
	*/
	ClientSecret string

	/* MemberCid.

	   For MSSP Master CIDs, optionally lock the token to act on behalf of this member CID
	*/
	MemberCid *string

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

Oauth2AccessTokenParams contains all the parameters to send to the API endpoint 

for the oauth2 access token operation.

Typically these are written to a http.Request.

func NewOauth2AccessTokenParams 

func NewOauth2AccessTokenParams() *Oauth2AccessTokenParams

NewOauth2AccessTokenParams creates a new Oauth2AccessTokenParams 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 NewOauth2AccessTokenParamsWithContext 

func NewOauth2AccessTokenParamsWithContext(ctx context.Context) *Oauth2AccessTokenParams

NewOauth2AccessTokenParamsWithContext creates a new Oauth2AccessTokenParams object with the ability to set a context for a request.

func NewOauth2AccessTokenParamsWithHTTPClient 

func NewOauth2AccessTokenParamsWithHTTPClient(client *http.Client) *Oauth2AccessTokenParams

NewOauth2AccessTokenParamsWithHTTPClient creates a new Oauth2AccessTokenParams object with the ability to set a custom HTTPClient for a request.

func NewOauth2AccessTokenParamsWithTimeout 

func NewOauth2AccessTokenParamsWithTimeout(timeout time.Duration) *Oauth2AccessTokenParams

NewOauth2AccessTokenParamsWithTimeout creates a new Oauth2AccessTokenParams object with the ability to set a timeout on a request.

func (*Oauth2AccessTokenParams) SetClientID 

func (o *Oauth2AccessTokenParams) SetClientID(clientID string)

SetClientID adds the clientId to the oauth2 access token params

func (*Oauth2AccessTokenParams) SetClientSecret 

func (o *Oauth2AccessTokenParams) SetClientSecret(clientSecret string)

SetClientSecret adds the clientSecret to the oauth2 access token params

func (*Oauth2AccessTokenParams) SetContext 

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

SetContext adds the context to the oauth2 access token params

func (*Oauth2AccessTokenParams) SetDefaults 

func (o *Oauth2AccessTokenParams) SetDefaults()

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

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

func (*Oauth2AccessTokenParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the oauth2 access token params

func (*Oauth2AccessTokenParams) SetMemberCid 

func (o *Oauth2AccessTokenParams) SetMemberCid(memberCid *string)

SetMemberCid adds the memberCid to the oauth2 access token params

func (*Oauth2AccessTokenParams) SetTimeout 

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

SetTimeout adds the timeout to the oauth2 access token params

func (*Oauth2AccessTokenParams) WithClientID 

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

WithClientID adds the clientID to the oauth2 access token params

func (*Oauth2AccessTokenParams) WithClientSecret 

func (o *Oauth2AccessTokenParams) WithClientSecret(clientSecret string) *Oauth2AccessTokenParams

WithClientSecret adds the clientSecret to the oauth2 access token params

func (*Oauth2AccessTokenParams) WithContext 

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

WithContext adds the context to the oauth2 access token params

func (*Oauth2AccessTokenParams) WithDefaults 

func (o *Oauth2AccessTokenParams) WithDefaults() *Oauth2AccessTokenParams

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

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

func (*Oauth2AccessTokenParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the oauth2 access token params

func (*Oauth2AccessTokenParams) WithMemberCid 

func (o *Oauth2AccessTokenParams) WithMemberCid(memberCid *string) *Oauth2AccessTokenParams

WithMemberCid adds the memberCid to the oauth2 access token params

func (*Oauth2AccessTokenParams) WithTimeout 

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

WithTimeout adds the timeout to the oauth2 access token params

func (*Oauth2AccessTokenParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type Oauth2AccessTokenReader 

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

Oauth2AccessTokenReader is a Reader for the Oauth2AccessToken structure.

func (*Oauth2AccessTokenReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type Oauth2RevokeTokenBadRequest 

type Oauth2RevokeTokenBadRequest struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.MsaReplyMetaOnly
}

Oauth2RevokeTokenBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewOauth2RevokeTokenBadRequest 

func NewOauth2RevokeTokenBadRequest() *Oauth2RevokeTokenBadRequest

NewOauth2RevokeTokenBadRequest creates a Oauth2RevokeTokenBadRequest with default headers values

func (*Oauth2RevokeTokenBadRequest) Error 

func (o *Oauth2RevokeTokenBadRequest) Error() string

func (*Oauth2RevokeTokenBadRequest) GetPayload 

func (o *Oauth2RevokeTokenBadRequest) GetPayload() *models.MsaReplyMetaOnly

type Oauth2RevokeTokenDefault 

type Oauth2RevokeTokenDefault struct {
	Payload *models.MsaReplyMetaOnly
	// contains filtered or unexported fields
}

Oauth2RevokeTokenDefault describes a response with status code -1, with default header values.

Successfully revoked token

func NewOauth2RevokeTokenDefault 

func NewOauth2RevokeTokenDefault(code int) *Oauth2RevokeTokenDefault

NewOauth2RevokeTokenDefault creates a Oauth2RevokeTokenDefault with default headers values

func (*Oauth2RevokeTokenDefault) Code 

func (o *Oauth2RevokeTokenDefault) Code() int

Code gets the status code for the oauth2 revoke token default response

func (*Oauth2RevokeTokenDefault) Error 

func (o *Oauth2RevokeTokenDefault) Error() string

func (*Oauth2RevokeTokenDefault) GetPayload 

func (o *Oauth2RevokeTokenDefault) GetPayload() *models.MsaReplyMetaOnly

type Oauth2RevokeTokenForbidden 

type Oauth2RevokeTokenForbidden struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.MsaReplyMetaOnly
}

Oauth2RevokeTokenForbidden describes a response with status code 403, with default header values.

Forbidden

func NewOauth2RevokeTokenForbidden 

func NewOauth2RevokeTokenForbidden() *Oauth2RevokeTokenForbidden

NewOauth2RevokeTokenForbidden creates a Oauth2RevokeTokenForbidden with default headers values

func (*Oauth2RevokeTokenForbidden) Error 

func (o *Oauth2RevokeTokenForbidden) Error() string

func (*Oauth2RevokeTokenForbidden) GetPayload 

func (o *Oauth2RevokeTokenForbidden) GetPayload() *models.MsaReplyMetaOnly

type Oauth2RevokeTokenInternalServerError 

type Oauth2RevokeTokenInternalServerError struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.MsaReplyMetaOnly
}

Oauth2RevokeTokenInternalServerError describes a response with status code 500, with default header values.

Failed to revoke token

func NewOauth2RevokeTokenInternalServerError 

func NewOauth2RevokeTokenInternalServerError() *Oauth2RevokeTokenInternalServerError

NewOauth2RevokeTokenInternalServerError creates a Oauth2RevokeTokenInternalServerError with default headers values

func (*Oauth2RevokeTokenInternalServerError) Error 

func (o *Oauth2RevokeTokenInternalServerError) Error() string

func (*Oauth2RevokeTokenInternalServerError) GetPayload 

func (o *Oauth2RevokeTokenInternalServerError) GetPayload() *models.MsaReplyMetaOnly

type Oauth2RevokeTokenOK 

type Oauth2RevokeTokenOK struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.MsaReplyMetaOnly
}

Oauth2RevokeTokenOK describes a response with status code 200, with default header values.

Successfully revoked token

func NewOauth2RevokeTokenOK 

func NewOauth2RevokeTokenOK() *Oauth2RevokeTokenOK

NewOauth2RevokeTokenOK creates a Oauth2RevokeTokenOK with default headers values

func (*Oauth2RevokeTokenOK) Error 

func (o *Oauth2RevokeTokenOK) Error() string

func (*Oauth2RevokeTokenOK) GetPayload 

func (o *Oauth2RevokeTokenOK) GetPayload() *models.MsaReplyMetaOnly

type Oauth2RevokeTokenParams 

type Oauth2RevokeTokenParams struct {

	/* Token.

	     The OAuth2 access token you want to revoke.

	Include your API client ID and secret in basic auth format (`Authorization: basic <encoded API client ID and secret>`) in your request header.
	*/
	Token string

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

Oauth2RevokeTokenParams contains all the parameters to send to the API endpoint 

for the oauth2 revoke token operation.

Typically these are written to a http.Request.

func NewOauth2RevokeTokenParams 

func NewOauth2RevokeTokenParams() *Oauth2RevokeTokenParams

NewOauth2RevokeTokenParams creates a new Oauth2RevokeTokenParams 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 NewOauth2RevokeTokenParamsWithContext 

func NewOauth2RevokeTokenParamsWithContext(ctx context.Context) *Oauth2RevokeTokenParams

NewOauth2RevokeTokenParamsWithContext creates a new Oauth2RevokeTokenParams object with the ability to set a context for a request.

func NewOauth2RevokeTokenParamsWithHTTPClient 

func NewOauth2RevokeTokenParamsWithHTTPClient(client *http.Client) *Oauth2RevokeTokenParams

NewOauth2RevokeTokenParamsWithHTTPClient creates a new Oauth2RevokeTokenParams object with the ability to set a custom HTTPClient for a request.

func NewOauth2RevokeTokenParamsWithTimeout 

func NewOauth2RevokeTokenParamsWithTimeout(timeout time.Duration) *Oauth2RevokeTokenParams

NewOauth2RevokeTokenParamsWithTimeout creates a new Oauth2RevokeTokenParams object with the ability to set a timeout on a request.

func (*Oauth2RevokeTokenParams) SetContext 

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

SetContext adds the context to the oauth2 revoke token params

func (*Oauth2RevokeTokenParams) SetDefaults 

func (o *Oauth2RevokeTokenParams) SetDefaults()

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

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

func (*Oauth2RevokeTokenParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the oauth2 revoke token params

func (*Oauth2RevokeTokenParams) SetTimeout 

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

SetTimeout adds the timeout to the oauth2 revoke token params

func (*Oauth2RevokeTokenParams) SetToken 

func (o *Oauth2RevokeTokenParams) SetToken(token string)

SetToken adds the token to the oauth2 revoke token params

func (*Oauth2RevokeTokenParams) WithContext 

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

WithContext adds the context to the oauth2 revoke token params

func (*Oauth2RevokeTokenParams) WithDefaults 

func (o *Oauth2RevokeTokenParams) WithDefaults() *Oauth2RevokeTokenParams

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

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

func (*Oauth2RevokeTokenParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the oauth2 revoke token params

func (*Oauth2RevokeTokenParams) WithTimeout 

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

WithTimeout adds the timeout to the oauth2 revoke token params

func (*Oauth2RevokeTokenParams) WithToken 

func (o *Oauth2RevokeTokenParams) WithToken(token string) *Oauth2RevokeTokenParams

WithToken adds the token to the oauth2 revoke token params

func (*Oauth2RevokeTokenParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type Oauth2RevokeTokenReader 

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

Oauth2RevokeTokenReader is a Reader for the Oauth2RevokeToken structure.

func (*Oauth2RevokeTokenReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type Oauth2RevokeTokenTooManyRequests 

type Oauth2RevokeTokenTooManyRequests struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	/* Too many requests, retry after this time (as milliseconds since epoch)
	 */
	XRateLimitRetryAfter int64

	Payload *models.MsaReplyMetaOnly
}

Oauth2RevokeTokenTooManyRequests describes a response with status code 429, with default header values.

Too Many Requests

func NewOauth2RevokeTokenTooManyRequests 

func NewOauth2RevokeTokenTooManyRequests() *Oauth2RevokeTokenTooManyRequests

NewOauth2RevokeTokenTooManyRequests creates a Oauth2RevokeTokenTooManyRequests with default headers values

func (*Oauth2RevokeTokenTooManyRequests) Error 

func (o *Oauth2RevokeTokenTooManyRequests) Error() string

func (*Oauth2RevokeTokenTooManyRequests) GetPayload 

func (o *Oauth2RevokeTokenTooManyRequests) GetPayload() *models.MsaReplyMetaOnly

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.