Help us shape the future of Go! Take the 2026 Go Developer Survey

groups

package
v1.0.2 Latest Latest
Warning

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

Go to latest
Published: Aug 8, 2025 License: Apache-2.0 Imports: 11 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 groups API

func (*Client) CreateGroup

func (a *Client) CreateGroup(params *CreateGroupParams, authInfo runtime.ClientAuthInfoWriter) (*CreateGroupCreated, error)

CreateGroup creates a new group

Creates a new group.

func (*Client) EditUsersGroupAssignments

func (a *Client) EditUsersGroupAssignments(params *EditUsersGroupAssignmentsParams, authInfo runtime.ClientAuthInfoWriter) (*EditUsersGroupAssignmentsOK, error)

EditUsersGroupAssignments edits a list of users group assignments

Edit a list of Users' Group assignment.

func (*Client) ListGroups

func (a *Client) ListGroups(params *ListGroupsParams, authInfo runtime.ClientAuthInfoWriter) (*ListGroupsOK, error)

ListGroups lists groups

Return a list of groups.

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	CreateGroup(params *CreateGroupParams, authInfo runtime.ClientAuthInfoWriter) (*CreateGroupCreated, error)

	EditUsersGroupAssignments(params *EditUsersGroupAssignmentsParams, authInfo runtime.ClientAuthInfoWriter) (*EditUsersGroupAssignmentsOK, error)

	ListGroups(params *ListGroupsParams, authInfo runtime.ClientAuthInfoWriter) (*ListGroupsOK, 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 groups API client.

type CreateGroupBadRequest

type CreateGroupBadRequest struct {
	Payload *models.BadRequestError
}

CreateGroupBadRequest handles this case with default header values.

BadRequestError

func NewCreateGroupBadRequest

func NewCreateGroupBadRequest() *CreateGroupBadRequest

NewCreateGroupBadRequest creates a CreateGroupBadRequest with default headers values

func (*CreateGroupBadRequest) Error

func (o *CreateGroupBadRequest) Error() string

func (*CreateGroupBadRequest) GetPayload

func (o *CreateGroupBadRequest) GetPayload() *models.BadRequestError

type CreateGroupCreated

type CreateGroupCreated struct {
	Payload *models.Group
}

CreateGroupCreated handles this case with default header values.

New group details.

func NewCreateGroupCreated

func NewCreateGroupCreated() *CreateGroupCreated

NewCreateGroupCreated creates a CreateGroupCreated with default headers values

func (*CreateGroupCreated) Error

func (o *CreateGroupCreated) Error() string

func (*CreateGroupCreated) GetPayload

func (o *CreateGroupCreated) GetPayload() *models.Group

type CreateGroupForbidden

type CreateGroupForbidden struct {
	Payload *models.AuthorizationError
}

CreateGroupForbidden handles this case with default header values.

AuthorizationError

func NewCreateGroupForbidden

func NewCreateGroupForbidden() *CreateGroupForbidden

NewCreateGroupForbidden creates a CreateGroupForbidden with default headers values

func (*CreateGroupForbidden) Error

func (o *CreateGroupForbidden) Error() string

func (*CreateGroupForbidden) GetPayload

type CreateGroupInternalServerError

type CreateGroupInternalServerError struct {
	Payload *models.InternalServerError
}

CreateGroupInternalServerError handles this case with default header values.

InternalServerError

func NewCreateGroupInternalServerError

func NewCreateGroupInternalServerError() *CreateGroupInternalServerError

NewCreateGroupInternalServerError creates a CreateGroupInternalServerError with default headers values

func (*CreateGroupInternalServerError) Error

func (*CreateGroupInternalServerError) GetPayload

type CreateGroupNotFound

type CreateGroupNotFound struct {
	Payload *models.NotFoundError
}

CreateGroupNotFound handles this case with default header values.

NotFoundError

func NewCreateGroupNotFound

func NewCreateGroupNotFound() *CreateGroupNotFound

NewCreateGroupNotFound creates a CreateGroupNotFound with default headers values

func (*CreateGroupNotFound) Error

func (o *CreateGroupNotFound) Error() string

func (*CreateGroupNotFound) GetPayload

func (o *CreateGroupNotFound) GetPayload() *models.NotFoundError

type CreateGroupParams

type CreateGroupParams struct {

	/*Group
	  Configuration options for the new group.

	*/
	Group *models.CreateGroupInput

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

CreateGroupParams contains all the parameters to send to the API endpoint for the create group operation typically these are written to a http.Request

func NewCreateGroupParams

func NewCreateGroupParams() *CreateGroupParams

NewCreateGroupParams creates a new CreateGroupParams object with the default values initialized.

func NewCreateGroupParamsWithContext

func NewCreateGroupParamsWithContext(ctx context.Context) *CreateGroupParams

NewCreateGroupParamsWithContext creates a new CreateGroupParams object with the default values initialized, and the ability to set a context for a request

func NewCreateGroupParamsWithHTTPClient

func NewCreateGroupParamsWithHTTPClient(client *http.Client) *CreateGroupParams

NewCreateGroupParamsWithHTTPClient creates a new CreateGroupParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewCreateGroupParamsWithTimeout

func NewCreateGroupParamsWithTimeout(timeout time.Duration) *CreateGroupParams

NewCreateGroupParamsWithTimeout creates a new CreateGroupParams object with the default values initialized, and the ability to set a timeout on a request

func (*CreateGroupParams) SetContext

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

SetContext adds the context to the create group params

func (*CreateGroupParams) SetGroup

func (o *CreateGroupParams) SetGroup(group *models.CreateGroupInput)

SetGroup adds the group to the create group params

func (*CreateGroupParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the create group params

func (*CreateGroupParams) SetTimeout

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

SetTimeout adds the timeout to the create group params

func (*CreateGroupParams) WithContext

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

WithContext adds the context to the create group params

func (*CreateGroupParams) WithGroup

WithGroup adds the group to the create group params

func (*CreateGroupParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the create group params

func (*CreateGroupParams) WithTimeout

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

WithTimeout adds the timeout to the create group params

func (*CreateGroupParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type CreateGroupReader

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

CreateGroupReader is a Reader for the CreateGroup structure.

func (*CreateGroupReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type CreateGroupUnauthorized

type CreateGroupUnauthorized struct {
	Payload *models.AuthenticationError
}

CreateGroupUnauthorized handles this case with default header values.

AuthenticationError

func NewCreateGroupUnauthorized

func NewCreateGroupUnauthorized() *CreateGroupUnauthorized

NewCreateGroupUnauthorized creates a CreateGroupUnauthorized with default headers values

func (*CreateGroupUnauthorized) Error

func (o *CreateGroupUnauthorized) Error() string

func (*CreateGroupUnauthorized) GetPayload

type EditUsersGroupAssignmentsBadRequest

type EditUsersGroupAssignmentsBadRequest struct {
	Payload *models.BadRequestError
}

EditUsersGroupAssignmentsBadRequest handles this case with default header values.

BadRequestError

func NewEditUsersGroupAssignmentsBadRequest

func NewEditUsersGroupAssignmentsBadRequest() *EditUsersGroupAssignmentsBadRequest

NewEditUsersGroupAssignmentsBadRequest creates a EditUsersGroupAssignmentsBadRequest with default headers values

func (*EditUsersGroupAssignmentsBadRequest) Error

func (*EditUsersGroupAssignmentsBadRequest) GetPayload

type EditUsersGroupAssignmentsForbidden

type EditUsersGroupAssignmentsForbidden struct {
	Payload *models.AuthorizationError
}

EditUsersGroupAssignmentsForbidden handles this case with default header values.

AuthorizationError

func NewEditUsersGroupAssignmentsForbidden

func NewEditUsersGroupAssignmentsForbidden() *EditUsersGroupAssignmentsForbidden

NewEditUsersGroupAssignmentsForbidden creates a EditUsersGroupAssignmentsForbidden with default headers values

func (*EditUsersGroupAssignmentsForbidden) Error

func (*EditUsersGroupAssignmentsForbidden) GetPayload

type EditUsersGroupAssignmentsInternalServerError

type EditUsersGroupAssignmentsInternalServerError struct {
	Payload *models.InternalServerError
}

EditUsersGroupAssignmentsInternalServerError handles this case with default header values.

InternalServerError

func NewEditUsersGroupAssignmentsInternalServerError

func NewEditUsersGroupAssignmentsInternalServerError() *EditUsersGroupAssignmentsInternalServerError

NewEditUsersGroupAssignmentsInternalServerError creates a EditUsersGroupAssignmentsInternalServerError with default headers values

func (*EditUsersGroupAssignmentsInternalServerError) Error

func (*EditUsersGroupAssignmentsInternalServerError) GetPayload

type EditUsersGroupAssignmentsNotFound

type EditUsersGroupAssignmentsNotFound struct {
	Payload *models.NotFoundError
}

EditUsersGroupAssignmentsNotFound handles this case with default header values.

NotFoundError

func NewEditUsersGroupAssignmentsNotFound

func NewEditUsersGroupAssignmentsNotFound() *EditUsersGroupAssignmentsNotFound

NewEditUsersGroupAssignmentsNotFound creates a EditUsersGroupAssignmentsNotFound with default headers values

func (*EditUsersGroupAssignmentsNotFound) Error

func (*EditUsersGroupAssignmentsNotFound) GetPayload

type EditUsersGroupAssignmentsOK

type EditUsersGroupAssignmentsOK struct {
}

EditUsersGroupAssignmentsOK handles this case with default header values.

User Group assignment updated.

func NewEditUsersGroupAssignmentsOK

func NewEditUsersGroupAssignmentsOK() *EditUsersGroupAssignmentsOK

NewEditUsersGroupAssignmentsOK creates a EditUsersGroupAssignmentsOK with default headers values

func (*EditUsersGroupAssignmentsOK) Error

type EditUsersGroupAssignmentsParams

type EditUsersGroupAssignmentsParams struct {

	/*EditGroupAssignments
	  User and Group IDs to be associated.

	*/
	EditGroupAssignments *models.EditUsersGroupAssignmentsInput

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

EditUsersGroupAssignmentsParams contains all the parameters to send to the API endpoint for the edit users group assignments operation typically these are written to a http.Request

func NewEditUsersGroupAssignmentsParams

func NewEditUsersGroupAssignmentsParams() *EditUsersGroupAssignmentsParams

NewEditUsersGroupAssignmentsParams creates a new EditUsersGroupAssignmentsParams object with the default values initialized.

func NewEditUsersGroupAssignmentsParamsWithContext

func NewEditUsersGroupAssignmentsParamsWithContext(ctx context.Context) *EditUsersGroupAssignmentsParams

NewEditUsersGroupAssignmentsParamsWithContext creates a new EditUsersGroupAssignmentsParams object with the default values initialized, and the ability to set a context for a request

func NewEditUsersGroupAssignmentsParamsWithHTTPClient

func NewEditUsersGroupAssignmentsParamsWithHTTPClient(client *http.Client) *EditUsersGroupAssignmentsParams

NewEditUsersGroupAssignmentsParamsWithHTTPClient creates a new EditUsersGroupAssignmentsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewEditUsersGroupAssignmentsParamsWithTimeout

func NewEditUsersGroupAssignmentsParamsWithTimeout(timeout time.Duration) *EditUsersGroupAssignmentsParams

NewEditUsersGroupAssignmentsParamsWithTimeout creates a new EditUsersGroupAssignmentsParams object with the default values initialized, and the ability to set a timeout on a request

func (*EditUsersGroupAssignmentsParams) SetContext

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

SetContext adds the context to the edit users group assignments params

func (*EditUsersGroupAssignmentsParams) SetEditGroupAssignments

func (o *EditUsersGroupAssignmentsParams) SetEditGroupAssignments(editGroupAssignments *models.EditUsersGroupAssignmentsInput)

SetEditGroupAssignments adds the editGroupAssignments to the edit users group assignments params

func (*EditUsersGroupAssignmentsParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the edit users group assignments params

func (*EditUsersGroupAssignmentsParams) SetTimeout

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

SetTimeout adds the timeout to the edit users group assignments params

func (*EditUsersGroupAssignmentsParams) WithContext

WithContext adds the context to the edit users group assignments params

func (*EditUsersGroupAssignmentsParams) WithEditGroupAssignments

WithEditGroupAssignments adds the editGroupAssignments to the edit users group assignments params

func (*EditUsersGroupAssignmentsParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the edit users group assignments params

func (*EditUsersGroupAssignmentsParams) WithTimeout

WithTimeout adds the timeout to the edit users group assignments params

func (*EditUsersGroupAssignmentsParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type EditUsersGroupAssignmentsReader

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

EditUsersGroupAssignmentsReader is a Reader for the EditUsersGroupAssignments structure.

func (*EditUsersGroupAssignmentsReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type EditUsersGroupAssignmentsUnauthorized

type EditUsersGroupAssignmentsUnauthorized struct {
	Payload *models.AuthenticationError
}

EditUsersGroupAssignmentsUnauthorized handles this case with default header values.

AuthenticationError

func NewEditUsersGroupAssignmentsUnauthorized

func NewEditUsersGroupAssignmentsUnauthorized() *EditUsersGroupAssignmentsUnauthorized

NewEditUsersGroupAssignmentsUnauthorized creates a EditUsersGroupAssignmentsUnauthorized with default headers values

func (*EditUsersGroupAssignmentsUnauthorized) Error

func (*EditUsersGroupAssignmentsUnauthorized) GetPayload

type ListGroupsBadRequest

type ListGroupsBadRequest struct {
	Payload *models.BadRequestError
}

ListGroupsBadRequest handles this case with default header values.

BadRequestError

func NewListGroupsBadRequest

func NewListGroupsBadRequest() *ListGroupsBadRequest

NewListGroupsBadRequest creates a ListGroupsBadRequest with default headers values

func (*ListGroupsBadRequest) Error

func (o *ListGroupsBadRequest) Error() string

func (*ListGroupsBadRequest) GetPayload

func (o *ListGroupsBadRequest) GetPayload() *models.BadRequestError

type ListGroupsForbidden

type ListGroupsForbidden struct {
	Payload *models.AuthorizationError
}

ListGroupsForbidden handles this case with default header values.

AuthorizationError

func NewListGroupsForbidden

func NewListGroupsForbidden() *ListGroupsForbidden

NewListGroupsForbidden creates a ListGroupsForbidden with default headers values

func (*ListGroupsForbidden) Error

func (o *ListGroupsForbidden) Error() string

func (*ListGroupsForbidden) GetPayload

type ListGroupsInternalServerError

type ListGroupsInternalServerError struct {
	Payload *models.InternalServerError
}

ListGroupsInternalServerError handles this case with default header values.

InternalServerError

func NewListGroupsInternalServerError

func NewListGroupsInternalServerError() *ListGroupsInternalServerError

NewListGroupsInternalServerError creates a ListGroupsInternalServerError with default headers values

func (*ListGroupsInternalServerError) Error

func (*ListGroupsInternalServerError) GetPayload

type ListGroupsOK

type ListGroupsOK struct {
	Payload *models.Groups
}

ListGroupsOK handles this case with default header values.

List of Groups.

func NewListGroupsOK

func NewListGroupsOK() *ListGroupsOK

NewListGroupsOK creates a ListGroupsOK with default headers values

func (*ListGroupsOK) Error

func (o *ListGroupsOK) Error() string

func (*ListGroupsOK) GetPayload

func (o *ListGroupsOK) GetPayload() *models.Groups

type ListGroupsParams

type ListGroupsParams struct {

	/*MaxItems
	  Maximum number of items to return.

	*/
	MaxItems *int64
	/*Offset
	  Number of items to skip before returning. This parameter is used when the number of items spans multiple pages.

	*/
	Offset *int64
	/*OrderBy
	  Attribute to order groups by

	*/
	OrderBy *string
	/*OrderDirection
	  Order groups in an ascending or descending fashion

	*/
	OrderDirection *string

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

ListGroupsParams contains all the parameters to send to the API endpoint for the list groups operation typically these are written to a http.Request

func NewListGroupsParams

func NewListGroupsParams() *ListGroupsParams

NewListGroupsParams creates a new ListGroupsParams object with the default values initialized.

func NewListGroupsParamsWithContext

func NewListGroupsParamsWithContext(ctx context.Context) *ListGroupsParams

NewListGroupsParamsWithContext creates a new ListGroupsParams object with the default values initialized, and the ability to set a context for a request

func NewListGroupsParamsWithHTTPClient

func NewListGroupsParamsWithHTTPClient(client *http.Client) *ListGroupsParams

NewListGroupsParamsWithHTTPClient creates a new ListGroupsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewListGroupsParamsWithTimeout

func NewListGroupsParamsWithTimeout(timeout time.Duration) *ListGroupsParams

NewListGroupsParamsWithTimeout creates a new ListGroupsParams object with the default values initialized, and the ability to set a timeout on a request

func (*ListGroupsParams) SetContext

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

SetContext adds the context to the list groups params

func (*ListGroupsParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the list groups params

func (*ListGroupsParams) SetMaxItems

func (o *ListGroupsParams) SetMaxItems(maxItems *int64)

SetMaxItems adds the maxItems to the list groups params

func (*ListGroupsParams) SetOffset

func (o *ListGroupsParams) SetOffset(offset *int64)

SetOffset adds the offset to the list groups params

func (*ListGroupsParams) SetOrderBy

func (o *ListGroupsParams) SetOrderBy(orderBy *string)

SetOrderBy adds the orderBy to the list groups params

func (*ListGroupsParams) SetOrderDirection

func (o *ListGroupsParams) SetOrderDirection(orderDirection *string)

SetOrderDirection adds the orderDirection to the list groups params

func (*ListGroupsParams) SetTimeout

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

SetTimeout adds the timeout to the list groups params

func (*ListGroupsParams) WithContext

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

WithContext adds the context to the list groups params

func (*ListGroupsParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the list groups params

func (*ListGroupsParams) WithMaxItems

func (o *ListGroupsParams) WithMaxItems(maxItems *int64) *ListGroupsParams

WithMaxItems adds the maxItems to the list groups params

func (*ListGroupsParams) WithOffset

func (o *ListGroupsParams) WithOffset(offset *int64) *ListGroupsParams

WithOffset adds the offset to the list groups params

func (*ListGroupsParams) WithOrderBy

func (o *ListGroupsParams) WithOrderBy(orderBy *string) *ListGroupsParams

WithOrderBy adds the orderBy to the list groups params

func (*ListGroupsParams) WithOrderDirection

func (o *ListGroupsParams) WithOrderDirection(orderDirection *string) *ListGroupsParams

WithOrderDirection adds the orderDirection to the list groups params

func (*ListGroupsParams) WithTimeout

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

WithTimeout adds the timeout to the list groups params

func (*ListGroupsParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type ListGroupsReader

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

ListGroupsReader is a Reader for the ListGroups structure.

func (*ListGroupsReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type ListGroupsUnauthorized

type ListGroupsUnauthorized struct {
	Payload *models.AuthenticationError
}

ListGroupsUnauthorized handles this case with default header values.

AuthenticationError

func NewListGroupsUnauthorized

func NewListGroupsUnauthorized() *ListGroupsUnauthorized

NewListGroupsUnauthorized creates a ListGroupsUnauthorized with default headers values

func (*ListGroupsUnauthorized) Error

func (o *ListGroupsUnauthorized) Error() string

func (*ListGroupsUnauthorized) GetPayload

Jump to

Keyboard shortcuts

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