Search Results for

    Show / Hide Table of Contents

    Interface ISharePointUser

    Public interface to define a SharePoint User

    Inherited Members
    IDataModel<ISharePointUser>.Requested
    IDataModel<ISharePointUser>.HasValue(String)
    IDataModel<ISharePointUser>.HasChanged(String)
    IDataModel<ISharePointUser>.IsPropertyAvailable(Expression<Func<ISharePointUser, Object>>)
    IDataModel<ISharePointUser>.ArePropertiesAvailable(Expression<Func<ISharePointUser, Object>>[])
    IDataModel<ISharePointUser>.EnsureProperties(Expression<Func<ISharePointUser, Object>>[])
    IDataModel<ISharePointUser>.EnsurePropertiesAsync(Expression<Func<ISharePointUser, Object>>[])
    IDataModel<ISharePointUser>.ExecuteRequestAsync(ApiRequest)
    IDataModel<ISharePointUser>.ExecuteRequest(ApiRequest)
    IDataModel<ISharePointUser>.ExecuteRequestBatchAsync(ApiRequest)
    IDataModel<ISharePointUser>.ExecuteRequestBatch(ApiRequest)
    IDataModel<ISharePointUser>.ExecuteRequestBatchAsync(Batch, ApiRequest)
    IDataModel<ISharePointUser>.ExecuteRequestBatch(Batch, ApiRequest)
    IDataModelParent.Parent
    IDataModelWithContext.PnPContext
    IDataModelGet<ISharePointUser>.GetBatchAsync(Batch, Expression<Func<ISharePointUser, Object>>[])
    IDataModelGet<ISharePointUser>.GetAsync(Expression<Func<ISharePointUser, Object>>[])
    IDataModelLoad<ISharePointUser>.LoadBatchAsync(Batch, Expression<Func<ISharePointUser, Object>>[])
    IDataModelLoad<ISharePointUser>.LoadAsync(Expression<Func<ISharePointUser, Object>>[])
    IDataModelDelete.DeleteBatchAsync()
    IDataModelDelete.DeleteBatchAsync(Batch)
    IDataModelDelete.DeleteAsync()
    IDataModelDelete.DeleteBatch()
    IDataModelDelete.DeleteBatch(Batch)
    IDataModelDelete.Delete()
    ISharePointPrincipal.Id
    ISharePointPrincipal.IsHiddenInUI
    ISharePointPrincipal.PrincipalType
    ISharePointPrincipal.LoginName
    ISharePointPrincipal.Title
    Namespace: PnP.Core.Model.Security
    Assembly: PnP.Core.dll
    Syntax
    public interface ISharePointUser : IDataModel<ISharePointUser>, IDataModelParent, IDataModelWithContext, ISupportModules<ISharePointUser>, IDataModelGet<ISharePointUser>, IDataModelLoad<ISharePointUser>, IDataModelDelete, ISharePointPrincipal, IQueryableDataModel

    Properties

    AadObjectId

    Id of the underlying graph object (if any)

    Declaration
    string AadObjectId { get; set; }
    Property Value
    System.String

    All

    A special property used to add an asterisk to a $select statement

    Declaration
    object All { get; }
    Property Value
    System.Object

    Department

    Department of the user

    Declaration
    string Department { get; set; }
    Property Value
    System.String

    Expiration

    A date/time string for which the format conforms to the ISO8601 time format YYYY-MM-DDTHH:MM:SSZ and which represents the time and date of expiry for the user. A null value indicates no expiry.

    Declaration
    string Expiration { get; }
    Property Value
    System.String

    Groups

    Returns the collection of ISharePointGroup for this user

    Declaration
    ISharePointGroupCollection Groups { get; }
    Property Value
    ISharePointGroupCollection

    IsEmailAuthenticationGuestUser

    Indicates whether the user is a guest user authenticated via an e-mail address

    Declaration
    bool IsEmailAuthenticationGuestUser { get; }
    Property Value
    System.Boolean

    IsShareByEmailGuestUser

    Indicates whether the user is a guest user shared by e-mail

    Declaration
    bool IsShareByEmailGuestUser { get; }
    Property Value
    System.Boolean

    IsSiteAdmin

    Indicates whether the user is a site collection administrator

    Declaration
    bool IsSiteAdmin { get; }
    Property Value
    System.Boolean

    Mail

    E-mail address of the user. SP REST property name: Email

    Declaration
    string Mail { get; set; }
    Property Value
    System.String

    UserPrincipalName

    User principle name (UPN) of the user

    Declaration
    string UserPrincipalName { get; set; }
    Property Value
    System.String

    Methods

    AddRoleDefinitions(String[])

    Adds role definitions for this user

    Declaration
    bool AddRoleDefinitions(params string[] names)
    Parameters
    System.String[] names

    Returns
    System.Boolean

    AddRoleDefinitionsAsync(String[])

    Adds role definitions for this user

    Declaration
    Task<bool> AddRoleDefinitionsAsync(params string[] names)
    Parameters
    System.String[] names

    Returns
    Task<System.Boolean>

    AsGraphUser()

    Returns this SharePoint user as a Graph user

    Declaration
    IGraphUser AsGraphUser()
    Returns
    IGraphUser

    AsGraphUserAsync()

    Returns this SharePoint user as a Graph user

    Declaration
    Task<IGraphUser> AsGraphUserAsync()
    Returns
    Task<IGraphUser>

    GetRoleDefinitions()

    Retrieves the role definitions for this user

    Declaration
    IRoleDefinitionCollection GetRoleDefinitions()
    Returns
    IRoleDefinitionCollection

    GetRoleDefinitionsAsync()

    Retrieves the role definitions for this user

    Declaration
    Task<IRoleDefinitionCollection> GetRoleDefinitionsAsync()
    Returns
    Task<IRoleDefinitionCollection>

    RemoveRoleDefinitions(String[])

    Removes role definitions for this user

    Declaration
    bool RemoveRoleDefinitions(params string[] names)
    Parameters
    System.String[] names

    Returns
    System.Boolean

    RemoveRoleDefinitionsAsync(String[])

    Removes role definitions for this user

    Declaration
    Task<bool> RemoveRoleDefinitionsAsync(params string[] names)
    Parameters
    System.String[] names

    Returns
    Task<System.Boolean>

    Extension Methods

    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<String, String>, Action<Dictionary<String, String>>)
    RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<String, String>>)
    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer