authmethods

package
v0.0.51 Latest Latest
Warning

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

 Go to latest Published: May 30, 2024 License: MPL-2.0 Imports: 13 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthMethod 

type AuthMethod struct {
	Id                          string                 `json:"id,omitempty"`
	ScopeId                     string                 `json:"scope_id,omitempty"`
	Scope                       *scopes.ScopeInfo      `json:"scope,omitempty"`
	Name                        string                 `json:"name,omitempty"`
	Description                 string                 `json:"description,omitempty"`
	CreatedTime                 time.Time              `json:"created_time,omitempty"`
	UpdatedTime                 time.Time              `json:"updated_time,omitempty"`
	Version                     uint32                 `json:"version,omitempty"`
	Type                        string                 `json:"type,omitempty"`
	Attributes                  map[string]interface{} `json:"attributes,omitempty"`
	IsPrimary                   bool                   `json:"is_primary,omitempty"`
	AuthorizedActions           []string               `json:"authorized_actions,omitempty"`
	AuthorizedCollectionActions map[string][]string    `json:"authorized_collection_actions,omitempty"`
}

func (*AuthMethod) GetLdapAuthMethodAttributes added in v0.0.35 

func (pt *AuthMethod) GetLdapAuthMethodAttributes() (*LdapAuthMethodAttributes, error)

func (*AuthMethod) GetOidcAuthMethodAttributes added in v0.0.26 

func (pt *AuthMethod) GetOidcAuthMethodAttributes() (*OidcAuthMethodAttributes, error)

func (*AuthMethod) GetPasswordAuthMethodAttributes added in v0.0.26 

func (pt *AuthMethod) GetPasswordAuthMethodAttributes() (*PasswordAuthMethodAttributes, error)

type AuthMethodCreateResult 

type AuthMethodCreateResult = AuthMethodReadResult

type AuthMethodDeleteResult 

type AuthMethodDeleteResult struct {
	Response *api.Response
}

func (AuthMethodDeleteResult) GetItem added in v0.0.10 

func (n AuthMethodDeleteResult) GetItem() interface{}

GetItem will always be nil for AuthMethodDeleteResult

func (AuthMethodDeleteResult) GetResponse added in v0.0.7 

func (n AuthMethodDeleteResult) GetResponse() *api.Response

type AuthMethodListResult 

type AuthMethodListResult struct {
	Items        []*AuthMethod `json:"items,omitempty"`
	EstItemCount uint          `json:"est_item_count,omitempty"`
	RemovedIds   []string      `json:"removed_ids,omitempty"`
	ListToken    string        `json:"list_token,omitempty"`
	ResponseType string        `json:"response_type,omitempty"`
	Response     *api.Response
}

func (AuthMethodListResult) GetEstItemCount added in v0.0.44 

func (n AuthMethodListResult) GetEstItemCount() uint

func (AuthMethodListResult) GetItems 

func (n AuthMethodListResult) GetItems() []*AuthMethod

func (AuthMethodListResult) GetListToken added in v0.0.44 

func (n AuthMethodListResult) GetListToken() string

func (AuthMethodListResult) GetRemovedIds added in v0.0.44 

func (n AuthMethodListResult) GetRemovedIds() []string

func (AuthMethodListResult) GetResponse added in v0.0.7 

func (n AuthMethodListResult) GetResponse() *api.Response

func (AuthMethodListResult) GetResponseType added in v0.0.44 

func (n AuthMethodListResult) GetResponseType() string

type AuthMethodReadResult 

type AuthMethodReadResult struct {
	Item     *AuthMethod
	Response *api.Response
}

func (AuthMethodReadResult) GetItem 

func (n AuthMethodReadResult) GetItem() *AuthMethod

func (AuthMethodReadResult) GetResponse added in v0.0.7 

func (n AuthMethodReadResult) GetResponse() *api.Response

type AuthMethodUpdateResult 

type AuthMethodUpdateResult = AuthMethodReadResult

type AuthenticateResult added in v0.0.9 

type AuthenticateResult struct {
	Command    string         `json:"-"`
	Attributes map[string]any `json:"-"`
	// contains filtered or unexported fields
}

func (AuthenticateResult) GetAuthToken added in v0.0.43 

func (a AuthenticateResult) GetAuthToken() (*authtokens.AuthToken, error)

GetAuthToken converts this AuthenticateResult into an AuthToken struct

func (AuthenticateResult) GetRawAttributes added in v0.0.9 

func (a AuthenticateResult) GetRawAttributes() json.RawMessage

func (AuthenticateResult) GetResponse added in v0.0.9 

func (a AuthenticateResult) GetResponse() *api.Response

func (*AuthenticateResult) MarshalJSON added in v0.0.9 

func (a *AuthenticateResult) MarshalJSON() ([]byte, error)

func (*AuthenticateResult) UnmarshalJSON added in v0.0.9 

func (a *AuthenticateResult) UnmarshalJSON(inBytes []byte) error

type Client 

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

Client is a client for this collection

func NewClient 

func NewClient(c *api.Client) *Client

Creates a new client for this collection. The submitted API client is cloned; modifications to it after generating this client will not have effect. If you need to make changes to the underlying API client, use ApiClient() to access it.

func (*Client) ApiClient 

func (c *Client) ApiClient() *api.Client

ApiClient returns the underlying API client

func (*Client) Authenticate 

func (c *Client) Authenticate(ctx context.Context, authMethodId, command string, attributes map[string]any, opt ...Option) (*AuthenticateResult, error)

Authenticate is a generic authenticate API call that returns a generic result. See the documentation for the attributes required for any given auth method.

Only some auth methods support multiple commands. If the documentation does not specify what command to use when and with which attriubutes, use "login".

func (*Client) ChangeState added in v0.0.9 

func (c *Client) ChangeState(ctx context.Context, authMethodId string, version uint32, state string, opt ...Option) (*AuthMethodUpdateResult, error)

func (*Client) Create 

func (c *Client) Create(ctx context.Context, resourceType string, scopeId string, opt ...Option) (*AuthMethodCreateResult, error)

func (*Client) Delete 

func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*AuthMethodDeleteResult, error)

func (*Client) List 

func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*AuthMethodListResult, error)

func (*Client) Read 

func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*AuthMethodReadResult, error)

func (*Client) Update 

func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*AuthMethodUpdateResult, error)

type LdapAuthMethodAttributes added in v0.0.35 

type LdapAuthMethodAttributes struct {
	State                    string   `json:"state,omitempty"`
	StartTls                 bool     `json:"start_tls,omitempty"`
	InsecureTls              bool     `json:"insecure_tls,omitempty"`
	DiscoverDn               bool     `json:"discover_dn,omitempty"`
	AnonGroupSearch          bool     `json:"anon_group_search,omitempty"`
	UpnDomain                string   `json:"upn_domain,omitempty"`
	Urls                     []string `json:"urls,omitempty"`
	UserDn                   string   `json:"user_dn,omitempty"`
	UserAttr                 string   `json:"user_attr,omitempty"`
	UserFilter               string   `json:"user_filter,omitempty"`
	EnableGroups             bool     `json:"enable_groups,omitempty"`
	GroupDn                  string   `json:"group_dn,omitempty"`
	GroupAttr                string   `json:"group_attr,omitempty"`
	GroupFilter              string   `json:"group_filter,omitempty"`
	Certificates             []string `json:"certificates,omitempty"`
	ClientCertificate        string   `json:"client_certificate,omitempty"`
	ClientCertificateKey     string   `json:"client_certificate_key,omitempty"`
	ClientCertificateKeyHmac string   `json:"client_certificate_key_hmac,omitempty"`
	BindDn                   string   `json:"bind_dn,omitempty"`
	BindPassword             string   `json:"bind_password,omitempty"`
	BindPasswordHmac         string   `json:"bind_password_hmac,omitempty"`
	UseTokenGroups           bool     `json:"use_token_groups,omitempty"`
	AccountAttributeMaps     []string `json:"account_attribute_maps,omitempty"`
	MaximumPageSize          uint32   `json:"maximum_page_size,omitempty"`
	DereferenceAliases       string   `json:"dereference_aliases,omitempty"`
}

