authmethods

package
v0.0.40 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_controller_api_resources_authmethods_v1_auth_method_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AuthMethod 

type AuthMethod struct {

	// Output only. The ID of the Auth Method.
	Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// The ID of the Scope of which this Auth Method is a part.
	ScopeId string `protobuf:"bytes,20,opt,name=scope_id,proto3" json:"scope_id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// Output only. Scope information for this Auth method.
	Scope *scopes.ScopeInfo `protobuf:"bytes,30,opt,name=scope,proto3" json:"scope,omitempty"`
	// Optional name for identification purposes.
	Name *wrapperspb.StringValue `protobuf:"bytes,40,opt,name=name,proto3" json:"name,omitempty" class:"public"` // @gotags: `class:"public"`
	// Optional user-set description for identification purposes.
	Description *wrapperspb.StringValue `protobuf:"bytes,50,opt,name=description,proto3" json:"description,omitempty" class:"public"` // @gotags: `class:"public"`
	// Output only. The time this resource was created.
	CreatedTime *timestamppb.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// Output only. The time this resource was last updated.
	UpdatedTime *timestamppb.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
	// The mutation will fail if the version does not match the latest known good version.
	Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty" class:"public"` // @gotags: `class:"public"`
	// The Auth Method type.
	Type string `protobuf:"bytes,90,opt,name=type,proto3" json:"type,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// Types that are assignable to Attrs:
	//
	//	*AuthMethod_Attributes
	//	*AuthMethod_PasswordAuthMethodAttributes
	//	*AuthMethod_OidcAuthMethodsAttributes
	//	*AuthMethod_LdapAuthMethodsAttributes
	Attrs isAuthMethod_Attrs `protobuf_oneof:"attrs"`
	// Output only. Whether this auth method is the primary auth method for it's scope.
	// To change this value update the primary_auth_method_id field on the scope.
	IsPrimary bool `protobuf:"varint,110,opt,name=is_primary,proto3" json:"is_primary,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// Output only. The available actions on this resource for this user.
	AuthorizedActions []string `protobuf:"bytes,300,rep,name=authorized_actions,proto3" json:"authorized_actions,omitempty" class:"public"` // @gotags: `class:"public"`
	// Output only. The authorized actions for the scope's collections.
	AuthorizedCollectionActions map[string]*structpb.ListValue `` // classified as public via taggable implementation
	/* 201-byte string literal not displayed */
	// contains filtered or unexported fields
}

AuthMethod contains all fields related to an Auth Method resource

func (*AuthMethod) Descriptor deprecated 

func (*AuthMethod) Descriptor() ([]byte, []int)

Deprecated: Use AuthMethod.ProtoReflect.Descriptor instead.

func (*AuthMethod) GetAttributes 

func (x *AuthMethod) GetAttributes() *structpb.Struct

func (*AuthMethod) GetAttrs added in v0.0.15 

func (m *AuthMethod) GetAttrs() isAuthMethod_Attrs

func (*AuthMethod) GetAuthorizedActions 

func (x *AuthMethod) GetAuthorizedActions() []string

func (*AuthMethod) GetAuthorizedCollectionActions 

func (x *AuthMethod) GetAuthorizedCollectionActions() map[string]*structpb.ListValue

func (*AuthMethod) GetCreatedTime 

func (x *AuthMethod) GetCreatedTime() *timestamppb.Timestamp

func (*AuthMethod) GetDescription 

func (x *AuthMethod) GetDescription() *wrapperspb.StringValue

func (*AuthMethod) GetId 

func (x *AuthMethod) GetId() string

func (*AuthMethod) GetIsPrimary 

func (x *AuthMethod) GetIsPrimary() bool

func (*AuthMethod) GetLdapAuthMethodsAttributes added in v0.0.31 

func (x *AuthMethod) GetLdapAuthMethodsAttributes() *LdapAuthMethodAttributes

func (*AuthMethod) GetName 

func (x *AuthMethod) GetName() *wrapperspb.StringValue

func (*AuthMethod) GetOidcAuthMethodsAttributes added in v0.0.15 

func (x *AuthMethod) GetOidcAuthMethodsAttributes() *OidcAuthMethodAttributes

func (*AuthMethod) GetPasswordAuthMethodAttributes added in v0.0.15 

func (x *AuthMethod) GetPasswordAuthMethodAttributes() *PasswordAuthMethodAttributes

func (*AuthMethod) GetScope 

func (x *AuthMethod) GetScope() *scopes.ScopeInfo

func (*AuthMethod) GetScopeId 

func (x *AuthMethod) GetScopeId() string

func (*AuthMethod) GetType 

func (x *AuthMethod) GetType() string

func (*AuthMethod) GetUpdatedTime 

func (x *AuthMethod) GetUpdatedTime() *timestamppb.Timestamp

func (*AuthMethod) GetVersion 

func (x *AuthMethod) GetVersion() uint32

func (*AuthMethod) ProtoMessage 

func (*AuthMethod) ProtoMessage()

func (*AuthMethod) ProtoReflect 

func (x *AuthMethod) ProtoReflect() protoreflect.Message

func (*AuthMethod) Reset 

func (x *AuthMethod) Reset()

func (*AuthMethod) String 

func (x *AuthMethod) String() string

func (*AuthMethod) Tags added in v0.0.12 

func (req *AuthMethod) Tags() ([]encrypt.PointerTag, error)

Tags implements the encrypt.Taggable interface which allows AuthMethod map fields to be classified for the encrypt filter.

type AuthMethod_Attributes added in v0.0.15 

type AuthMethod_Attributes struct {
	// The attributes that are applicable for the specific Auth Method type.
	Attributes *structpb.Struct `protobuf:"bytes,100,opt,name=attributes,proto3,oneof"`
}

type AuthMethod_LdapAuthMethodsAttributes added in v0.0.31 

type AuthMethod_LdapAuthMethodsAttributes struct {
	LdapAuthMethodsAttributes *LdapAuthMethodAttributes `protobuf:"bytes,103,opt,name=ldap_auth_methods_attributes,json=ldapAuthMethodsAttributes,proto3,oneof"`
}

type AuthMethod_OidcAuthMethodsAttributes added in v0.0.15 

type AuthMethod_OidcAuthMethodsAttributes struct {
	OidcAuthMethodsAttributes *OidcAuthMethodAttributes `protobuf:"bytes,102,opt,name=oidc_auth_methods_attributes,json=oidcAuthMethodsAttributes,proto3,oneof"`
}

type AuthMethod_PasswordAuthMethodAttributes added in v0.0.15 

type AuthMethod_PasswordAuthMethodAttributes struct {
	PasswordAuthMethodAttributes *PasswordAuthMethodAttributes `protobuf:"bytes,101,opt,name=password_auth_method_attributes,json=passwordAuthMethodAttributes,proto3,oneof"`
}

type LdapAuthMethodAttributes added in v0.0.31 

type LdapAuthMethodAttributes struct {

	// Output only. The state of the auth method. Will be "inactive",
	// "active-private", or "active-public".
	State string `protobuf:"bytes,10,opt,name=state,proto3" json:"state,omitempty" class:"public"` // @gotags: `class:"public"`
	// start_tls if true, issues a StartTLS command after establishing an
	// unencrypted connection. Defaults to false.
	StartTls bool `protobuf:"varint,20,opt,name=start_tls,proto3" json:"start_tls,omitempty" class:"public"` // @gotags: `class:"public"`
	// insecure_tls if true, skips LDAP server SSL certificate validation -
	// insecure and use with caution. Defaults to false.
	InsecureTls bool `protobuf:"varint,30,opt,name=insecure_tls,proto3" json:"insecure_tls,omitempty" class:"public"` // @gotags: `class:"public"`
	// discover_dn if true, use anon bind to discover the bind DN of a user.
	// Defaults to false.
	DiscoverDn bool `protobuf:"varint,40,opt,name=discover_dn,proto3" json:"discover_dn,omitempty" class:"public"` // @gotags: `class:"public"`
	// anon_group_search if true, use anon bind when performing LDAP group
	// searches. Defaults to false.
	AnonGroupSearch bool `protobuf:"varint,50,opt,name=anon_group_search,proto3" json:"anon_group_search,omitempty" class:"public"` // @gotags: `class:"public"`
	// upn_domain is the userPrincipalDomain used to construct the UPN string for
	// the authenticating user. The constructed UPN will appear as
	// [username]@UPNDomain  Example: example.com, which will cause Boundary to
	// bind as username@example.com when authenticating the user.
	UpnDomain *wrapperspb.StringValue `protobuf:"bytes,60,opt,name=upn_domain,proto3" json:"upn_domain,omitempty" class:"public"` // @gotags: `class:"public"`
	// urls are the LDAP URLS that specify LDAP servers to connection to.  There
	// must be at lease on URL for each LDAP auth method. When attempting to
	// connect, the URLs are tried in the order specified. These are Value Objects
	// that will be stored as Url messages, and are operated on as a complete set
	// (not individually).
	Urls []string `protobuf:"bytes,70,rep,name=urls,proto3" json:"urls,omitempty" class:"public"` // @gotags: `class:"public"`
	// user_dn (optional) is the base DN under which to perform user search.
	// Example: ou=Users,dc=example,dc=com
	UserDn *wrapperspb.StringValue `protobuf:"bytes,80,opt,name=user_dn,proto3" json:"user_dn,omitempty" class:"public"` // @gotags: `class:"public"`
	// user_attr (optional) is the attribute on user attribute entry matching the
	// username passed when authenticating.  Examples: cn, uid
	UserAttr *wrapperspb.StringValue `protobuf:"bytes,90,opt,name=user_attr,proto3" json:"user_attr,omitempty" class:"public"` // @gotags: `class:"public"`
	// user_filter (optional) is a go template used to construct a LDAP user
	// search filter. The template can access the following context variables:
	// [UserAttr, Username]. The default userfilter is
	// ({{.UserAttr}}={{.Username}}) or
	// (userPrincipalName={{.Username}}@UPNDomain) if the upndomain parameter is
	// set.
	UserFilter *wrapperspb.StringValue `protobuf:"bytes,100,opt,name=user_filter,proto3" json:"user_filter,omitempty" class:"public"` // @gotags: `class:"public"`
	// enable_groups if true, an authenticated user's groups will be found during
	// authentication. Defaults to false.
	EnableGroups bool `protobuf:"varint,110,opt,name=enable_groups,proto3" json:"enable_groups,omitempty" class:"public"` // @gotags: `class:"public"`
	// group_dn (optional) is the base DN under which to perform user search.
	// Example: ou=Groups,dc=example,dc=com
	//
	// Note: there is no default, so no base dn will be used for group searches if
	// it's not specified.
	GroupDn *wrapperspb.StringValue `protobuf:"bytes,120,opt,name=group_dn,proto3" json:"group_dn,omitempty" class:"public"` // @gotags: `class:"public"`
	// group_attr (optional) is the LDAP attribute to follow on objects returned
	// by GroupFilter in order to enumerate user group membership. Examples: for
	// GroupFilter queries returning group objects, use: cn. For queries returning
	// user objects, use: memberOf. The default is cn.
	GroupAttr *wrapperspb.StringValue `protobuf:"bytes,130,opt,name=group_attr,proto3" json:"group_attr,omitempty" class:"public"` // @gotags: `class:"public"`
	// group_filter (optional) is a Go template used when constructing the group
	// membership query. The template can access the following context variables:
	// [UserDN, Username]. The default is
	// (|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}})),
	// which is compatible with several common directory schemas.
	GroupFilter *wrapperspb.StringValue `protobuf:"bytes,140,opt,name=group_filter,proto3" json:"group_filter,omitempty" class:"public"` // @gotags: `class:"public"`
	// certificates are optional PEM encoded x509 certificates in ASN.1 DER form
	// that can be used as trust anchors when connecting to an LDAP provider.
	// These are Value Objects that will be stored as Certificate messages, and
	// are operatated on as a complete set (not individually).
	Certificates []string `protobuf:"bytes,150,rep,name=certificates,proto3" json:"certificates,omitempty" class:"public"` // @gotags: `class:"public"`
	// client_certificate is the optional certificate encoded as PEM. It must be
	// set if an optional client_certificate_key specified
	ClientCertificate *wrapperspb.StringValue `protobuf:"bytes,160,opt,name=client_certificate,proto3" json:"client_certificate,omitempty" class:"public"` // @gotags: `class:"public"`
	// Input only. The client_certificate_key (optional) is the plain-text of the
	// certificate key data encoded as PEM.
	ClientCertificateKey *wrapperspb.StringValue `protobuf:"bytes,170,opt,name=client_certificate_key,proto3" json:"client_certificate_key,omitempty" class:"secret"` // @gotags: `class:"secret"`
	// Output only. The HMAC'd value of the client certificate key to indicate
	// whether the certificate key has changed.
	ClientCertificateKeyHmac string `protobuf:"bytes,180,opt,name=client_certificate_key_hmac,proto3" json:"client_certificate_key_hmac,omitempty" class:"public"` // @gotags: `class:"public"`
	// bind_dn (optional) is the distinguished name of entry to bind when
	// performing user and group search. Example:
	// cn=vault,ou=Users,dc=example,dc=com
	BindDn *wrapperspb.StringValue `protobuf:"bytes,190,opt,name=bind_dn,proto3" json:"bind_dn,omitempty" class:"public"` // @gotags: `class:"public"`
	// Input only. The bind_password (optional) is the password to use along with
	// binddn when performing user search.
	BindPassword *wrapperspb.StringValue `protobuf:"bytes,200,opt,name=bind_password,proto3" json:"bind_password,omitempty" class:"secret"` // @gotags: `class:"secret"`
	// Output only. The HMAC'd value of the bind password to indicate
	// whether the password has changed.
	BindPasswordHmac string `protobuf:"bytes,210,opt,name=bind_password_hmac,proto3" json:"bind_password_hmac,omitempty" class:"public"` // @gotags: `class:"public"`
	UseTokenGroups   bool   `protobuf:"varint,220,opt,name=use_token_groups,proto3" json:"use_token_groups,omitempty" class:"public"`    // @gotags: `class:"public"`
	// account_attribute_maps are optional attribute maps from custom attributes
	// to the standard attributes of fullname and email.  These maps are
	// represented as key=value where the key equals the from_attribute and the
	// value equals the to_attribute.  For example "preferredName=fullName".  All
	// attribute names are case insensitive.
	AccountAttributeMaps []string `protobuf:"bytes,230,rep,name=account_attribute_maps,proto3" json:"account_attribute_maps,omitempty" class:"public"` // @gotags: `class:"public"`
	// maximum_page_size (optional) specifies a maximum ldap search result size to
	// use when retrieving the authenticated user's group memberships. This can
	// be used to avoid reaching the LDAP server's max result size.
	MaximumPageSize uint32 `protobuf:"varint,240,opt,name=maximum_page_size,proto3" json:"maximum_page_size,omitempty" class:"public"` // @gotags: `class:"public"`
	// dereference_aliases (optional) will control how aliases are dereferenced when
	// performing the search. Possible values are: never, finding, searching,
	// and always. If unset, a default of "never" is used. When set to
	// "finding", it will only dereference aliases during name resolution of the
	// base. When set to "searching", it will dereference aliases after name
	// resolution.
	DereferenceAliases *wrapperspb.StringValue `protobuf:"bytes,250,opt,name=dereference_aliases,proto3" json:"dereference_aliases,omitempty" class:"public"` // @gotags: `class:"public"`
	// contains filtered or unexported fields
}

The attributes of an LDAP typed auth method.

func (*LdapAuthMethodAttributes) Descriptor deprecated added in v0.0.31 

func (*LdapAuthMethodAttributes) Descriptor() ([]byte, []int)

Deprecated: Use LdapAuthMethodAttributes.ProtoReflect.Descriptor instead.

func (*LdapAuthMethodAttributes) GetAccountAttributeMaps added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetAccountAttributeMaps() []string

func (*LdapAuthMethodAttributes) GetAnonGroupSearch added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetAnonGroupSearch() bool

func (*LdapAuthMethodAttributes) GetBindDn added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetBindDn() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetBindPassword added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetBindPassword() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetBindPasswordHmac added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetBindPasswordHmac() string

func (*LdapAuthMethodAttributes) GetCertificates added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetCertificates() []string

func (*LdapAuthMethodAttributes) GetClientCertificate added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetClientCertificate() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetClientCertificateKey added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetClientCertificateKey() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetClientCertificateKeyHmac added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetClientCertificateKeyHmac() string

func (*LdapAuthMethodAttributes) GetDereferenceAliases added in v0.0.37 

func (x *LdapAuthMethodAttributes) GetDereferenceAliases() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetDiscoverDn added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetDiscoverDn() bool

func (*LdapAuthMethodAttributes) GetEnableGroups added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetEnableGroups() bool

func (*LdapAuthMethodAttributes) GetGroupAttr added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetGroupAttr() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetGroupDn added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetGroupDn() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetGroupFilter added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetGroupFilter() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetInsecureTls added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetInsecureTls() bool

func (*LdapAuthMethodAttributes) GetMaximumPageSize added in v0.0.37 

func (x *LdapAuthMethodAttributes) GetMaximumPageSize() uint32

func (*LdapAuthMethodAttributes) GetStartTls added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetStartTls() bool

func (*LdapAuthMethodAttributes) GetState added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetState() string

func (*LdapAuthMethodAttributes) GetUpnDomain added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetUpnDomain() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetUrls added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetUrls() []string

func (*LdapAuthMethodAttributes) GetUseTokenGroups added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetUseTokenGroups() bool

func (*LdapAuthMethodAttributes) GetUserAttr added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetUserAttr() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetUserDn added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetUserDn() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) GetUserFilter added in v0.0.31 

func (x *LdapAuthMethodAttributes) GetUserFilter() *wrapperspb.StringValue

func (*LdapAuthMethodAttributes) ProtoMessage added in v0.0.31 

func (*LdapAuthMethodAttributes) ProtoMessage()

func (*LdapAuthMethodAttributes) ProtoReflect added in v0.0.31 

func (x *LdapAuthMethodAttributes) ProtoReflect() protoreflect.Message

func (*LdapAuthMethodAttributes) Reset added in v0.0.31 

func (x *LdapAuthMethodAttributes) Reset()

func (*LdapAuthMethodAttributes) String added in v0.0.31 

func (x *LdapAuthMethodAttributes) String() string

