authmethods

package
v0.5.1 Latest Latest
Warning

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

 Go to latest Published: Aug 19, 2021 License: MPL-2.0 Imports: 9 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"`
	// 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"`
	// 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"`
	// Optional user-set description for identification purposes.
	Description *wrapperspb.StringValue `protobuf:"bytes,50,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The time this resource was created.
	CreatedTime *timestamppb.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty"`
	// Output only. The time this resource was last updated.
	UpdatedTime *timestamppb.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
	// 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"`
	// The Auth Method type.
	Type string `protobuf:"bytes,90,opt,name=type,proto3" json:"type,omitempty"`
	// The attributes that are applicable for the specific Auth Method type.
	Attributes *structpb.Struct `protobuf:"bytes,100,opt,name=attributes,proto3" json:"attributes,omitempty"`
	// 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"`
	// 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"`
	// Output only. The authorized actions for the scope's collections.
	AuthorizedCollectionActions map[string]*structpb.ListValue `` /* 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) GetAuthorizedActions added in v0.1.5 

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

func (*AuthMethod) GetAuthorizedCollectionActions added in v0.1.5 

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 added in v0.2.0 

func (x *AuthMethod) GetIsPrimary() bool

func (*AuthMethod) GetName 

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

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

type OidcAuthMethodAttributes added in v0.2.0 

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"`
	// 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"`
	// 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"`
	// Input only. The client's secret.
	ClientSecret *wrapperspb.StringValue `protobuf:"bytes,40,opt,name=client_secret,proto3" json:"client_secret,omitempty"`
	// 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"`
	// 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"`
	// The signing algorithms allowed for the auth method.
	SigningAlgorithms []string `protobuf:"bytes,70,rep,name=signing_algorithms,proto3" json:"signing_algorithms,omitempty"`
	// 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"`
	// 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"`
	// 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"`
	// Allowed audience claims for this auth method.
	AllowedAudiences []string `protobuf:"bytes,110,rep,name=allowed_audiences,proto3" json:"allowed_audiences,omitempty"`
	// 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"`
	// 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"`
	// 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 `` /* 128-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"`
	// contains filtered or unexported fields
}

The attributes of an OIDC typed auth method.

func (*OidcAuthMethodAttributes) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use OidcAuthMethodAttributes.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAttributes) GetAccountClaimMaps added in v0.2.1 

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

func (*OidcAuthMethodAttributes) GetAllowedAudiences added in v0.2.0 

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

func (*OidcAuthMethodAttributes) GetApiUrlPrefix added in v0.2.0 

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

func (*OidcAuthMethodAttributes) GetCallbackUrl added in v0.2.0 

func (x *OidcAuthMethodAttributes) GetCallbackUrl() string

func (*OidcAuthMethodAttributes) GetClaimsScopes added in v0.2.1 

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

func (*OidcAuthMethodAttributes) GetClientId added in v0.2.0 

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

func (*OidcAuthMethodAttributes) GetClientSecret added in v0.2.0 

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

func (*OidcAuthMethodAttributes) GetClientSecretHmac added in v0.2.0 

func (x *OidcAuthMethodAttributes) GetClientSecretHmac() string

func (*OidcAuthMethodAttributes) GetDisableDiscoveredConfigValidation added in v0.2.0 

func (x *OidcAuthMethodAttributes) GetDisableDiscoveredConfigValidation() bool

func (*OidcAuthMethodAttributes) GetDryRun added in v0.2.0 

func (x *OidcAuthMethodAttributes) GetDryRun() bool

func (*OidcAuthMethodAttributes) GetIdpCaCerts added in v0.2.0 

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

func (*OidcAuthMethodAttributes) GetIssuer added in v0.2.0 

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

func (*OidcAuthMethodAttributes) GetMaxAge added in v0.2.0 

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

func (*OidcAuthMethodAttributes) GetSigningAlgorithms added in v0.2.0 

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

func (*OidcAuthMethodAttributes) GetState added in v0.2.0 

func (x *OidcAuthMethodAttributes) GetState() string

func (*OidcAuthMethodAttributes) ProtoMessage added in v0.2.0 

func (*OidcAuthMethodAttributes) ProtoMessage()

func (*OidcAuthMethodAttributes) ProtoReflect added in v0.2.0 

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

func (*OidcAuthMethodAttributes) Reset added in v0.2.0 

func (x *OidcAuthMethodAttributes) Reset()

func (*OidcAuthMethodAttributes) String added in v0.2.0 

func (x *OidcAuthMethodAttributes) String() string

type OidcAuthMethodAuthenticateCallbackRequest added in v0.2.0 

type OidcAuthMethodAuthenticateCallbackRequest struct {

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

The structure of OIDC callback request parameters

func (*OidcAuthMethodAuthenticateCallbackRequest) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use OidcAuthMethodAuthenticateCallbackRequest.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateCallbackRequest) GetCode added in v0.2.0 

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetCode() string

func (*OidcAuthMethodAuthenticateCallbackRequest) GetError added in v0.2.0 

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetError() string

func (*OidcAuthMethodAuthenticateCallbackRequest) GetErrorDescription added in v0.2.0 

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetErrorDescription() string

func (*OidcAuthMethodAuthenticateCallbackRequest) GetErrorUri added in v0.2.0 

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetErrorUri() string

func (*OidcAuthMethodAuthenticateCallbackRequest) GetState added in v0.2.0 

func (x *OidcAuthMethodAuthenticateCallbackRequest) GetState() string

func (*OidcAuthMethodAuthenticateCallbackRequest) ProtoMessage added in v0.2.0 

func (*OidcAuthMethodAuthenticateCallbackRequest) ProtoMessage()

func (*OidcAuthMethodAuthenticateCallbackRequest) ProtoReflect added in v0.2.0 

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

func (*OidcAuthMethodAuthenticateCallbackRequest) Reset added in v0.2.0 

func (x *OidcAuthMethodAuthenticateCallbackRequest) Reset()

func (*OidcAuthMethodAuthenticateCallbackRequest) String added in v0.2.0 

func (x *OidcAuthMethodAuthenticateCallbackRequest) String() string

type OidcAuthMethodAuthenticateCallbackResponse added in v0.2.0 

type OidcAuthMethodAuthenticateCallbackResponse struct {

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

The structure of OIDC callback response parameters

func (*OidcAuthMethodAuthenticateCallbackResponse) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use OidcAuthMethodAuthenticateCallbackResponse.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateCallbackResponse) GetFinalRedirectUrl added in v0.2.0 

func (x *OidcAuthMethodAuthenticateCallbackResponse) GetFinalRedirectUrl() string

func (*OidcAuthMethodAuthenticateCallbackResponse) ProtoMessage added in v0.2.0 

func (*OidcAuthMethodAuthenticateCallbackResponse) ProtoMessage()

func (*OidcAuthMethodAuthenticateCallbackResponse) ProtoReflect added in v0.2.0 

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

func (*OidcAuthMethodAuthenticateCallbackResponse) Reset added in v0.2.0 

func (x *OidcAuthMethodAuthenticateCallbackResponse) Reset()

func (*OidcAuthMethodAuthenticateCallbackResponse) String added in v0.2.0 

func (x *OidcAuthMethodAuthenticateCallbackResponse) String() string

type OidcAuthMethodAuthenticateStartResponse added in v0.2.0 

type OidcAuthMethodAuthenticateStartResponse struct {

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

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

func (*OidcAuthMethodAuthenticateStartResponse) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use OidcAuthMethodAuthenticateStartResponse.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateStartResponse) GetAuthUrl added in v0.2.0 

func (x *OidcAuthMethodAuthenticateStartResponse) GetAuthUrl() string

func (*OidcAuthMethodAuthenticateStartResponse) GetTokenId added in v0.2.0 

func (x *OidcAuthMethodAuthenticateStartResponse) GetTokenId() string

func (*OidcAuthMethodAuthenticateStartResponse) ProtoMessage added in v0.2.0 

func (*OidcAuthMethodAuthenticateStartResponse) ProtoMessage()

func (*OidcAuthMethodAuthenticateStartResponse) ProtoReflect added in v0.2.0 

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

func (*OidcAuthMethodAuthenticateStartResponse) Reset added in v0.2.0 

func (x *OidcAuthMethodAuthenticateStartResponse) Reset()

func (*OidcAuthMethodAuthenticateStartResponse) String added in v0.2.0 

func (x *OidcAuthMethodAuthenticateStartResponse) String() string

type OidcAuthMethodAuthenticateTokenRequest added in v0.2.0 

type OidcAuthMethodAuthenticateTokenRequest struct {

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

The structure of OIDC token request parameters

func (*OidcAuthMethodAuthenticateTokenRequest) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use OidcAuthMethodAuthenticateTokenRequest.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateTokenRequest) GetTokenId added in v0.2.0 

func (x *OidcAuthMethodAuthenticateTokenRequest) GetTokenId() string

func (*OidcAuthMethodAuthenticateTokenRequest) ProtoMessage added in v0.2.0 

func (*OidcAuthMethodAuthenticateTokenRequest) ProtoMessage()

func (*OidcAuthMethodAuthenticateTokenRequest) ProtoReflect added in v0.2.0 

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

func (*OidcAuthMethodAuthenticateTokenRequest) Reset added in v0.2.0 

func (x *OidcAuthMethodAuthenticateTokenRequest) Reset()

func (*OidcAuthMethodAuthenticateTokenRequest) String added in v0.2.0 

func (x *OidcAuthMethodAuthenticateTokenRequest) String() string

type OidcAuthMethodAuthenticateTokenResponse added in v0.2.0 

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"`
	// contains filtered or unexported fields
}

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

func (*OidcAuthMethodAuthenticateTokenResponse) Descriptor deprecated added in v0.2.0 

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

Deprecated: Use OidcAuthMethodAuthenticateTokenResponse.ProtoReflect.Descriptor instead.

func (*OidcAuthMethodAuthenticateTokenResponse) GetStatus added in v0.2.0 

func (x *OidcAuthMethodAuthenticateTokenResponse) GetStatus() string

func (*OidcAuthMethodAuthenticateTokenResponse) ProtoMessage added in v0.2.0 

func (*OidcAuthMethodAuthenticateTokenResponse) ProtoMessage()

func (*OidcAuthMethodAuthenticateTokenResponse) ProtoReflect added in v0.2.0 

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

func (*OidcAuthMethodAuthenticateTokenResponse) Reset added in v0.2.0 

func (x *OidcAuthMethodAuthenticateTokenResponse) Reset()

func (*OidcAuthMethodAuthenticateTokenResponse) String added in v0.2.0 

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"`
	// 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"`
	// 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.