func AttributesMapToLdapAuthMethodAttributes added in v0.0.35 

func AttributesMapToLdapAuthMethodAttributes(in map[string]interface{}) (*LdapAuthMethodAttributes, error)

type OidcAuthMethodAttributes added in v0.0.9 

type OidcAuthMethodAttributes struct {
	State                             string   `json:"state,omitempty"`
	Issuer                            string   `json:"issuer,omitempty"`
	ClientId                          string   `json:"client_id,omitempty"`
	ClientSecret                      string   `json:"client_secret,omitempty"`
	ClientSecretHmac                  string   `json:"client_secret_hmac,omitempty"`
	MaxAge                            uint32   `json:"max_age,omitempty"`
	SigningAlgorithms                 []string `json:"signing_algorithms,omitempty"`
	ApiUrlPrefix                      string   `json:"api_url_prefix,omitempty"`
	CallbackUrl                       string   `json:"callback_url,omitempty"`
	IdpCaCerts                        []string `json:"idp_ca_certs,omitempty"`
	AllowedAudiences                  []string `json:"allowed_audiences,omitempty"`
	ClaimsScopes                      []string `json:"claims_scopes,omitempty"`
	AccountClaimMaps                  []string `json:"account_claim_maps,omitempty"`
	DisableDiscoveredConfigValidation bool     `json:"disable_discovered_config_validation,omitempty"`
	DryRun                            bool     `json:"dry_run,omitempty"`
	Prompts                           []string `json:"prompts,omitempty"`
}

func AttributesMapToOidcAuthMethodAttributes added in v0.0.26 

func AttributesMapToOidcAuthMethodAttributes(in map[string]interface{}) (*OidcAuthMethodAttributes, error)

type OidcAuthMethodAuthenticateStartResponse added in v0.0.9 

type OidcAuthMethodAuthenticateStartResponse struct {
	AuthUrl string `json:"auth_url,omitempty"`
	TokenId string `json:"token_id,omitempty"`
}

type Option 

type Option func(*options)

Option is a func that sets optional attributes for a call. This does not need to be used directly, but instead option arguments are built from the functions in this package. WithX options set a value to that given in the argument; DefaultX options indicate that the value should be set to its default. When an API call is made options are processed in the order they appear in the function call, so for a given argument X, a succession of WithX or DefaultX calls will result in the last call taking effect.

func DefaultAttributes 

func DefaultAttributes() Option

func DefaultDescription 

func DefaultDescription() Option

func DefaultLdapAuthMethodAccountAttributeMaps added in v0.0.35 

func DefaultLdapAuthMethodAccountAttributeMaps() Option

func DefaultLdapAuthMethodAnonGroupSearch added in v0.0.35 

func DefaultLdapAuthMethodAnonGroupSearch() Option

func DefaultLdapAuthMethodBindDn added in v0.0.35 

func DefaultLdapAuthMethodBindDn() Option

func DefaultLdapAuthMethodBindPassword added in v0.0.35 

func DefaultLdapAuthMethodBindPassword() Option

func DefaultLdapAuthMethodCertificates added in v0.0.35 

func DefaultLdapAuthMethodCertificates() Option

func DefaultLdapAuthMethodClientCertificate added in v0.0.35 

func DefaultLdapAuthMethodClientCertificate() Option

func DefaultLdapAuthMethodClientCertificateKey added in v0.0.35 

func DefaultLdapAuthMethodClientCertificateKey() Option

func DefaultLdapAuthMethodDereferenceAliases added in v0.0.41 

func DefaultLdapAuthMethodDereferenceAliases() Option

func DefaultLdapAuthMethodDiscoverDn added in v0.0.35 

func DefaultLdapAuthMethodDiscoverDn() Option

func DefaultLdapAuthMethodEnableGroups added in v0.0.35 

func DefaultLdapAuthMethodEnableGroups() Option

func DefaultLdapAuthMethodGroupAttr added in v0.0.35 

func DefaultLdapAuthMethodGroupAttr() Option

func DefaultLdapAuthMethodGroupDn added in v0.0.35 

func DefaultLdapAuthMethodGroupDn() Option

func DefaultLdapAuthMethodGroupFilter added in v0.0.35 

func DefaultLdapAuthMethodGroupFilter() Option

func DefaultLdapAuthMethodInsecureTls added in v0.0.35 

func DefaultLdapAuthMethodInsecureTls() Option

func DefaultLdapAuthMethodMaximumPageSize added in v0.0.41 

func DefaultLdapAuthMethodMaximumPageSize() Option

func DefaultLdapAuthMethodStartTls added in v0.0.35 

func DefaultLdapAuthMethodStartTls() Option

func DefaultLdapAuthMethodState added in v0.0.35 

func DefaultLdapAuthMethodState() Option

func DefaultLdapAuthMethodUpnDomain added in v0.0.35 

func DefaultLdapAuthMethodUpnDomain() Option

func DefaultLdapAuthMethodUrls added in v0.0.35 

func DefaultLdapAuthMethodUrls() Option

func DefaultLdapAuthMethodUseTokenGroups added in v0.0.35 

func DefaultLdapAuthMethodUseTokenGroups() Option

func DefaultLdapAuthMethodUserAttr added in v0.0.35 

func DefaultLdapAuthMethodUserAttr() Option

func DefaultLdapAuthMethodUserDn added in v0.0.35 

func DefaultLdapAuthMethodUserDn() Option

func DefaultLdapAuthMethodUserFilter added in v0.0.35 

func DefaultLdapAuthMethodUserFilter() Option

func DefaultName 

func DefaultName() Option

func DefaultOidcAuthMethodAccountClaimMaps added in v0.0.10 

func DefaultOidcAuthMethodAccountClaimMaps() Option

func DefaultOidcAuthMethodAllowedAudiences added in v0.0.9 

func DefaultOidcAuthMethodAllowedAudiences() Option

func DefaultOidcAuthMethodApiUrlPrefix added in v0.0.9 

func DefaultOidcAuthMethodApiUrlPrefix() Option

func DefaultOidcAuthMethodClaimsScopes added in v0.0.10 

func DefaultOidcAuthMethodClaimsScopes() Option

func DefaultOidcAuthMethodClientId added in v0.0.9 

func DefaultOidcAuthMethodClientId() Option

func DefaultOidcAuthMethodClientSecret added in v0.0.9 

func DefaultOidcAuthMethodClientSecret() Option

func DefaultOidcAuthMethodDisableDiscoveredConfigValidation added in v0.0.9 

func DefaultOidcAuthMethodDisableDiscoveredConfigValidation() Option

func DefaultOidcAuthMethodDryRun added in v0.0.9 

func DefaultOidcAuthMethodDryRun() Option

func DefaultOidcAuthMethodIdpCaCerts added in v0.0.9 

func DefaultOidcAuthMethodIdpCaCerts() Option

func DefaultOidcAuthMethodIssuer added in v0.0.9 

func DefaultOidcAuthMethodIssuer() Option

func DefaultOidcAuthMethodMaxAge added in v0.0.9 

func DefaultOidcAuthMethodMaxAge() Option

func DefaultOidcAuthMethodPrompts added in v0.0.44 

func DefaultOidcAuthMethodPrompts() Option

func DefaultOidcAuthMethodSigningAlgorithms added in v0.0.9 

func DefaultOidcAuthMethodSigningAlgorithms() Option

func DefaultPasswordAuthMethodMinLoginNameLength 

func DefaultPasswordAuthMethodMinLoginNameLength() Option

func DefaultPasswordAuthMethodMinPasswordLength 

func DefaultPasswordAuthMethodMinPasswordLength() Option

func WithAttributes 

func WithAttributes(inAttributes map[string]interface{}) Option

func WithAutomaticVersioning 

func WithAutomaticVersioning(enable bool) Option

If set, and if the version is zero during an update, the API will perform a fetch to get the current version of the resource and populate it during the update call. This is convenient but opens up the possibility for subtle order-of-modification issues, so use carefully.

func WithDescription 

func WithDescription(inDescription string) Option

func WithFilter added in v0.0.6 

func WithFilter(filter string) Option

WithFilter tells the API to filter the items returned using the provided filter term. The filter should be in a format supported by hashicorp/go-bexpr.

func WithLdapAuthMethodAccountAttributeMaps added in v0.0.35 

func WithLdapAuthMethodAccountAttributeMaps(inAccountAttributeMaps []string) Option

func WithLdapAuthMethodAnonGroupSearch added in v0.0.35 

func WithLdapAuthMethodAnonGroupSearch(inAnonGroupSearch bool) Option

func WithLdapAuthMethodBindDn added in v0.0.35 

func WithLdapAuthMethodBindDn(inBindDn string) Option

func WithLdapAuthMethodBindPassword added in v0.0.35 

func WithLdapAuthMethodBindPassword(inBindPassword string) Option

func WithLdapAuthMethodCertificates added in v0.0.35 

func WithLdapAuthMethodCertificates(inCertificates []string) Option

func WithLdapAuthMethodClientCertificate added in v0.0.35 

func WithLdapAuthMethodClientCertificate(inClientCertificate string) Option

func WithLdapAuthMethodClientCertificateKey added in v0.0.35 

func WithLdapAuthMethodClientCertificateKey(inClientCertificateKey string) Option

func WithLdapAuthMethodDereferenceAliases added in v0.0.41 

func WithLdapAuthMethodDereferenceAliases(inDereferenceAliases string) Option

func WithLdapAuthMethodDiscoverDn added in v0.0.35 

func WithLdapAuthMethodDiscoverDn(inDiscoverDn bool) Option

func WithLdapAuthMethodEnableGroups added in v0.0.35 

func WithLdapAuthMethodEnableGroups(inEnableGroups bool) Option

func WithLdapAuthMethodGroupAttr added in v0.0.35 

func WithLdapAuthMethodGroupAttr(inGroupAttr string) Option

func WithLdapAuthMethodGroupDn added in v0.0.35 

func WithLdapAuthMethodGroupDn(inGroupDn string) Option

func WithLdapAuthMethodGroupFilter added in v0.0.35 

func WithLdapAuthMethodGroupFilter(inGroupFilter string) Option

func WithLdapAuthMethodInsecureTls added in v0.0.35 

func WithLdapAuthMethodInsecureTls(inInsecureTls bool) Option

func WithLdapAuthMethodMaximumPageSize added in v0.0.41 

func WithLdapAuthMethodMaximumPageSize(inMaximumPageSize uint32) Option

func WithLdapAuthMethodStartTls added in v0.0.35 

func WithLdapAuthMethodStartTls(inStartTls bool) Option

func WithLdapAuthMethodState added in v0.0.35 

func WithLdapAuthMethodState(inState string) Option

func WithLdapAuthMethodUpnDomain added in v0.0.35 

func WithLdapAuthMethodUpnDomain(inUpnDomain string) Option

func WithLdapAuthMethodUrls added in v0.0.35 

func WithLdapAuthMethodUrls(inUrls []string) Option

func WithLdapAuthMethodUseTokenGroups added in v0.0.35 

func WithLdapAuthMethodUseTokenGroups(inUseTokenGroups bool) Option

func WithLdapAuthMethodUserAttr added in v0.0.35 

func WithLdapAuthMethodUserAttr(inUserAttr string) Option

func WithLdapAuthMethodUserDn added in v0.0.35 

func WithLdapAuthMethodUserDn(inUserDn string) Option

func WithLdapAuthMethodUserFilter added in v0.0.35 

func WithLdapAuthMethodUserFilter(inUserFilter string) Option

func WithListToken added in v0.0.44 

func WithListToken(listToken string) Option

WithListToken tells the API to use the provided list token for listing operations on this resource.

func WithName 

func WithName(inName string) Option

func WithOidcAuthMethodAccountClaimMaps added in v0.0.10 

func WithOidcAuthMethodAccountClaimMaps(inAccountClaimMaps []string) Option

func WithOidcAuthMethodAllowedAudiences added in v0.0.9 

func WithOidcAuthMethodAllowedAudiences(inAllowedAudiences []string) Option

func WithOidcAuthMethodApiUrlPrefix added in v0.0.9 

func WithOidcAuthMethodApiUrlPrefix(inApiUrlPrefix string) Option

func WithOidcAuthMethodClaimsScopes added in v0.0.10 

func WithOidcAuthMethodClaimsScopes(inClaimsScopes []string) Option

func WithOidcAuthMethodClientId added in v0.0.9 

func WithOidcAuthMethodClientId(inClientId string) Option

func WithOidcAuthMethodClientSecret added in v0.0.9 

func WithOidcAuthMethodClientSecret(inClientSecret string) Option

func WithOidcAuthMethodDisableDiscoveredConfigValidation added in v0.0.9 

func WithOidcAuthMethodDisableDiscoveredConfigValidation(inDisableDiscoveredConfigValidation bool) Option

func WithOidcAuthMethodDryRun added in v0.0.9 

func WithOidcAuthMethodDryRun(inDryRun bool) Option

func WithOidcAuthMethodIdpCaCerts added in v0.0.9 

func WithOidcAuthMethodIdpCaCerts(inIdpCaCerts []string) Option

func WithOidcAuthMethodIssuer added in v0.0.9 

func WithOidcAuthMethodIssuer(inIssuer string) Option

func WithOidcAuthMethodMaxAge added in v0.0.9 

func WithOidcAuthMethodMaxAge(inMaxAge uint32) Option

func WithOidcAuthMethodPrompts added in v0.0.44 

func WithOidcAuthMethodPrompts(inPrompts []string) Option

func WithOidcAuthMethodSigningAlgorithms added in v0.0.9 

func WithOidcAuthMethodSigningAlgorithms(inSigningAlgorithms []string) Option

func WithPasswordAuthMethodMinLoginNameLength 

func WithPasswordAuthMethodMinLoginNameLength(inMinLoginNameLength uint32) Option

func WithPasswordAuthMethodMinPasswordLength 

func WithPasswordAuthMethodMinPasswordLength(inMinPasswordLength uint32) Option

func WithRecursive added in v0.0.4 

func WithRecursive(recurse bool) Option

WithRecursive tells the API to use recursion for listing operations on this resource

func WithSkipCurlOutput added in v0.0.4 

func WithSkipCurlOutput(skip bool) Option

WithSkipCurlOutput tells the API to not use the current call for cURL output. Useful for when we need to look up versions.

type PasswordAuthMethodAttributes 

type PasswordAuthMethodAttributes struct {
	MinLoginNameLength uint32 `json:"min_login_name_length,omitempty"`
	MinPasswordLength  uint32 `json:"min_password_length,omitempty"`
}

func AttributesMapToPasswordAuthMethodAttributes added in v0.0.26 

func AttributesMapToPasswordAuthMethodAttributes(in map[string]interface{}) (*PasswordAuthMethodAttributes, error)

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.