entity

package

v0.3.6 Latest Latest Go to latest Published: May 27, 2025 License: BSD-3-Clause-Clear Imports: 6 Imported by: 5

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/opentdf/platform

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Entity_Category_name = map[int32]string{
		0: "CATEGORY_UNSPECIFIED",
		1: "CATEGORY_SUBJECT",
		2: "CATEGORY_ENVIRONMENT",
	}
	Entity_Category_value = map[string]int32{
		"CATEGORY_UNSPECIFIED": 0,
		"CATEGORY_SUBJECT":     1,
		"CATEGORY_ENVIRONMENT": 2,
	}
)

Enum value maps for Entity_Category.

View Source

var File_entity_entity_proto protoreflect.FileDescriptor

Functions ¶

This section is empty.

Types ¶

type Entity ¶

type Entity struct {

	// ephemeral id for tracking between request and response
	EphemeralId string `protobuf:"bytes,1,opt,name=ephemeral_id,json=ephemeralId,proto3" json:"ephemeral_id,omitempty"`
	// Standard entity types supported by the platform, one of which must be set
	//
	// Types that are assignable to EntityType:
	//
	//	*Entity_EmailAddress
	//	*Entity_UserName
	//	*Entity_Claims
	//	*Entity_ClientId
	EntityType isEntity_EntityType `protobuf_oneof:"entity_type"`
	Category   Entity_Category     `protobuf:"varint,11,opt,name=category,proto3,enum=entity.Entity_Category" json:"category,omitempty"`
	// contains filtered or unexported fields
}

PE (Person Entity) or NPE (Non-Person Entity)

func (*Entity) Descriptor deprecated

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

Deprecated: Use Entity.ProtoReflect.Descriptor instead.

func (*Entity) GetCategory ¶

func (x *Entity) GetCategory() Entity_Category

func (*Entity) GetClaims ¶

func (x *Entity) GetClaims() *anypb.Any

func (*Entity) GetClientId ¶

func (x *Entity) GetClientId() string

func (*Entity) GetEmailAddress ¶

func (x *Entity) GetEmailAddress() string

func (*Entity) GetEntityType ¶

func (m *Entity) GetEntityType() isEntity_EntityType

func (*Entity) GetEphemeralId ¶

func (x *Entity) GetEphemeralId() string

func (*Entity) GetUserName ¶

func (x *Entity) GetUserName() string

func (*Entity) ProtoMessage ¶

func (*Entity) ProtoMessage()

func (*Entity) ProtoReflect ¶

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

func (*Entity) Reset ¶

func (x *Entity) Reset()

func (*Entity) String ¶

func (x *Entity) String() string

type EntityChain ¶

type EntityChain struct {

	// ephemeral id for tracking between request and response
	EphemeralId string    `protobuf:"bytes,1,opt,name=ephemeral_id,json=ephemeralId,proto3" json:"ephemeral_id,omitempty"`
	Entities    []*Entity `protobuf:"bytes,2,rep,name=entities,proto3" json:"entities,omitempty"`
	// contains filtered or unexported fields
}

A set of related PE and NPE

func (*EntityChain) Descriptor deprecated

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

Deprecated: Use EntityChain.ProtoReflect.Descriptor instead.

func (*EntityChain) GetEntities ¶

func (x *EntityChain) GetEntities() []*Entity

func (*EntityChain) GetEphemeralId ¶

func (x *EntityChain) GetEphemeralId() string

func (*EntityChain) ProtoMessage ¶

func (*EntityChain) ProtoMessage()

func (*EntityChain) ProtoReflect ¶

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

func (*EntityChain) Reset ¶

func (x *EntityChain) Reset()

func (*EntityChain) String ¶

func (x *EntityChain) String() string

type Entity_Category ¶

type Entity_Category int32

const (
	Entity_CATEGORY_UNSPECIFIED Entity_Category = 0
	Entity_CATEGORY_SUBJECT     Entity_Category = 1
	Entity_CATEGORY_ENVIRONMENT Entity_Category = 2
)

func (Entity_Category) Descriptor ¶

func (Entity_Category) Descriptor() protoreflect.EnumDescriptor

func (Entity_Category) Enum ¶

func (x Entity_Category) Enum() *Entity_Category

func (Entity_Category) EnumDescriptor deprecated

func (Entity_Category) EnumDescriptor() ([]byte, []int)

Deprecated: Use Entity_Category.Descriptor instead.

func (Entity_Category) Number ¶

func (x Entity_Category) Number() protoreflect.EnumNumber

func (Entity_Category) String ¶

func (x Entity_Category) String() string

func (Entity_Category) Type ¶

func (Entity_Category) Type() protoreflect.EnumType

type Entity_Claims ¶

type Entity_Claims struct {
	// used by ERS claims mode
	Claims *anypb.Any `protobuf:"bytes,4,opt,name=claims,proto3,oneof"`
}

type Entity_ClientId ¶

type Entity_ClientId struct {
	ClientId string `protobuf:"bytes,5,opt,name=client_id,json=clientId,proto3,oneof"`
}

type Entity_EmailAddress ¶

type Entity_EmailAddress struct {
	EmailAddress string `protobuf:"bytes,2,opt,name=email_address,json=emailAddress,proto3,oneof"`
}

type Entity_UserName ¶

type Entity_UserName struct {
	UserName string `protobuf:"bytes,3,opt,name=user_name,json=userName,proto3,oneof"`
}

type Token ¶

type Token struct {

	// ephemeral id for tracking between request and response
	EphemeralId string `protobuf:"bytes,1,opt,name=ephemeral_id,json=ephemeralId,proto3" json:"ephemeral_id,omitempty"`
	// the token
	Jwt string `protobuf:"bytes,2,opt,name=jwt,proto3" json:"jwt,omitempty"`
	// contains filtered or unexported fields
}

func (*Token) Descriptor deprecated

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

Deprecated: Use Token.ProtoReflect.Descriptor instead.

func (*Token) GetEphemeralId ¶

func (x *Token) GetEphemeralId() string

func (*Token) GetJwt ¶

func (x *Token) GetJwt() string

func (*Token) ProtoMessage ¶

func (*Token) ProtoMessage()

func (*Token) ProtoReflect ¶

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

func (*Token) Reset ¶

func (x *Token) Reset()

func (*Token) String ¶

func (x *Token) String() string

Source Files ¶

View all Source files

entity.pb.go

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