Search Results for

    Show / Hide Table of Contents

    Class UserDetail

    Detail information about a user.

    Inheritance
    object
    User
    UserDetail
    Inherited Members
    User.Id
    User.FirstName
    User.LastName
    User.EmailAddress
    User.IsDeleted
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class UserDetail : User

    Properties

    Address

    User's address.

    Declaration
    [JsonProperty("address", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public UserAddress Address { get; set; }
    Property Value
    UserAddress

    Audit

    Audit information.

    Declaration
    [JsonProperty("audit", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public UserAuditDetail Audit { get; set; }
    Property Value
    UserAuditDetail

    AuthorizationState

    Authorization state the user is currently in.

    Declaration
    [JsonProperty("authorizationState", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    [JsonConverter(typeof(StringEnumConverter))]
    public AuthorizationState AuthorizationState { get; set; }
    Property Value
    AuthorizationState

    Comment

    Comment saved for the user.

    Declaration
    [JsonProperty("comment", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string Comment { get; set; }
    Property Value
    string

    IdentityProviderId

    Identity provider that governs this user or null for Picturepark's own IdentityServer.

    Declaration
    [JsonProperty("identityProviderId", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string IdentityProviderId { get; set; }
    Property Value
    string

    IsAnonymousUser

    Anonymous user is the automatically logged in user if public access is allowed.

    Declaration
    [JsonProperty("isAnonymousUser", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    public bool IsAnonymousUser { get; set; }
    Property Value
    bool

    IsFederated

    Federated user is a user who is (currently) governed by an external identity provider.

    Declaration
    [JsonProperty("isFederated", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    public bool IsFederated { get; set; }
    Property Value
    bool

    IsLocked

    Locked users are unable to log in and use the system.

    Declaration
    [JsonProperty("isLocked", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    public bool IsLocked { get; set; }
    Property Value
    bool

    IsReadOnly

    Read-only users can't be removed from the system, e.g. service user.

    Declaration
    [JsonProperty("isReadOnly", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    public bool IsReadOnly { get; set; }
    Property Value
    bool

    IsSupportUser

    Support user is a user created for Picturepark support personnel.

    Declaration
    [JsonProperty("isSupportUser", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    public bool IsSupportUser { get; set; }
    Property Value
    bool

    LanguageCode

    Preferred language, e.g. for correspondence.

    Declaration
    [JsonProperty("languageCode", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string LanguageCode { get; set; }
    Property Value
    string

    LastActivity

    Last activity of user.

    Declaration
    [JsonProperty("lastActivity", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public DateTime? LastActivity { get; set; }
    Property Value
    DateTime?

    LifeCycle

    Life cycle state the user is currently in.

    Declaration
    [JsonProperty("lifeCycle", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    [JsonConverter(typeof(StringEnumConverter))]
    public LifeCycle LifeCycle { get; set; }
    Property Value
    LifeCycle

    OwnerTokens

    Owner tokens referencing the user.

    Declaration
    [JsonProperty("ownerTokens", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<OwnerToken> OwnerTokens { get; set; }
    Property Value
    ICollection<OwnerToken>

    UserRoles

    User roles the user should be assigned to. Overwrites the original user roles.

    Declaration
    [JsonProperty("userRoles", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<UserRoleAssignment> UserRoles { get; set; }
    Property Value
    ICollection<UserRoleAssignment>

    Methods

    AsUpdateRequest()

    Creates an update request for this user.

    Declaration
    public UserUpdateRequest AsUpdateRequest()
    Returns
    UserUpdateRequest

    An update request with all the same data as this user instance

    FromJson(string)

    Declaration
    public static UserDetail FromJson(string data)
    Parameters
    string data

    Returns
    UserDetail

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX