users

package
v0.0.0-...-dd014ac Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Overview

Code generated by sdkgen from Gophercloud v2.15.0; DO NOT EDIT.

Code generated by sdkgen from Gophercloud v2.15.0; DO NOT EDIT.

Index

Constants

View Source 
const IgnoreChangePasswordUponFirstUse = upstream.IgnoreChangePasswordUponFirstUse
View Source 
const IgnoreLockoutFailureAttempts = upstream.IgnoreLockoutFailureAttempts
View Source 
const IgnorePasswordExpiry = upstream.IgnorePasswordExpiry
View Source 
const MultiFactorAuthEnabled = upstream.MultiFactorAuthEnabled
View Source 
const MultiFactorAuthRules = upstream.MultiFactorAuthRules

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API struct {
	Resources *resource.Collection[User]
	// contains filtered or unexported fields
}

API owns typed operations and their shared resource policies.

func New 

func New(client *gophercloud.ServiceClient) *API

func (*API) AddToGroup 

func (a *API) AddToGroup(ctx context.Context, groupID string, userID string) error

AddToGroup invokes the upstream API with library-owned builders and result handling.

func (*API) All 

func (a *API) All(ctx context.Context, options ...resource.ListOption) ([]*User, error)

func (*API) ChangePassword 

func (a *API) ChangePassword(ctx context.Context, userID string, opts ChangePasswordOpts, options ...ChangePasswordOption) error

ChangePassword invokes the upstream API with library-owned builders and result handling.

func (*API) Create 

func (a *API) Create(ctx context.Context, opts CreateOpts, options ...CreateOption) (*User, error)

Create invokes the upstream API with library-owned builders and result handling.

func (*API) Delete 

func (a *API) Delete(ctx context.Context, userID string) error

Delete invokes the upstream API with library-owned builders and result handling.

func (*API) Find 

func (a *API) Find(ctx context.Context, ref resource.Ref, options ...resource.LookupOption) (*User, error)

func (*API) FindIdentity 

func (a *API) FindIdentity(ctx context.Context, identity string, options ...resource.IdentityFindOption) (*User, error)

FindIdentity tries an ID request before exact ID/name fallback within this collection.

func (*API) Get 

func (a *API) Get(ctx context.Context, id string) (*User, error)

Get invokes the upstream API with library-owned builders and result handling.

func (*API) IsMemberOfGroup 

func (a *API) IsMemberOfGroup(ctx context.Context, groupID string, userID string) (bool, error)

IsMemberOfGroup invokes the upstream API with library-owned builders and result handling.

func (*API) List 

func (a *API) List(ctx context.Context, options ...ListOption) iter.Seq2[*User, error]

List invokes the upstream API with library-owned builders and result handling.

func (*API) ListGroupRecords 

func (a *API) ListGroupRecords(ctx context.Context, userID string) iter.Seq2[*UserGroupRecord, error]

ListGroupRecords lazily lists the groups containing the explicit user ID. It starts without query/control options, as does Python user_groups(user), and consumes advertised continuation links through the owned read policy. Native ListGroups remains available with its original native Group result.

func (*API) ListGroups 

func (a *API) ListGroups(ctx context.Context, userID string) iter.Seq2[*groups.Group, error]

ListGroups invokes the upstream API with library-owned builders and result handling.

func (*API) ListInGroup 

func (a *API) ListInGroup(ctx context.Context, groupID string, options ...ListInGroupOption) iter.Seq2[*User, error]

ListInGroup invokes the upstream API with library-owned builders and result handling.

func (*API) ListProjectRecords 

func (a *API) ListProjectRecords(ctx context.Context, userID string, options ...ListProjectRecordsOption) iter.Seq2[*UserProjectRecord, error]

ListProjectRecords lazily lists projects available to the explicit user ID. It preserves response JSON, applies declared semantic filters and follows advertised continuations or a raw-ID marker when an explicit limit is set. Break stops requests; each iteration applies options once to a fresh snapshot. The native ListProjects method and its native Project results remain available.

func (*API) ListProjects 

func (a *API) ListProjects(ctx context.Context, userID string) iter.Seq2[*projects.Project, error]

ListProjects invokes the upstream API with library-owned builders and result handling.

func (*API) RawClient 

func (a *API) RawClient() *gophercloud.ServiceClient

func (*API) Remove 

func (a *API) Remove(ctx context.Context, ref resource.Ref, options ...resource.LookupOption) error

func (*API) RemoveFromGroup 

func (a *API) RemoveFromGroup(ctx context.Context, groupID string, userID string) error

RemoveFromGroup invokes the upstream API with library-owned builders and result handling.

func (*API) Update 

func (a *API) Update(ctx context.Context, userID string, opts UpdateOpts, options ...UpdateOption) (*User, error)

Update invokes the upstream API with library-owned builders and result handling.

func (*API) WaitFor 

func (a *API) WaitFor(ctx context.Context, ref resource.Ref, status string, options ...resource.WaitOption) (*User, error)

func (*API) WaitForDeletion 

func (a *API) WaitForDeletion(ctx context.Context, ref resource.Ref, options ...resource.WaitOption) error

type AddToGroupResult 

type AddToGroupResult = upstream.AddToGroupResult

type ChangePasswordOption 

type ChangePasswordOption = request.Option[ChangePasswordOpts]

func WithChangePasswordField 

func WithChangePasswordField(key string, value any) ChangePasswordOption

func WithChangePasswordOptions 

func WithChangePasswordOptions(value ChangePasswordOpts) ChangePasswordOption

type ChangePasswordOpts 

type ChangePasswordOpts = upstream.ChangePasswordOpts

type ChangePasswordResult 

type ChangePasswordResult = upstream.ChangePasswordResult

type CreateOption 

type CreateOption = request.Option[CreateOpts]

func WithCreateField 

func WithCreateField(key string, value any) CreateOption

func WithCreateOptions 

func WithCreateOptions(value CreateOpts) CreateOption

type CreateOpts 

type CreateOpts = upstream.CreateOpts

type CreateResult 

type CreateResult = upstream.CreateResult

type DeleteResult 

type DeleteResult = upstream.DeleteResult

type GetResult 

type GetResult = upstream.GetResult

type InvalidListFilter 

type InvalidListFilter = upstream.InvalidListFilter

type IsMemberOfGroupResult 

type IsMemberOfGroupResult = upstream.IsMemberOfGroupResult

type ListInGroupOption 

type ListInGroupOption = request.Option[ListOpts]

func WithListInGroupOptions 

func WithListInGroupOptions(value ListOpts) ListInGroupOption

func WithListInGroupQuery 

func WithListInGroupQuery(key, value string) ListInGroupOption

type ListOption 

type ListOption = request.Option[ListOpts]

func WithListOptions 

func WithListOptions(value ListOpts) ListOption

func WithListQuery 

func WithListQuery(key, value string) ListOption

type ListOpts 

type ListOpts = upstream.ListOpts

type ListProjectRecordsOption 

type ListProjectRecordsOption = request.Option[ListProjectRecordsOpts]

func WithProjectListFilter 

func WithProjectListFilter(field string, value any) ListProjectRecordsOption

WithProjectListFilter adds a declared query attribute or local Body filter. Unknown attributes are discarded. Repeated attributes use the final value.

func WithProjectListFilters 

func WithProjectListFilters(values map[string]any) ListProjectRecordsOption

WithProjectListFilters replaces semantic filters; nil/empty clears them. Canonical attributes take precedence over wire aliases within one bulk map. Semantic query keys cannot overlap typed or raw query keys, even if equal.

func WithProjectListHeader 

func WithProjectListHeader(key, value string) ListProjectRecordsOption

func WithProjectListMaxItems 

func WithProjectListMaxItems(value int) ListProjectRecordsOption

WithProjectListMaxItems caps raw rows before local filtering. Zero is unlimited.

func WithProjectListMicroversion 

func WithProjectListMicroversion(value string) ListProjectRecordsOption

WithProjectListMicroversion selects an operation-local version, including an explicit empty value. It never modifies the original service client.

func WithProjectListOptions 

func WithProjectListOptions(value ListProjectRecordsOpts) ListProjectRecordsOption

WithProjectListOptions replaces typed options while retaining headers, raw queries and semantic filters. Pointer values are owned now and per iteration.

func WithProjectListPaginated 

func WithProjectListPaginated(value bool) ListProjectRecordsOption

WithProjectListPaginated(false) consumes only the first page.

func WithProjectListQuery 

func WithProjectListQuery(key, value string) ListProjectRecordsOption

WithProjectListQuery passes a wire query without attribute classification. It overrides the same typed query; local controls need dedicated options.

type ListProjectRecordsOpts 

type ListProjectRecordsOpts struct {
	Limit        int
	Marker       string
	MaxItems     int
	Paginated    *bool
	Microversion *string
}

ListProjectRecordsOpts supplies query and local paging controls for the projects visible to one user. Nil Paginated uses all advertised pages. Nil Microversion preserves the selected Identity client's policy.

type Option 

type Option = upstream.Option

type RemoveFromGroupResult 

type RemoveFromGroupResult = upstream.RemoveFromGroupResult

type UpdateOption 

type UpdateOption = request.Option[UpdateOpts]

func WithUpdateField 

func WithUpdateField(key string, value any) UpdateOption

func WithUpdateOptions 

func WithUpdateOptions(value UpdateOpts) UpdateOption

type UpdateOpts 

type UpdateOpts = upstream.UpdateOpts

type UpdateResult 

type UpdateResult = upstream.UpdateResult

type User 

type User = upstream.User

type UserGroupRecord 

type UserGroupRecord struct {
	Resource *resource.RawResource
	Wire     *resource.RawResource
}

UserGroupRecord keeps the actual group response and an independent view bound to the requested user. It does not add Group CRUD or resource-routing methods.

func (*UserGroupRecord) UnmarshalJSON 

func (value *UserGroupRecord) UnmarshalJSON(data []byte) error

UnmarshalJSON retains arbitrary group fields without native model coercion.

type UserPage 

type UserPage = upstream.UserPage

type UserProjectRecord 

type UserProjectRecord struct {
	Resource *resource.RawResource
	Wire     *resource.RawResource
}

UserProjectRecord keeps the actual response separate from the Python-style view bound to the requested user. Both resources own their fields and metadata.

func (*UserProjectRecord) UnmarshalJSON 

func (value *UserProjectRecord) UnmarshalJSON(data []byte) error

UnmarshalJSON retains arbitrary project fields without native model coercion. Keep the Wire pointer used by the shared decoder's metadata hook stable.

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.