View Source

Class MemberResponseModel

Represents a member returned in a response from the Umbraco CMS Management API.

Inheritance

object

ContentModelBase<MemberValueResponseModel, MemberVariantResponseModel>

ContentResponseModelBase<MemberValueResponseModel, MemberVariantResponseModel>

Namespace: Umbraco.Cms.Api.Management.ViewModels.Member

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class MemberResponseModel : ContentResponseModelBase<MemberValueResponseModel, MemberVariantResponseModel>, IHasFlags

Constructors

MemberResponseModel()

Declaration

public MemberResponseModel()

Properties

Email

Gets or sets the email address of the member.

Declaration

public string Email { get; set; }

Property Value

Type	Description
string

FailedPasswordAttempts

Gets or sets the number of failed password attempts for the member.

Declaration

public int FailedPasswordAttempts { get; set; }

Property Value

Type	Description
int

Groups

Gets or sets the collection of group IDs associated with the member.

Declaration

public IEnumerable<Guid> Groups { get; set; }

Property Value

Type	Description
IEnumerable<Guid>

IsApproved

Gets or sets a value indicating whether the member is approved.

Declaration

public bool IsApproved { get; set; }

Property Value

Type	Description
bool

IsLockedOut

Gets or sets a value indicating whether the member is locked out.

Declaration

public bool IsLockedOut { get; set; }

Property Value

Type	Description
bool

IsTwoFactorEnabled

Gets or sets a value indicating whether two-factor authentication is enabled for the member.

Declaration

public bool IsTwoFactorEnabled { get; set; }

Property Value

Type	Description
bool

Kind

Gets or sets the classification of the member, indicating the type or category of the member entity.

Declaration

public MemberKind Kind { get; set; }

Property Value

Type	Description
MemberKind

LastLockoutDate

Gets or sets the date and time when the member was last locked out.

Declaration

public DateTimeOffset? LastLockoutDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

LastLoginDate

Gets or sets the date and time of the member's last login.

Declaration

public DateTimeOffset? LastLoginDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

LastPasswordChangeDate

Gets or sets the date and time when the member last changed their password.

Declaration

public DateTimeOffset? LastPasswordChangeDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

MemberType

Gets or sets the member type reference information.

Declaration

public MemberTypeReferenceResponseModel MemberType { get; set; }

Property Value

Type	Description
MemberTypeReferenceResponseModel

ProfileData

Gets or sets the raw JSON profile data for external-only members.

Declaration

public string? ProfileData { get; set; }

Property Value

Type	Description
string

Remarks

Populated only for members whose Kind is ExternalOnly, from ProfileData. The shape is integrator-defined (typically claims serialised by an OnExternalLogin handler), so the API returns the raw JSON string and leaves interpretation to the consumer.

Username

Gets or sets the username of the member.

Declaration

public string Username { get; set; }

Property Value

Type	Description
string