schema

Documentation

Index

• Variables
• type UserProperties
  • func (*UserProperties) Descriptor() ([]byte, []int)
  • func (x *UserProperties) GetConnectionId() string
  • func (x *UserProperties) GetEmail() string
  • func (x *UserProperties) GetEnabled() bool
  • func (x *UserProperties) GetPicture() string
  • func (x *UserProperties) GetStatus() UserStatus
  • func (*UserProperties) ProtoMessage()
  • func (x *UserProperties) ProtoReflect() protoreflect.Message
  • func (x *UserProperties) Reset()
  • func (x *UserProperties) String() string
• type UserStatus
  • func (UserStatus) Descriptor() protoreflect.EnumDescriptor
  • func (x UserStatus) Enum() *UserStatus
  • func (UserStatus) EnumDescriptor() ([]byte, []int)
  • func (x UserStatus) Number() protoreflect.EnumNumber
  • func (x UserStatus) String() string
  • func (UserStatus) Type() protoreflect.EnumType

Variables

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.

var File_aserto_directory_schema_v2_user_proto protoreflect.FileDescriptor

Types

type UserProperties

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

func (*UserProperties) Descriptor

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 (
	UserStatus_USER_STATUS_UNKNOWN     UserStatus = 0 // User status undefined
	UserStatus_USER_STATUS_STAGED      UserStatus = 1 // 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_PROVISIONED UserStatus = 2 // 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_ACTIVE      UserStatus = 3 // 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_RECOVERY         UserStatus = 4 // Recovery status, when the user requests a password reset or an admin initiates one on their behalf.
	UserStatus_USER_STATUS_PASSWORD_EXPIRED UserStatus = 5 // 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_LOCKED_OUT       UserStatus = 6 // Locked out status, is when the user exceeds the number of login attempts defined in the login policy.
	UserStatus_USER_STATUS_SUSPENDED        UserStatus = 7 // Suspended status, when an admin explicitly suspends the user account.
	UserStatus_USER_STATUS_DEPROVISIONED    UserStatus = 8 // Deprovisioned status, is when an administrator explicitly deactivates or deprovisions/deletes the account.
)

func (UserStatus) Descriptor

func (UserStatus) Descriptor() protoreflect.EnumDescriptor

func (UserStatus) Enum

func (x UserStatus) Enum() *UserStatus

func (UserStatus) EnumDescriptor

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