schema

package
v0.31.3 Latest Latest
Warning

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

 Go to latest Published: Apr 10, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	IdentityKind_name = map[int32]string{
		0: "IDENTITY_KIND_UNKNOWN",
		1: "IDENTITY_KIND_PID",
		2: "IDENTITY_KIND_EMAIL",
		3: "IDENTITY_KIND_USERNAME",
		4: "IDENTITY_KIND_DN",
		5: "IDENTITY_KIND_PHONE",
		6: "IDENTITY_KIND_EMPID",
	}
	IdentityKind_value = map[string]int32{
		"IDENTITY_KIND_UNKNOWN":  0,
		"IDENTITY_KIND_PID":      1,
		"IDENTITY_KIND_EMAIL":    2,
		"IDENTITY_KIND_USERNAME": 3,
		"IDENTITY_KIND_DN":       4,
		"IDENTITY_KIND_PHONE":    5,
		"IDENTITY_KIND_EMPID":    6,
	}
)

Enum value maps for IdentityKind.

View Source 
var (
	TenantKind_name = map[int32]string{
		0: "TENANT_KIND_UNKNOWN",
		1: "TENANT_KIND_ORGANIZATION",
		2: "TENANT_KIND_ACCOUNT",
	}
	TenantKind_value = map[string]int32{
		"TENANT_KIND_UNKNOWN":      0,
		"TENANT_KIND_ORGANIZATION": 1,
		"TENANT_KIND_ACCOUNT":      2,
	}
)

Enum value maps for TenantKind.

View Source 
var (
	UserStatus_name = map[int32]string{
		0: "USER_STATUS_UNKNOWN",
		1: "USER_STATUS_STAGED",
		2: "USER_STATUS_PROVISIONED",
		3: "USER_STATUS_ACTIVE",
		4: "USER_STATUS_RECOVERY",
		5: "USER_STATUS_PASSWORD_EXPIRED",
		6: "USER_STATUS_LOCKED_OUT",
		7: "USER_STATUS_SUSPENDED",
		8: "USER_STATUS_DEPROVISIONED",
	}
	UserStatus_value = map[string]int32{
		"USER_STATUS_UNKNOWN":          0,
		"USER_STATUS_STAGED":           1,
		"USER_STATUS_PROVISIONED":      2,
		"USER_STATUS_ACTIVE":           3,
		"USER_STATUS_RECOVERY":         4,
		"USER_STATUS_PASSWORD_EXPIRED": 5,
		"USER_STATUS_LOCKED_OUT":       6,
		"USER_STATUS_SUSPENDED":        7,
		"USER_STATUS_DEPROVISIONED":    8,
	}
)

Enum value maps for UserStatus.

View Source 
var File_aserto_directory_schema_v3_group_proto protoreflect.FileDescriptor
View Source 
var File_aserto_directory_schema_v3_identity_proto protoreflect.FileDescriptor
View Source 
var File_aserto_directory_schema_v3_tenant_proto protoreflect.FileDescriptor
View Source 
var File_aserto_directory_schema_v3_user_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AccountProperties 

type AccountProperties struct {

	// Maximum number of organizations that can be created in this account.
	// If -1, there is no limit.
	MaxOrgs int32 `protobuf:"varint,1,opt,name=max_orgs,json=maxOrgs,proto3" json:"max_orgs,omitempty"`
	// Tracks the account owner's progress through the getting-started guide.
	GettingStarted *GuideState `protobuf:"bytes,3,opt,name=getting_started,json=gettingStarted,proto3,oneof" json:"getting_started,omitempty"`
	// The default organization for the account
	DefaultTenantId string `protobuf:"bytes,4,opt,name=default_tenant_id,json=defaultTenantId,proto3" json:"default_tenant_id,omitempty"`
	// contains filtered or unexported fields
}

func (*AccountProperties) Descriptor deprecated 

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

Deprecated: Use AccountProperties.ProtoReflect.Descriptor instead.

func (*AccountProperties) GetDefaultTenantId 

func (x *AccountProperties) GetDefaultTenantId() string

func (*AccountProperties) GetGettingStarted 

func (x *AccountProperties) GetGettingStarted() *GuideState

func (*AccountProperties) GetMaxOrgs 

func (x *AccountProperties) GetMaxOrgs() int32

func (*AccountProperties) ProtoMessage 

func (*AccountProperties) ProtoMessage()

func (*AccountProperties) ProtoReflect 

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

func (*AccountProperties) Reset 

func (x *AccountProperties) Reset()

func (*AccountProperties) String 

func (x *AccountProperties) String() string

type GroupProperties 

type GroupProperties struct {

	// ID of the IDP connection the group instance is associated with.
	ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"`
	// contains filtered or unexported fields
}

Properties of "group" objects.

func (*GroupProperties) Descriptor deprecated 

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

Deprecated: Use GroupProperties.ProtoReflect.Descriptor instead.

func (*GroupProperties) GetConnectionId 

func (x *GroupProperties) GetConnectionId() string

func (*GroupProperties) ProtoMessage 

func (*GroupProperties) ProtoMessage()

func (*GroupProperties) ProtoReflect 

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

func (*GroupProperties) Reset 

func (x *GroupProperties) Reset()

func (*GroupProperties) String 

func (x *GroupProperties) String() string

type GuideState 

type GuideState struct {

	// Whether or not to display the getting started guide.
	Show bool `protobuf:"varint,1,opt,name=show,proto3" json:"show,omitempty"`
	// Progress information about individual steps in the guide.
	Steps *structpb.Struct `protobuf:"bytes,2,opt,name=steps,proto3" json:"steps,omitempty"`
	// contains filtered or unexported fields
}

The state of a user's progress through the console's getting started guide.

func (*GuideState) Descriptor deprecated 

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

Deprecated: Use GuideState.ProtoReflect.Descriptor instead.

func (*GuideState) GetShow 

func (x *GuideState) GetShow() bool

func (*GuideState) GetSteps 

func (x *GuideState) GetSteps() *structpb.Struct

func (*GuideState) ProtoMessage 

func (*GuideState) ProtoMessage()

func (*GuideState) ProtoReflect 

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

func (*GuideState) Reset 

func (x *GuideState) Reset()

func (*GuideState) String 

func (x *GuideState) String() string

type IdentityKind 

type IdentityKind int32
const (
	// undefined state
	IdentityKind_IDENTITY_KIND_UNKNOWN IdentityKind = 0
	// provider unique identifier
	IdentityKind_IDENTITY_KIND_PID IdentityKind = 1
	// email address
	IdentityKind_IDENTITY_KIND_EMAIL IdentityKind = 2
	// username
	IdentityKind_IDENTITY_KIND_USERNAME IdentityKind = 3
	// distinguished name format RFC1779
	IdentityKind_IDENTITY_KIND_DN IdentityKind = 4
	// phone number using the format described in RFC3966, using the E.164 recommendation
	IdentityKind_IDENTITY_KIND_PHONE IdentityKind = 5
	// employee identifier
	IdentityKind_IDENTITY_KIND_EMPID IdentityKind = 6
)

func (IdentityKind) Descriptor 

func (IdentityKind) Descriptor() protoreflect.EnumDescriptor

func (IdentityKind) Enum 

func (x IdentityKind) Enum() *IdentityKind

func (IdentityKind) EnumDescriptor deprecated 

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

Deprecated: Use IdentityKind.Descriptor instead.

func (IdentityKind) Number 

func (x IdentityKind) Number() protoreflect.EnumNumber

func (IdentityKind) String 

func (x IdentityKind) String() string

func (IdentityKind) Type 

func (IdentityKind) Type() protoreflect.EnumType

type IdentityProperties 

type IdentityProperties struct {

	// identity kind [email|username|uid|pid|dn|phone]
	Kind IdentityKind `protobuf:"varint,1,opt,name=kind,proto3,enum=aserto.directory.schema.v3.IdentityKind" json:"kind,omitempty"`
	// identity provider name
	Provider string `protobuf:"bytes,2,opt,name=provider,proto3" json:"provider,omitempty"`
	// identity has been verified (false when not explicitly specified)
	Verified bool `protobuf:"varint,3,opt,name=verified,proto3" json:"verified,omitempty"`
	// IDP connection id which owns the object instance
	ConnectionId *string `protobuf:"bytes,4,opt,name=connection_id,json=connectionId,proto3,oneof" json:"connection_id,omitempty"`
	// contains filtered or unexported fields
}

Properties of "identity" objects.

func (*IdentityProperties) Descriptor deprecated 

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

Deprecated: Use IdentityProperties.ProtoReflect.Descriptor instead.

func (*IdentityProperties) GetConnectionId 

func (x *IdentityProperties) GetConnectionId() string

func (*IdentityProperties) GetKind 

func (x *IdentityProperties) GetKind() IdentityKind

func (*IdentityProperties) GetProvider 

func (x *IdentityProperties) GetProvider() string

func (*IdentityProperties) GetVerified 

func (x *IdentityProperties) GetVerified() bool

func (*IdentityProperties) ProtoMessage 

func (*IdentityProperties) ProtoMessage()

func (*IdentityProperties) ProtoReflect 

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

func (*IdentityProperties) Reset 

func (x *IdentityProperties) Reset()

func (*IdentityProperties) String 

func (x *IdentityProperties) String() string

type TenantKind 

type TenantKind int32
const (
	TenantKind_TENANT_KIND_UNKNOWN      TenantKind = 0
	TenantKind_TENANT_KIND_ORGANIZATION TenantKind = 1
	TenantKind_TENANT_KIND_ACCOUNT      TenantKind = 2 // personal tenant
)

func (TenantKind) Descriptor 

func (TenantKind) Descriptor() protoreflect.EnumDescriptor

func (TenantKind) Enum 

func (x TenantKind) Enum() *TenantKind

func (TenantKind) EnumDescriptor deprecated 

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

Deprecated: Use TenantKind.Descriptor instead.

func (TenantKind) Number 

func (x TenantKind) Number() protoreflect.EnumNumber

func (TenantKind) String 

func (x TenantKind) String() string

func (TenantKind) Type 

func (TenantKind) Type() protoreflect.EnumType

type TenantProperties 

type TenantProperties struct {

	// The kind of tenant.
	Kind TenantKind `protobuf:"varint,1,opt,name=kind,proto3,enum=aserto.directory.schema.v3.TenantKind" json:"kind,omitempty"`
	// Whether or not the v2 directory experience enabled for this tenant.
	DirectoryV2 bool `protobuf:"varint,2,opt,name=directory_v2,json=directoryV2,proto3" json:"directory_v2,omitempty"`
	// If true, the tenant cannot be reverted to the v1 directory experience.
	DirectoryV2Only bool `protobuf:"varint,3,opt,name=directory_v2_only,json=directoryV2Only,proto3" json:"directory_v2_only,omitempty"`
	// Additional properties that are only set accounts (personal tenant).
	Account *AccountProperties `protobuf:"bytes,4,opt,name=account,proto3,oneof" json:"account,omitempty"`
	// contains filtered or unexported fields
}

Properties of a tenant object

func (*TenantProperties) Descriptor deprecated 

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

Deprecated: Use TenantProperties.ProtoReflect.Descriptor instead.

func (*TenantProperties) GetAccount 

func (x *TenantProperties) GetAccount() *AccountProperties

func (*TenantProperties) GetDirectoryV2 

func (x *TenantProperties) GetDirectoryV2() bool

func (*TenantProperties) GetDirectoryV2Only 

func (x *TenantProperties) GetDirectoryV2Only() bool

func (*TenantProperties) GetKind 

func (x *TenantProperties) GetKind() TenantKind

func (*TenantProperties) ProtoMessage 

func (*TenantProperties) ProtoMessage()

func (*TenantProperties) ProtoReflect 

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

func (*TenantProperties) Reset 

func (x *TenantProperties) Reset()

func (*TenantProperties) String 

func (x *TenantProperties) String() string

type UserProperties 

type UserProperties struct {

	// main email address of user
	Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`
	// URL to user's picture
	Picture string `protobuf:"bytes,2,opt,name=picture,proto3" json:"picture,omitempty"`
	// user lifecycle status
	Status UserStatus `protobuf:"varint,3,opt,name=status,proto3,enum=aserto.directory.schema.v3.UserStatus" json:"status,omitempty"`
	// enabled (false prevents the user from accessing anything)
	Enabled bool `protobuf:"varint,4,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// ID of the IDP connection the user instance is associated with.
	ConnectionId string `protobuf:"bytes,5,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"`
	// contains filtered or unexported fields
}

Properties of "user" objects.

func (*UserProperties) Descriptor deprecated 

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

Deprecated: Use UserProperties.ProtoReflect.Descriptor instead.

func (*UserProperties) GetConnectionId 

func (x *UserProperties) GetConnectionId() string

func (*UserProperties) GetEmail 

func (x *UserProperties) GetEmail() string

func (*UserProperties) GetEnabled 

func (x *UserProperties) GetEnabled() bool

func (*UserProperties) GetPicture 

func (x *UserProperties) GetPicture() string

func (*UserProperties) GetStatus 

func (x *UserProperties) GetStatus() UserStatus

func (*UserProperties) ProtoMessage 

func (*UserProperties) ProtoMessage()

func (*UserProperties) ProtoReflect 

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

func (*UserProperties) Reset 

func (x *UserProperties) Reset()

func (*UserProperties) String 

func (x *UserProperties) String() string

type UserStatus 

type UserStatus int32
const (
	// User status undefined
	UserStatus_USER_STATUS_UNKNOWN UserStatus = 0
	// Staged status, is when the user object is first created, before the activation flow is initiated, or if there is a pending admin action.
	UserStatus_USER_STATUS_STAGED UserStatus = 1
	// Provisioned status, is when the user object is provisioned, but the user has not provided verification by clicking through the activation email or provided a password.
	UserStatus_USER_STATUS_PROVISIONED UserStatus = 2
	// Active status, is when:
	//   - An admin adds a user and sets the user password without requiring email verification.
	//   - An admin adds a user, sets the user password, and requires the user to set their password when they first sign-in.
	//   - A user self-registers into a custom app or IDP and email verification is not required.
	//   - An admin explicitly activates the user.
	UserStatus_USER_STATUS_ACTIVE UserStatus = 3
	// Recovery status, when the user requests a password reset or an admin initiates one on their behalf.
	UserStatus_USER_STATUS_RECOVERY UserStatus = 4
	// Password expired, status when the users' password has expired and the account requires an update to the password before a user is granted access.
	UserStatus_USER_STATUS_PASSWORD_EXPIRED UserStatus = 5
	// Locked out status, is when the user exceeds the number of login attempts defined in the login policy.
	UserStatus_USER_STATUS_LOCKED_OUT UserStatus = 6
	// Suspended status, when an admin explicitly suspends the user account.
	UserStatus_USER_STATUS_SUSPENDED UserStatus = 7
	// Deprovisioned status, is when an administrator explicitly deactivates or deprovisions/deletes the account.
	UserStatus_USER_STATUS_DEPROVISIONED UserStatus = 8
)

func (UserStatus) Descriptor 

func (UserStatus) Descriptor() protoreflect.EnumDescriptor

func (UserStatus) Enum 

func (x UserStatus) Enum() *UserStatus

func (UserStatus) EnumDescriptor deprecated 

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

Deprecated: Use UserStatus.Descriptor instead.

func (UserStatus) Number 

func (x UserStatus) Number() protoreflect.EnumNumber

func (UserStatus) String 

func (x UserStatus) String() string

func (UserStatus) Type 

func (UserStatus) Type() protoreflect.EnumType

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.