authmethods

package
v0.0.18 Latest Latest
Warning

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

Go to latest
Published: Aug 5, 2022 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"` // @gotags: `class:"public"`
	// 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"` // @gotags: `class:"public"`
	// 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"` // @gotags: `class:"public"`
	// 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"` // @gotags: `class:"public"`
	// 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"` // @gotags: `class:"public"`
	// Types that are assignable to Attrs:
	//	*AuthMethod_Attributes
	//	*AuthMethod_PasswordAuthMethodAttributes
	//	*AuthMethod_OidcAuthMethodsAttributes
	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"` // @gotags: `class:"public"`
	// 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) 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_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 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 (*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 (*OidcAuthMethodAttributes) GetMaxAge

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 (*OidcAuthMethodAuthenticateCallbackRequest) GetError

func (*OidcAuthMethodAuthenticateCallbackRequest) GetErrorDescription

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetErrorDescription() string

func (*OidcAuthMethodAuthenticateCallbackRequest) GetErrorUri

func (*OidcAuthMethodAuthenticateCallbackRequest) GetState

func (*OidcAuthMethodAuthenticateCallbackRequest) ProtoMessage

func (*OidcAuthMethodAuthenticateCallbackRequest) ProtoReflect

func (*OidcAuthMethodAuthenticateCallbackRequest) Reset

func (*OidcAuthMethodAuthenticateCallbackRequest) 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

Deprecated: Use OidcAuthMethodAuthenticateCallbackResponse.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateCallbackResponse) GetFinalRedirectUrl

func (x *OidcAuthMethodAuthenticateCallbackResponse) GetFinalRedirectUrl() string

func (*OidcAuthMethodAuthenticateCallbackResponse) ProtoMessage

func (*OidcAuthMethodAuthenticateCallbackResponse) ProtoReflect

func (*OidcAuthMethodAuthenticateCallbackResponse) Reset

func (*OidcAuthMethodAuthenticateCallbackResponse) 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 (*OidcAuthMethodAuthenticateStartResponse) GetTokenId

func (*OidcAuthMethodAuthenticateStartResponse) ProtoMessage

func (*OidcAuthMethodAuthenticateStartResponse) ProtoReflect

func (*OidcAuthMethodAuthenticateStartResponse) Reset

func (*OidcAuthMethodAuthenticateStartResponse) 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 (*OidcAuthMethodAuthenticateTokenRequest) ProtoMessage

func (*OidcAuthMethodAuthenticateTokenRequest) ProtoReflect

func (*OidcAuthMethodAuthenticateTokenRequest) Reset

func (*OidcAuthMethodAuthenticateTokenRequest) 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 (*OidcAuthMethodAuthenticateTokenResponse) ProtoMessage

func (*OidcAuthMethodAuthenticateTokenResponse) ProtoReflect

func (*OidcAuthMethodAuthenticateTokenResponse) Reset

func (*OidcAuthMethodAuthenticateTokenResponse) 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 (*PasswordAuthMethodAttributes) Reset

func (x *PasswordAuthMethodAttributes) Reset()

func (*PasswordAuthMethodAttributes) String

Jump to

Keyboard shortcuts

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