discovery

Documentation

Index

• type DiscoveredOrganization
• type Membership
• type PrimaryRequired

Types

type DiscoveredOrganization

type DiscoveredOrganization struct {
	// MemberAuthenticated: Indicates whether the Member has all of the factors needed to fully authenticate to
	// this Organization. If false, the Member may need to complete an MFA step or complete a different primary
	// authentication flow. See the `primary_required` and `mfa_required` fields for more details on each.
	MemberAuthenticated bool `json:"member_authenticated,omitempty"`
	// Organization: The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
	Organization organizations.Organization `json:"organization,omitempty"`
	// Membership: Information about the membership.
	Membership Membership `json:"membership,omitempty"`
	// PrimaryRequired: Information about the primary authentication requirements of the Organization.
	PrimaryRequired PrimaryRequired `json:"primary_required,omitempty"`
	// MFARequired: Information about the MFA requirements of the Organization and the Member's options for
	// fulfilling MFA.
	MFARequired mfa.MfaRequired `json:"mfa_required,omitempty"`
}

DiscoveredOrganization:

type Membership

type Membership struct {
	// Type: Either `active_member`, `pending_member`, `invited_member`, or `eligible_to_join_by_email_domain`
	Type string `json:"type,omitempty"`
	// Details: An object containing additional metadata about the membership, if available.
	Details map[string]any `json:"details,omitempty"`
	// Member: The [Member object](https://stytch.com/docs/b2b/api/member-object) if one already exists, or
	// null if one does not.
	Member organizations.Member `json:"member,omitempty"`
}

Membership:

type PrimaryRequired

type PrimaryRequired struct {
	// AllowedAuthMethods: If non-empty, indicates that the Organization restricts the authentication methods
	// it allows for login (such as `sso` or `password`), and the end user must complete one of those
	// authentication methods to log in. If empty, indicates that the Organization does not restrict the
	// authentication method it allows for login, but the end user does not have any transferrable primary
	// factors. Only email magic link and OAuth factors can be transferred between Organizations.
	AllowedAuthMethods []string `json:"allowed_auth_methods,omitempty"`
}

PrimaryRequired: