authtypes

Documentation

Index

• Constants
• type Flow
• type FullyQualifiedProfile
• type LoginType
• type Membership
• type Profile
• type ThreePID

Constants

const (
	LoginTypePassword           = "m.login.password"
	LoginTypeDummy              = "m.login.dummy"
	LoginTypeSharedSecret       = "org.matrix.login.shared_secret"
	LoginTypeRecaptcha          = "m.login.recaptcha"
	LoginTypeApplicationService = "m.login.application_service"
	LoginTypeToken              = "m.login.token"
	LoginTypeXs                 = "com.xs.blockchain_sign_auth"
	LoginTypeCosmos             = "com.xs.cosmos_sign_auth"
	LoginTypeJwt                = "com.xs.jwt_auth"
)

The relevant login types implemented in Dendrite

Types

type Flow

type Flow struct {
	Stages []LoginType `json:"stages"`
}

Flow represents one possible way that the client can authenticate a request. https://matrix.org/docs/spec/client_server/r0.3.0.html#user-interactive-authentication-api

type FullyQualifiedProfile

type FullyQualifiedProfile struct {
	UserID      string  `json:"user_id"`
	DisplayName string  `json:"display_name"`
	AvatarURL   string  `json:"avatar_url"`
	TelNumbers  []int64 `json:"tel_numbers"`
}

FullyQualifiedProfile represents the profile for a Matrix account.

type LoginType

type LoginType string

LoginType are specified by http://matrix.org/docs/spec/client_server/r0.2.0.html#login-types

type Membership

type Membership struct {
	Localpart string
	RoomID    string
	EventID   string
}

Membership represents the relationship between a user and a room they're a member of

type Profile

type Profile struct {
	Localpart   string  `json:"local_part"`
	ServerName  string  `json:"server_name,omitempty"` // NOTSPEC: only set by Pinecone user provider
	DisplayName string  `json:"display_name"`
	AvatarURL   string  `json:"avatar_url"`
	TelNumbers  []int64 `json:"tel_numbers"`
	MortgageFee string  `json:"mortgage_fee"`
}

Profile represents the profile for a Matrix account.

type ThreePID

type ThreePID struct {
	Address string `json:"address"`
	Medium  string `json:"medium"`
}

ThreePID represents a third-party identifier