type OidcAuthMethodAttributes 

type OidcAuthMethodAttributes struct {

	// Output only. The state of the auth method. Will be "inactive",
	// "active-private", or "active-public".
	State string `protobuf:"bytes,10,opt,name=state,proto3" json:"state,omitempty" class:"public"` // @gotags: `class:"public"`
	// The issuer URL. Boundary expects only the schema, host, and port and will
	// strip off ".well-known/openid-configuration" if present. This will be
	// used for configuration discovery as well as for validation of the "iss"
	// claim.
	Issuer *wrapperspb.StringValue `protobuf:"bytes,20,opt,name=issuer,proto3" json:"issuer,omitempty" class:"public"` // @gotags: `class:"public"`
	// An OAuth 2.0 Client Identifier valid at the Authorization Server.
	ClientId *wrapperspb.StringValue `protobuf:"bytes,30,opt,name=client_id,proto3" json:"client_id,omitempty" class:"public"` // @gotags: `class:"public"`
	// Input only. The client's secret.
	ClientSecret *wrapperspb.StringValue `protobuf:"bytes,40,opt,name=client_secret,proto3" json:"client_secret,omitempty" class:"secret"` // @gotags: `class:"secret"`
	// Output only. The HMAC'd value of the clients secret to indicate whether
	// the client secret has changed.
	ClientSecretHmac string `protobuf:"bytes,50,opt,name=client_secret_hmac,proto3" json:"client_secret_hmac,omitempty" class:"public"` // @gotags: `class:"public"`
	// The OIDC "max_age" parameter sent to the Authorization Server indicating
	// a maximum acceptable time in seconds since the user's last authentication
	// before requiring the user to reauthenticate. 0 indicates an immediate
	// need to reauthenticate.
	MaxAge *wrapperspb.UInt32Value `protobuf:"bytes,60,opt,name=max_age,proto3" json:"max_age,omitempty" class:"public"` // @gotags: `class:"public"`
	// The signing algorithms allowed for the auth method.
	SigningAlgorithms []string `protobuf:"bytes,70,rep,name=signing_algorithms,proto3" json:"signing_algorithms,omitempty" class:"public"` // @gotags: `class:"public"`
	// The prefix that should be used for any URLs needed during the
	// authentication flow. This includes the callback URL, the token retrieval
	// URL, and the redirection URL used by the OIDC Authorization Server.
	ApiUrlPrefix *wrapperspb.StringValue `protobuf:"bytes,80,opt,name=api_url_prefix,proto3" json:"api_url_prefix,omitempty" class:"public"` // @gotags: `class:"public"`
	// Output only. The callback URL that should be configured on the
	// Authorization Server to use during the authentication flow.
	CallbackUrl string `protobuf:"bytes,90,opt,name=callback_url,proto3" json:"callback_url,omitempty" class:"public"` // @gotags: `class:"public"`
	// Optional PEM-encoded X.509 CA certificates that can be used as trust anchors
	// when connecting to an OIDC provider.
	IdpCaCerts []string `protobuf:"bytes,100,rep,name=idp_ca_certs,proto3" json:"idp_ca_certs,omitempty" class:"public"` // @gotags: `class:"public"`
	// Allowed audience claims for this auth method.
	AllowedAudiences []string `protobuf:"bytes,110,rep,name=allowed_audiences,proto3" json:"allowed_audiences,omitempty" class:"public"` // @gotags: `class:"public"`
	// Optional claims scopes that will be requested during authentication.
	// see: https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims
	ClaimsScopes []string `protobuf:"bytes,112,rep,name=claims_scopes,proto3" json:"claims_scopes,omitempty" class:"public"` // @gotags: `class:"public"`
	// account_claim_maps are optional claim maps from custom claims to the
	// standard claims of sub, name and email.  These maps are represented as
	// key=value where the key equals the from_claim and the value equals the
	// to_claim.  For example "oid=sub".
	AccountClaimMaps []string `protobuf:"bytes,113,rep,name=account_claim_maps,proto3" json:"account_claim_maps,omitempty" class:"public"` // @gotags: `class:"public"`
	// If the Authorization Server's discovered configuration contains values
	// that do not match the configuration set on this auth method, this can be
	// set to force the local configuration to override the discovered values.
	// This is useful in the case of slow-changing or incorrect values announced
	// by the Authorization Server. NOTE: For safety, not providing this value
	// will be treated the same as "false"; that is, every time the method is
	// updated or the state is changed, this value must be set to "true" or it
	// will be disabled.
	DisableDiscoveredConfigValidation bool `` // @gotags: `class:"public"`
	/* 143-byte string literal not displayed */
	// dry_run, when set on an update request, indicates that the changes should
	// not be persisted.  Boundary will still perform the normal checks to confirm
	// the auth method is complete and validated against the discovered config.
	// This value will also be set on the returned resource when set in the request
	// along with the updated fields applied to the resource (but not persisted) as
	// a result of the update request.
	DryRun bool `protobuf:"varint,130,opt,name=dry_run,proto3" json:"dry_run,omitempty" class:"public"` // @gotags: `class:"public"`
	// contains filtered or unexported fields
}

The attributes of an OIDC typed auth method.

func (*OidcAuthMethodAttributes) Descriptor deprecated 

func (*OidcAuthMethodAttributes) Descriptor() ([]byte, []int)

Deprecated: Use OidcAuthMethodAttributes.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAttributes) GetAccountClaimMaps 

func (x *OidcAuthMethodAttributes) GetAccountClaimMaps() []string

func (*OidcAuthMethodAttributes) GetAllowedAudiences 

func (x *OidcAuthMethodAttributes) GetAllowedAudiences() []string

func (*OidcAuthMethodAttributes) GetApiUrlPrefix 

func (x *OidcAuthMethodAttributes) GetApiUrlPrefix() *wrapperspb.StringValue

func (*OidcAuthMethodAttributes) GetCallbackUrl 

func (x *OidcAuthMethodAttributes) GetCallbackUrl() string

func (*OidcAuthMethodAttributes) GetClaimsScopes 

func (x *OidcAuthMethodAttributes) GetClaimsScopes() []string

func (*OidcAuthMethodAttributes) GetClientId 

func (x *OidcAuthMethodAttributes) GetClientId() *wrapperspb.StringValue

func (*OidcAuthMethodAttributes) GetClientSecret 

func (x *OidcAuthMethodAttributes) GetClientSecret() *wrapperspb.StringValue

func (*OidcAuthMethodAttributes) GetClientSecretHmac 

func (x *OidcAuthMethodAttributes) GetClientSecretHmac() string

func (*OidcAuthMethodAttributes) GetDisableDiscoveredConfigValidation 

func (x *OidcAuthMethodAttributes) GetDisableDiscoveredConfigValidation() bool

func (*OidcAuthMethodAttributes) GetDryRun 

func (x *OidcAuthMethodAttributes) GetDryRun() bool

func (*OidcAuthMethodAttributes) GetIdpCaCerts 

func (x *OidcAuthMethodAttributes) GetIdpCaCerts() []string

func (*OidcAuthMethodAttributes) GetIssuer 

func (x *OidcAuthMethodAttributes) GetIssuer() *wrapperspb.StringValue

func (*OidcAuthMethodAttributes) GetMaxAge 

func (x *OidcAuthMethodAttributes) GetMaxAge() *wrapperspb.UInt32Value

func (*OidcAuthMethodAttributes) GetSigningAlgorithms 

func (x *OidcAuthMethodAttributes) GetSigningAlgorithms() []string

func (*OidcAuthMethodAttributes) GetState 

func (x *OidcAuthMethodAttributes) GetState() string

func (*OidcAuthMethodAttributes) ProtoMessage 

func (*OidcAuthMethodAttributes) ProtoMessage()

func (*OidcAuthMethodAttributes) ProtoReflect 

func (x *OidcAuthMethodAttributes) ProtoReflect() protoreflect.Message

func (*OidcAuthMethodAttributes) Reset 

func (x *OidcAuthMethodAttributes) Reset()

func (*OidcAuthMethodAttributes) String 

func (x *OidcAuthMethodAttributes) String() string

type OidcAuthMethodAuthenticateCallbackRequest 

type OidcAuthMethodAuthenticateCallbackRequest struct {

	// The returned code
	Code string `protobuf:"bytes,10,opt,name=code,proto3" json:"code,omitempty" class:"secret"` // @gotags: `class:"secret"`
	// The returned state
	State string `protobuf:"bytes,20,opt,name=state,proto3" json:"state,omitempty" class:"public"` // @gotags: `class:"public"`
	// Error parameters, if they are returned
	Error            string `protobuf:"bytes,30,opt,name=error,proto3" json:"error,omitempty" class:"public"`                         // @gotags: `class:"public"`
	ErrorDescription string `protobuf:"bytes,40,opt,name=error_description,proto3" json:"error_description,omitempty" class:"public"` // @gotags: `class:"public"`
	ErrorUri         string `protobuf:"bytes,50,opt,name=error_uri,proto3" json:"error_uri,omitempty" class:"public"`                 // @gotags: `class:"public"`
	// contains filtered or unexported fields
}

The structure of OIDC callback request parameters

func (*OidcAuthMethodAuthenticateCallbackRequest) Descriptor deprecated 

func (*OidcAuthMethodAuthenticateCallbackRequest) Descriptor() ([]byte, []int)

Deprecated: Use OidcAuthMethodAuthenticateCallbackRequest.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateCallbackRequest) GetCode 

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetCode() string

func (*OidcAuthMethodAuthenticateCallbackRequest) GetError 

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetError() string

func (*OidcAuthMethodAuthenticateCallbackRequest) GetErrorDescription 

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetErrorDescription() string

func (*OidcAuthMethodAuthenticateCallbackRequest) GetErrorUri 

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetErrorUri() string

func (*OidcAuthMethodAuthenticateCallbackRequest) GetState 

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetState() string

func (*OidcAuthMethodAuthenticateCallbackRequest) ProtoMessage 

func (*OidcAuthMethodAuthenticateCallbackRequest) ProtoMessage()

func (*OidcAuthMethodAuthenticateCallbackRequest) ProtoReflect 

func (x *OidcAuthMethodAuthenticateCallbackRequest) ProtoReflect() protoreflect.Message

func (*OidcAuthMethodAuthenticateCallbackRequest) Reset 

func (x *OidcAuthMethodAuthenticateCallbackRequest) Reset()

func (*OidcAuthMethodAuthenticateCallbackRequest) String 

func (x *OidcAuthMethodAuthenticateCallbackRequest) String() string

type OidcAuthMethodAuthenticateCallbackResponse 

type OidcAuthMethodAuthenticateCallbackResponse struct {

	// The final redirection URL
	FinalRedirectUrl string `protobuf:"bytes,10,opt,name=final_redirect_url,proto3" json:"final_redirect_url,omitempty" class:"public"` // @gotags: `class:"public"`
	// contains filtered or unexported fields
}

The structure of OIDC callback response parameters

func (*OidcAuthMethodAuthenticateCallbackResponse) Descriptor deprecated 

func (*OidcAuthMethodAuthenticateCallbackResponse) Descriptor() ([]byte, []int)

Deprecated: Use OidcAuthMethodAuthenticateCallbackResponse.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateCallbackResponse) GetFinalRedirectUrl 

func (x *OidcAuthMethodAuthenticateCallbackResponse) GetFinalRedirectUrl() string

func (*OidcAuthMethodAuthenticateCallbackResponse) ProtoMessage 

func (*OidcAuthMethodAuthenticateCallbackResponse) ProtoMessage()

func (*OidcAuthMethodAuthenticateCallbackResponse) ProtoReflect 

func (x *OidcAuthMethodAuthenticateCallbackResponse) ProtoReflect() protoreflect.Message

func (*OidcAuthMethodAuthenticateCallbackResponse) Reset 

func (x *OidcAuthMethodAuthenticateCallbackResponse) Reset()

func (*OidcAuthMethodAuthenticateCallbackResponse) String 

func (x *OidcAuthMethodAuthenticateCallbackResponse) String() string

type OidcAuthMethodAuthenticateStartResponse 

type OidcAuthMethodAuthenticateStartResponse struct {

	// The returned authentication URL
	AuthUrl string `protobuf:"bytes,10,opt,name=auth_url,proto3" json:"auth_url,omitempty" class:"public"` // @gotags: `class:"public"`
	// The returned token ID
	TokenId string `protobuf:"bytes,30,opt,name=token_id,proto3" json:"token_id,omitempty" class:"public"` // @gotags: `class:"public"`
	// contains filtered or unexported fields
}

The structure of the OIDC authenticate start response, in the JSON object

func (*OidcAuthMethodAuthenticateStartResponse) Descriptor deprecated 

func (*OidcAuthMethodAuthenticateStartResponse) Descriptor() ([]byte, []int)

Deprecated: Use OidcAuthMethodAuthenticateStartResponse.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateStartResponse) GetAuthUrl 

func (x *OidcAuthMethodAuthenticateStartResponse) GetAuthUrl() string

func (*OidcAuthMethodAuthenticateStartResponse) GetTokenId 

func (x *OidcAuthMethodAuthenticateStartResponse) GetTokenId() string

func (*OidcAuthMethodAuthenticateStartResponse) ProtoMessage 

func (*OidcAuthMethodAuthenticateStartResponse) ProtoMessage()

func (*OidcAuthMethodAuthenticateStartResponse) ProtoReflect 

func (x *OidcAuthMethodAuthenticateStartResponse) ProtoReflect() protoreflect.Message

func (*OidcAuthMethodAuthenticateStartResponse) Reset 

func (x *OidcAuthMethodAuthenticateStartResponse) Reset()

func (*OidcAuthMethodAuthenticateStartResponse) String 

func (x *OidcAuthMethodAuthenticateStartResponse) String() string

type OidcAuthMethodAuthenticateTokenRequest 

type OidcAuthMethodAuthenticateTokenRequest struct {

	// The ID of the pending token
	TokenId string `protobuf:"bytes,10,opt,name=token_id,proto3" json:"token_id,omitempty" class:"secret"` // @gotags: `class:"secret"`
	// contains filtered or unexported fields
}

The structure of OIDC token request parameters

func (*OidcAuthMethodAuthenticateTokenRequest) Descriptor deprecated 

func (*OidcAuthMethodAuthenticateTokenRequest) Descriptor() ([]byte, []int)

Deprecated: Use OidcAuthMethodAuthenticateTokenRequest.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateTokenRequest) GetTokenId 

func (x *OidcAuthMethodAuthenticateTokenRequest) GetTokenId() string

func (*OidcAuthMethodAuthenticateTokenRequest) ProtoMessage 

func (*OidcAuthMethodAuthenticateTokenRequest) ProtoMessage()

func (*OidcAuthMethodAuthenticateTokenRequest) ProtoReflect 

func (x *OidcAuthMethodAuthenticateTokenRequest) ProtoReflect() protoreflect.Message

func (*OidcAuthMethodAuthenticateTokenRequest) Reset 

func (x *OidcAuthMethodAuthenticateTokenRequest) Reset()

func (*OidcAuthMethodAuthenticateTokenRequest) String 

func (x *OidcAuthMethodAuthenticateTokenRequest) String() string

type OidcAuthMethodAuthenticateTokenResponse 

type OidcAuthMethodAuthenticateTokenResponse struct {

	// The status. This will always be "unknown". It will never be forwarded to
	// the consumer.
	Status string `protobuf:"bytes,10,opt,name=status,proto3" json:"status,omitempty" class:"public"` // @gotags: `class:"public"`
	// contains filtered or unexported fields
}

Internal only: the structure of a token response if it _does not_ contain a token.

func (*OidcAuthMethodAuthenticateTokenResponse) Descriptor deprecated 

func (*OidcAuthMethodAuthenticateTokenResponse) Descriptor() ([]byte, []int)

Deprecated: Use OidcAuthMethodAuthenticateTokenResponse.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateTokenResponse) GetStatus 

func (x *OidcAuthMethodAuthenticateTokenResponse) GetStatus() string

func (*OidcAuthMethodAuthenticateTokenResponse) ProtoMessage 

func (*OidcAuthMethodAuthenticateTokenResponse) ProtoMessage()

func (*OidcAuthMethodAuthenticateTokenResponse) ProtoReflect 

func (x *OidcAuthMethodAuthenticateTokenResponse) ProtoReflect() protoreflect.Message

func (*OidcAuthMethodAuthenticateTokenResponse) Reset 

func (x *OidcAuthMethodAuthenticateTokenResponse) Reset()

func (*OidcAuthMethodAuthenticateTokenResponse) String 

func (x *OidcAuthMethodAuthenticateTokenResponse) String() string

type PasswordAuthMethodAttributes 

type PasswordAuthMethodAttributes struct {

	// The minimum length allowed for user names for Accounts in this Auth Method.
	MinLoginNameLength uint32 `protobuf:"varint,10,opt,name=min_login_name_length,proto3" json:"min_login_name_length,omitempty" class:"public"` // @gotags: `class:"public"`
	// The minimum length allowed for passwords for Accounts in this Auth Method.
	MinPasswordLength uint32 `protobuf:"varint,20,opt,name=min_password_length,proto3" json:"min_password_length,omitempty" class:"public"` // @gotags: `class:"public"`
	// contains filtered or unexported fields
}

The attributes of a password typed auth method.

func (*PasswordAuthMethodAttributes) Descriptor deprecated 

func (*PasswordAuthMethodAttributes) Descriptor() ([]byte, []int)

Deprecated: Use PasswordAuthMethodAttributes.ProtoReflect.Descriptor instead.

func (*PasswordAuthMethodAttributes) GetMinLoginNameLength 

func (x *PasswordAuthMethodAttributes) GetMinLoginNameLength() uint32

func (*PasswordAuthMethodAttributes) GetMinPasswordLength 

func (x *PasswordAuthMethodAttributes) GetMinPasswordLength() uint32

func (*PasswordAuthMethodAttributes) ProtoMessage 

func (*PasswordAuthMethodAttributes) ProtoMessage()

func (*PasswordAuthMethodAttributes) ProtoReflect 

func (x *PasswordAuthMethodAttributes) ProtoReflect() protoreflect.Message

func (*PasswordAuthMethodAttributes) Reset 

func (x *PasswordAuthMethodAttributes) Reset()

func (*PasswordAuthMethodAttributes) String 

func (x *PasswordAuthMethodAttributes) String() string

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.