Documentation
¶
Index ¶
- Variables
- type Account
- func (*Account) Descriptor() ([]byte, []int)deprecated
- func (x *Account) GetAttributes() *structpb.Struct
- func (x *Account) GetAttrs() isAccount_Attrs
- func (x *Account) GetAuthMethodId() string
- func (x *Account) GetAuthorizedActions() []string
- func (x *Account) GetCreatedTime() *timestamppb.Timestamp
- func (x *Account) GetDescription() *wrapperspb.StringValue
- func (x *Account) GetId() string
- func (x *Account) GetLdapAccountAttributes() *LdapAccountAttributes
- func (x *Account) GetManagedGroupIds() []string
- func (x *Account) GetName() *wrapperspb.StringValue
- func (x *Account) GetOidcAccountAttributes() *OidcAccountAttributes
- func (x *Account) GetPasswordAccountAttributes() *PasswordAccountAttributes
- func (x *Account) GetScope() *scopes.ScopeInfo
- func (x *Account) GetType() string
- func (x *Account) GetUpdatedTime() *timestamppb.Timestamp
- func (x *Account) GetVersion() uint32
- func (*Account) ProtoMessage()
- func (x *Account) ProtoReflect() protoreflect.Message
- func (x *Account) Reset()
- func (x *Account) String() string
- type Account_Attributes
- type Account_LdapAccountAttributes
- type Account_OidcAccountAttributes
- type Account_PasswordAccountAttributes
- type LdapAccountAttributes
- func (*LdapAccountAttributes) Descriptor() ([]byte, []int)deprecated
- func (x *LdapAccountAttributes) GetDn() string
- func (x *LdapAccountAttributes) GetEmail() string
- func (x *LdapAccountAttributes) GetFullName() string
- func (x *LdapAccountAttributes) GetLoginName() string
- func (x *LdapAccountAttributes) GetMemberOfGroups() []string
- func (*LdapAccountAttributes) ProtoMessage()
- func (x *LdapAccountAttributes) ProtoReflect() protoreflect.Message
- func (x *LdapAccountAttributes) Reset()
- func (x *LdapAccountAttributes) String() string
- type OidcAccountAttributes
- func (*OidcAccountAttributes) Descriptor() ([]byte, []int)deprecated
- func (x *OidcAccountAttributes) GetEmail() string
- func (x *OidcAccountAttributes) GetFullName() string
- func (x *OidcAccountAttributes) GetIssuer() string
- func (x *OidcAccountAttributes) GetSubject() string
- func (x *OidcAccountAttributes) GetTokenClaims() *structpb.Struct
- func (x *OidcAccountAttributes) GetUserinfoClaims() *structpb.Struct
- func (*OidcAccountAttributes) ProtoMessage()
- func (x *OidcAccountAttributes) ProtoReflect() protoreflect.Message
- func (x *OidcAccountAttributes) Reset()
- func (x *OidcAccountAttributes) String() string
- type PasswordAccountAttributes
- func (*PasswordAccountAttributes) Descriptor() ([]byte, []int)deprecated
- func (x *PasswordAccountAttributes) GetLoginName() string
- func (x *PasswordAccountAttributes) GetPassword() *wrapperspb.StringValue
- func (*PasswordAccountAttributes) ProtoMessage()
- func (x *PasswordAccountAttributes) ProtoReflect() protoreflect.Message
- func (x *PasswordAccountAttributes) Reset()
- func (x *PasswordAccountAttributes) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_controller_api_resources_accounts_v1_account_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account struct {
// The ID of the account.
Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
// Scope information for the account.
Scope *scopes.ScopeInfo `protobuf:"bytes,20,opt,name=scope,proto3" json:"scope,omitempty"`
// Optional name for identification purposes.
Name *wrapperspb.StringValue `protobuf:"bytes,30,opt,name=name,proto3" json:"name,omitempty" class:"public"` // @gotags: `class:"public"`
// Optional user-set description for identification purposes.
Description *wrapperspb.StringValue `protobuf:"bytes,40,opt,name=description,proto3" json:"description,omitempty" class:"public"` // @gotags: `class:"public"`
// The time this resource was created.
CreatedTime *timestamppb.Timestamp `protobuf:"bytes,50,opt,name=created_time,proto3" json:"created_time,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
// The time this resource was last updated.
UpdatedTime *timestamppb.Timestamp `protobuf:"bytes,60,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 fails if the version does not match the latest known good version.
// Version is not required when you create an account.
Version uint32 `protobuf:"varint,70,opt,name=version,proto3" json:"version,omitempty" class:"public"` // @gotags: `class:"public"`
// The type of this account. If you do not set an account type, Boundary infers it from the type of the auth method.
Type string `protobuf:"bytes,80,opt,name=type,proto3" json:"type,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
// The ID of the auth method that is associated with this account.
AuthMethodId string `protobuf:"bytes,90,opt,name=auth_method_id,proto3" json:"auth_method_id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
// Types that are valid to be assigned to Attrs:
//
// *Account_Attributes
// *Account_PasswordAccountAttributes
// *Account_OidcAccountAttributes
// *Account_LdapAccountAttributes
Attrs isAccount_Attrs `protobuf_oneof:"attrs"`
// Indicates the IDs of the managed groups that currently contain this account
ManagedGroupIds []string `` // @gotags: `class:"public" eventstream:"observation"`
/* 130-byte string literal not displayed */
// 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"`
// contains filtered or unexported fields
}
Account contains all fields related to an account resource
func (*Account) Descriptor
deprecated
func (*Account) GetAttributes ¶
func (*Account) GetAuthMethodId ¶
func (*Account) GetAuthorizedActions ¶
func (*Account) GetCreatedTime ¶
func (x *Account) GetCreatedTime() *timestamppb.Timestamp
func (*Account) GetDescription ¶
func (x *Account) GetDescription() *wrapperspb.StringValue
func (*Account) GetLdapAccountAttributes ¶ added in v0.0.31
func (x *Account) GetLdapAccountAttributes() *LdapAccountAttributes
func (*Account) GetManagedGroupIds ¶
func (*Account) GetName ¶
func (x *Account) GetName() *wrapperspb.StringValue
func (*Account) GetOidcAccountAttributes ¶ added in v0.0.15
func (x *Account) GetOidcAccountAttributes() *OidcAccountAttributes
func (*Account) GetPasswordAccountAttributes ¶ added in v0.0.15
func (x *Account) GetPasswordAccountAttributes() *PasswordAccountAttributes
func (*Account) GetUpdatedTime ¶
func (x *Account) GetUpdatedTime() *timestamppb.Timestamp
func (*Account) GetVersion ¶
func (*Account) ProtoMessage ¶
func (*Account) ProtoMessage()
func (*Account) ProtoReflect ¶
func (x *Account) ProtoReflect() protoreflect.Message
type Account_Attributes ¶ added in v0.0.15
type Account_LdapAccountAttributes ¶ added in v0.0.31
type Account_LdapAccountAttributes struct {
LdapAccountAttributes *LdapAccountAttributes `protobuf:"bytes,103,opt,name=ldap_account_attributes,json=ldapAccountAttributes,proto3,oneof"`
}
type Account_OidcAccountAttributes ¶ added in v0.0.15
type Account_OidcAccountAttributes struct {
OidcAccountAttributes *OidcAccountAttributes `protobuf:"bytes,102,opt,name=oidc_account_attributes,json=oidcAccountAttributes,proto3,oneof"`
}
type Account_PasswordAccountAttributes ¶ added in v0.0.15
type Account_PasswordAccountAttributes struct {
PasswordAccountAttributes *PasswordAccountAttributes `protobuf:"bytes,101,opt,name=password_account_attributes,json=passwordAccountAttributes,proto3,oneof"`
}
type LdapAccountAttributes ¶ added in v0.0.31
type LdapAccountAttributes struct {
// login_name of the authenticated user. This is the login_name (or username)
// entered by the user when authenticating (typically the uid or cn
// attribute). Account login names must be lower case.
LoginName string `protobuf:"bytes,100,opt,name=login_name,proto3" json:"login_name,omitempty" class:"sensitive"` // @gotags: `class:"sensitive"`
// A string that maps to the name attribute for the
// authenticated user. This attribute is updated every time a user
// successfully authenticates.
FullName string `protobuf:"bytes,110,opt,name=full_name,proto3" json:"full_name,omitempty" class:"sensitive"` // @gotags: `class:"sensitive"`
// A string that maps to the email address attribute for
// the authenticated user. This attribute is updated every time a user
// successfully authenticates.
Email string `protobuf:"bytes,120,opt,name=email,proto3" json:"email,omitempty" class:"sensitive"` // @gotags: `class:"sensitive"`
// The distinguished name authenticated user's entry. Will
// be null until the user's first successful authentication. This attribute
// is updated every time a user successfully authenticates.
Dn string `protobuf:"bytes,130,opt,name=dn,proto3" json:"dn,omitempty" class:"public"` // @gotags: `class:"public"`
// The json marshalled groups the
// authenticated user is a member of. Will be null until the user's first
// successful authentication. This attribute is updated every time a user
// successfully authenticates.
MemberOfGroups []string `protobuf:"bytes,140,rep,name=member_of_groups,json=memberOfGroups,proto3" json:"member_of_groups,omitempty" class:"public"` // @gotags: `class:"public"`
// contains filtered or unexported fields
}
Attributes associated only with accounts with type "ldap".
func (*LdapAccountAttributes) Descriptor
deprecated
added in
v0.0.31
func (*LdapAccountAttributes) Descriptor() ([]byte, []int)
Deprecated: Use LdapAccountAttributes.ProtoReflect.Descriptor instead.
func (*LdapAccountAttributes) GetDn ¶ added in v0.0.31
func (x *LdapAccountAttributes) GetDn() string
func (*LdapAccountAttributes) GetEmail ¶ added in v0.0.31
func (x *LdapAccountAttributes) GetEmail() string
func (*LdapAccountAttributes) GetFullName ¶ added in v0.0.31
func (x *LdapAccountAttributes) GetFullName() string
func (*LdapAccountAttributes) GetLoginName ¶ added in v0.0.31
func (x *LdapAccountAttributes) GetLoginName() string
func (*LdapAccountAttributes) GetMemberOfGroups ¶ added in v0.0.31
func (x *LdapAccountAttributes) GetMemberOfGroups() []string
func (*LdapAccountAttributes) ProtoMessage ¶ added in v0.0.31
func (*LdapAccountAttributes) ProtoMessage()
func (*LdapAccountAttributes) ProtoReflect ¶ added in v0.0.31
func (x *LdapAccountAttributes) ProtoReflect() protoreflect.Message
func (*LdapAccountAttributes) Reset ¶ added in v0.0.31
func (x *LdapAccountAttributes) Reset()
func (*LdapAccountAttributes) String ¶ added in v0.0.31
func (x *LdapAccountAttributes) String() string
type OidcAccountAttributes ¶
type OidcAccountAttributes struct {
// issuer is a case sensitive URL that maps to the OIDC iss claim.
// This value is immutable after creation time.
Issuer string `protobuf:"bytes,80,opt,name=issuer,proto3" json:"issuer,omitempty" class:"public"` // @gotags: `class:"public"`
// subject is a case sensitive string that maps to the OIDC sub claim.
// This value is immutable after creation time.
Subject string `protobuf:"bytes,90,opt,name=subject,proto3" json:"subject,omitempty" class:"public"` // @gotags: `class:"public"`
// A string that maps to the OIDC name claim.
FullName string `protobuf:"bytes,100,opt,name=full_name,proto3" json:"full_name,omitempty" class:"public"` // @gotags: `class:"public"`
// A string that maps to the OIDC email claim.
Email string `protobuf:"bytes,110,opt,name=email,proto3" json:"email,omitempty" class:"public"` // @gotags: `class:"public"`
// The marshaled claims from the token.
TokenClaims *structpb.Struct `protobuf:"bytes,120,opt,name=token_claims,json=tokenClaims,proto3" json:"token_claims,omitempty"`
// The marshaled claims from userinfo.
UserinfoClaims *structpb.Struct `protobuf:"bytes,130,opt,name=userinfo_claims,json=userinfoClaims,proto3" json:"userinfo_claims,omitempty"`
// contains filtered or unexported fields
}
Attributes associated only with accounts with type "oidc".
func (*OidcAccountAttributes) Descriptor
deprecated
func (*OidcAccountAttributes) Descriptor() ([]byte, []int)
Deprecated: Use OidcAccountAttributes.ProtoReflect.Descriptor instead.
func (*OidcAccountAttributes) GetEmail ¶
func (x *OidcAccountAttributes) GetEmail() string
func (*OidcAccountAttributes) GetFullName ¶
func (x *OidcAccountAttributes) GetFullName() string
func (*OidcAccountAttributes) GetIssuer ¶
func (x *OidcAccountAttributes) GetIssuer() string
func (*OidcAccountAttributes) GetSubject ¶
func (x *OidcAccountAttributes) GetSubject() string
func (*OidcAccountAttributes) GetTokenClaims ¶
func (x *OidcAccountAttributes) GetTokenClaims() *structpb.Struct
func (*OidcAccountAttributes) GetUserinfoClaims ¶
func (x *OidcAccountAttributes) GetUserinfoClaims() *structpb.Struct
func (*OidcAccountAttributes) ProtoMessage ¶
func (*OidcAccountAttributes) ProtoMessage()
func (*OidcAccountAttributes) ProtoReflect ¶
func (x *OidcAccountAttributes) ProtoReflect() protoreflect.Message
func (*OidcAccountAttributes) Reset ¶
func (x *OidcAccountAttributes) Reset()
func (*OidcAccountAttributes) String ¶
func (x *OidcAccountAttributes) String() string
type PasswordAccountAttributes ¶
type PasswordAccountAttributes struct {
// The login name of this account. This is unique per auth method.
LoginName string `protobuf:"bytes,10,opt,name=login_name,proto3" json:"login_name,omitempty" class:"sensitive"` // @gotags: `class:"sensitive"`
// The password for this account.
Password *wrapperspb.StringValue `protobuf:"bytes,20,opt,name=password,proto3" json:"password,omitempty" class:"secret"` // @gotags: `class:"secret"`
// contains filtered or unexported fields
}
Attributes associated only with accounts with type "password".
func (*PasswordAccountAttributes) Descriptor
deprecated
func (*PasswordAccountAttributes) Descriptor() ([]byte, []int)
Deprecated: Use PasswordAccountAttributes.ProtoReflect.Descriptor instead.
func (*PasswordAccountAttributes) GetLoginName ¶
func (x *PasswordAccountAttributes) GetLoginName() string
func (*PasswordAccountAttributes) GetPassword ¶
func (x *PasswordAccountAttributes) GetPassword() *wrapperspb.StringValue
func (*PasswordAccountAttributes) ProtoMessage ¶
func (*PasswordAccountAttributes) ProtoMessage()
func (*PasswordAccountAttributes) ProtoReflect ¶
func (x *PasswordAccountAttributes) ProtoReflect() protoreflect.Message
func (*PasswordAccountAttributes) Reset ¶
func (x *PasswordAccountAttributes) Reset()
func (*PasswordAccountAttributes) String ¶
func (x *PasswordAccountAttributes) String() string
Click to show internal directories.
Click to hide internal directories.