Documentation
¶
Index ¶
- func NewDomainInfoBlock() block.Block
- type Domain
- type DomainInfo
- func (m *DomainInfo) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *DomainInfo) CloneVT() *DomainInfo
- func (this *DomainInfo) EqualMessageVT(thatMsg any) bool
- func (this *DomainInfo) EqualVT(that *DomainInfo) bool
- func (d *DomainInfo) FilterValue() string
- func (x *DomainInfo) GetDescription() string
- func (x *DomainInfo) GetDomainId() string
- func (x *DomainInfo) GetName() string
- func (d *DomainInfo) MarshalBlock() ([]byte, error)
- func (x *DomainInfo) MarshalJSON() ([]byte, error)
- func (x *DomainInfo) MarshalProtoJSON(s *json.MarshalState)
- func (x *DomainInfo) MarshalProtoText() string
- func (m *DomainInfo) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *DomainInfo) MarshalToVT(dAtA []byte) (int, error)
- func (m *DomainInfo) MarshalVT() (dAtA []byte, err error)
- func (*DomainInfo) ProtoMessage()
- func (x *DomainInfo) Reset()
- func (m *DomainInfo) SizeVT() (n int)
- func (x *DomainInfo) String() string
- func (d *DomainInfo) UnmarshalBlock(data []byte) error
- func (x *DomainInfo) UnmarshalJSON(b []byte) error
- func (x *DomainInfo) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *DomainInfo) UnmarshalVT(dAtA []byte) error
- func (d *DomainInfo) Validate() error
- type Handler
- type LookupIdentityDomain
- type LookupIdentityDomainValue
- type SelectIdentityDomain
- type SelectIdentityDomainValue
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewDomainInfoBlock ¶
NewDomainInfoBlock constructs a new Entity block
Types ¶
type Domain ¶
type Domain interface {
// GetDomainInfo returns the domain info object.
GetDomainInfo() *DomainInfo
// Execute executes the domain controller.
// Return nil to exit.
// Returning an error re-constructs the domain controller.
Execute(ctx context.Context) error
// IdentityLookupEntity implements the IdentityLookupEntity directive.
IdentityLookupEntity(
ctx context.Context,
dir identity.IdentityLookupEntity,
) (identity.IdentityLookupEntityValue, error)
// Close closes any resources for the domain.
Close()
}
Domain is a identity domain implementation.
type DomainInfo ¶
type DomainInfo struct {
// DomainId is the domain identifier.
// (not human readable)
DomainId string `protobuf:"bytes,1,opt,name=domain_id,json=domainId,proto3" json:"domainId,omitempty"`
// Name is the domain name to render (title).
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// Description is the short description to show.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
DomainInfo contains information about the domain to show the user.
func UnmarshalDomainInfo ¶
UnmarshalDomainInfo unmarshals a DomainInfo from a cursor. If empty, returns nil, nil
func (*DomainInfo) CloneMessageVT ¶
func (m *DomainInfo) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*DomainInfo) CloneVT ¶
func (m *DomainInfo) CloneVT() *DomainInfo
func (*DomainInfo) EqualMessageVT ¶
func (this *DomainInfo) EqualMessageVT(thatMsg any) bool
func (*DomainInfo) EqualVT ¶
func (this *DomainInfo) EqualVT(that *DomainInfo) bool
func (*DomainInfo) FilterValue ¶
func (d *DomainInfo) FilterValue() string
Filter value is the value we use when filtering against this item when we're filtering the list.
func (*DomainInfo) GetDescription ¶
func (x *DomainInfo) GetDescription() string
func (*DomainInfo) GetDomainId ¶
func (x *DomainInfo) GetDomainId() string
func (*DomainInfo) GetName ¶
func (x *DomainInfo) GetName() string
func (*DomainInfo) MarshalBlock ¶
func (d *DomainInfo) MarshalBlock() ([]byte, error)
MarshalBlock marshals the block to binary. This is the initial step of marshaling, before transformations.
func (*DomainInfo) MarshalJSON ¶
func (x *DomainInfo) MarshalJSON() ([]byte, error)
MarshalJSON marshals the DomainInfo to JSON.
func (*DomainInfo) MarshalProtoJSON ¶
func (x *DomainInfo) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals the DomainInfo message to JSON.
func (*DomainInfo) MarshalProtoText ¶
func (x *DomainInfo) MarshalProtoText() string
func (*DomainInfo) MarshalToSizedBufferVT ¶
func (m *DomainInfo) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*DomainInfo) MarshalToVT ¶
func (m *DomainInfo) MarshalToVT(dAtA []byte) (int, error)
func (*DomainInfo) MarshalVT ¶
func (m *DomainInfo) MarshalVT() (dAtA []byte, err error)
func (*DomainInfo) ProtoMessage ¶
func (*DomainInfo) ProtoMessage()
func (*DomainInfo) Reset ¶
func (x *DomainInfo) Reset()
func (*DomainInfo) SizeVT ¶
func (m *DomainInfo) SizeVT() (n int)
func (*DomainInfo) String ¶
func (x *DomainInfo) String() string
func (*DomainInfo) UnmarshalBlock ¶
func (d *DomainInfo) UnmarshalBlock(data []byte) error
UnmarshalBlock unmarshals the block to the object. This is the final step of decoding, after transformations.
func (*DomainInfo) UnmarshalJSON ¶
func (x *DomainInfo) UnmarshalJSON(b []byte) error
UnmarshalJSON unmarshals the DomainInfo from JSON.
func (*DomainInfo) UnmarshalProtoJSON ¶
func (x *DomainInfo) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals the DomainInfo message from JSON.
func (*DomainInfo) UnmarshalVT ¶
func (m *DomainInfo) UnmarshalVT(dAtA []byte) error
func (*DomainInfo) Validate ¶
func (d *DomainInfo) Validate() error
Validate validates the domain info.
type Handler ¶
type Handler any
Handler handles callbacks from the domain usually implemented by the domain controller
type LookupIdentityDomain ¶
type LookupIdentityDomain interface {
// Directive indicates this is a directive.
directive.Directive
// LookupIdentityDomainId filters by domain id.
// Can be empty.
LookupIdentityDomainId() string
}
LookupIdentityDomain looks up all available DomainInfo.
func NewLookupIdentityDomain ¶
func NewLookupIdentityDomain(domainID string) LookupIdentityDomain
NewLookupIdentityDomain constructs a new LookupIdentityDomain directive.
type LookupIdentityDomainValue ¶
type LookupIdentityDomainValue = *DomainInfo
LookupIdentityDomainValue is the result of the LookupIdentityDomain directive.
type SelectIdentityDomain ¶
type SelectIdentityDomain interface {
// Directive indicates this is a directive.
directive.Directive
// SelectIdentityDomainPurpose is the purpose of the SelectIdentityDomain.
// Current: "auth"
SelectIdentityDomainPurpose() string
}
SelectIdentityDomain asks the user to select an identity domain.
func NewSelectIdentityDomain ¶
func NewSelectIdentityDomain(purpose string) SelectIdentityDomain
NewSelectIdentityDomain constructs a new SelectIdentityDomain directive.
type SelectIdentityDomainValue ¶
type SelectIdentityDomainValue = *DomainInfo
SelectIdentityDomainValue is the result of the SelectIdentityDomain directive.
func ExSelectIdentityDomain ¶
func ExSelectIdentityDomain(ctx context.Context, b bus.Bus, purpose string) (SelectIdentityDomainValue, error)
ExSelectIdentityDomain executes the select entity domain directive.