authdata

Documentation

Overview

Package authdata provides Firebase Authentication type definitions for CloudEvent data payloads.

Supported CloudEvent Types

• google.firebase.auth.user.v1.created
• google.firebase.auth.user.v1.deleted

Index

• Variables
• type AuthEventData
  • func (*AuthEventData) Descriptor() ([]byte, []int)
  • func (x *AuthEventData) GetCustomClaims() *structpb.Struct
  • func (x *AuthEventData) GetDisabled() bool
  • func (x *AuthEventData) GetDisplayName() string
  • func (x *AuthEventData) GetEmail() string
  • func (x *AuthEventData) GetEmailVerified() bool
  • func (x *AuthEventData) GetMetadata() *UserMetadata
  • func (x *AuthEventData) GetPhoneNumber() string
  • func (x *AuthEventData) GetPhoto_URL() string
  • func (x *AuthEventData) GetProviderData() []*UserInfo
  • func (x *AuthEventData) GetUid() string
  • func (*AuthEventData) ProtoMessage()
  • func (x *AuthEventData) ProtoReflect() protoreflect.Message
  • func (x *AuthEventData) Reset()
  • func (x *AuthEventData) String() string
• type UserInfo
  • func (*UserInfo) Descriptor() ([]byte, []int)
  • func (x *UserInfo) GetDisplayName() string
  • func (x *UserInfo) GetEmail() string
  • func (x *UserInfo) GetPhoto_URL() string
  • func (x *UserInfo) GetProviderId() string
  • func (x *UserInfo) GetUid() string
  • func (*UserInfo) ProtoMessage()
  • func (x *UserInfo) ProtoReflect() protoreflect.Message
  • func (x *UserInfo) Reset()
  • func (x *UserInfo) String() string
• type UserMetadata
  • func (*UserMetadata) Descriptor() ([]byte, []int)
  • func (x *UserMetadata) GetCreateTime() *timestamppb.Timestamp
  • func (x *UserMetadata) GetLastSignInTime() *timestamppb.Timestamp
  • func (*UserMetadata) ProtoMessage()
  • func (x *UserMetadata) ProtoReflect() protoreflect.Message
  • func (x *UserMetadata) Reset()
  • func (x *UserMetadata) String() string

Variables

var File_firebase_auth_v1_data_proto protoreflect.FileDescriptor

Types

type AuthEventData

type AuthEventData struct {

	// The user identifier in the Firebase app.
	Uid string `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	// The user's primary email, if set.
	Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
	// Whether or not the user's primary email is verified.
	EmailVerified bool `protobuf:"varint,3,opt,name=email_verified,json=emailVerified,proto3" json:"email_verified,omitempty"`
	// The user's display name.
	DisplayName string `protobuf:"bytes,4,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The user's photo URL.
	Photo_URL string `protobuf:"bytes,5,opt,name=photo_URL,json=photoURL,proto3" json:"photo_URL,omitempty"`
	// Whether the user is disabled.
	Disabled bool `protobuf:"varint,6,opt,name=disabled,proto3" json:"disabled,omitempty"`
	// Additional metadata about the user.
	Metadata *UserMetadata `protobuf:"bytes,7,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// User's info at the providers
	ProviderData []*UserInfo `protobuf:"bytes,8,rep,name=provider_data,json=providerData,proto3" json:"provider_data,omitempty"`
	// The user's phone number.
	PhoneNumber string `protobuf:"bytes,9,opt,name=phone_number,json=phoneNumber,proto3" json:"phone_number,omitempty"`
	// User's custom claims, typically used to define user roles and propagated
	// to an authenticated user's ID token.
	CustomClaims *structpb.Struct `protobuf:"bytes,10,opt,name=custom_claims,json=customClaims,proto3" json:"custom_claims,omitempty"`
	// contains filtered or unexported fields
}

The data within all Firebase Auth events.

func (*AuthEventData) Descriptor

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

Deprecated: Use AuthEventData.ProtoReflect.Descriptor instead.

func (*AuthEventData) GetCustomClaims

func (x *AuthEventData) GetCustomClaims() *structpb.Struct

func (*AuthEventData) GetDisabled

func (x *AuthEventData) GetDisabled() bool

func (*AuthEventData) GetDisplayName

func (x *AuthEventData) GetDisplayName() string

func (*AuthEventData) GetEmail

func (x *AuthEventData) GetEmail() string

func (*AuthEventData) GetEmailVerified

func (x *AuthEventData) GetEmailVerified() bool

func (*AuthEventData) GetMetadata

func (x *AuthEventData) GetMetadata() *UserMetadata

func (*AuthEventData) GetPhoneNumber

func (x *AuthEventData) GetPhoneNumber() string

func (*AuthEventData) GetPhoto_URL

func (x *AuthEventData) GetPhoto_URL() string

func (*AuthEventData) GetProviderData

func (x *AuthEventData) GetProviderData() []*UserInfo

func (*AuthEventData) GetUid

func (x *AuthEventData) GetUid() string

func (*AuthEventData) ProtoMessage

func (*AuthEventData) ProtoMessage()

func (*AuthEventData) ProtoReflect

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

func (*AuthEventData) Reset

func (x *AuthEventData) Reset()

func (*AuthEventData) String

func (x *AuthEventData) String() string

type UserInfo

type UserInfo struct {

	// The user identifier for the linked provider.
	Uid string `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	// The email for the linked provider.
	Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
	// The display name for the linked provider.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The photo URL for the linked provider.
	Photo_URL string `protobuf:"bytes,4,opt,name=photo_URL,json=photoURL,proto3" json:"photo_URL,omitempty"`
	// The linked provider ID (e.g. "google.com" for the Google provider).
	ProviderId string `protobuf:"bytes,5,opt,name=provider_id,json=providerId,proto3" json:"provider_id,omitempty"`
	// contains filtered or unexported fields
}

User's info at the identity provider

func (*UserInfo) Descriptor

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

Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.

func (*UserInfo) GetDisplayName

func (x *UserInfo) GetDisplayName() string

func (*UserInfo) GetEmail

func (x *UserInfo) GetEmail() string

func (*UserInfo) GetPhoto_URL

func (x *UserInfo) GetPhoto_URL() string

func (*UserInfo) GetProviderId

func (x *UserInfo) GetProviderId() string

func (*UserInfo) GetUid

func (x *UserInfo) GetUid() string

func (*UserInfo) ProtoMessage

func (*UserInfo) ProtoMessage()

func (*UserInfo) ProtoReflect

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

func (*UserInfo) Reset

func (x *UserInfo) Reset()

func (*UserInfo) String

func (x *UserInfo) String() string

type UserMetadata

type UserMetadata struct {

	// The date the user was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The date the user last signed in.
	LastSignInTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=last_sign_in_time,json=lastSignInTime,proto3" json:"last_sign_in_time,omitempty"`
	// contains filtered or unexported fields
}

Additional metadata about the user.

func (*UserMetadata) Descriptor

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

Deprecated: Use UserMetadata.ProtoReflect.Descriptor instead.

func (*UserMetadata) GetCreateTime

func (x *UserMetadata) GetCreateTime() *timestamppb.Timestamp

func (*UserMetadata) GetLastSignInTime

func (x *UserMetadata) GetLastSignInTime() *timestamppb.Timestamp

func (*UserMetadata) ProtoMessage

func (*UserMetadata) ProtoMessage()

func (*UserMetadata) ProtoReflect

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

func (*UserMetadata) Reset

func (x *UserMetadata) Reset()

func (*UserMetadata) String

func (x *UserMetadata) String() string