Interface ISharePointUser

Namespace

PnP.Core.Model.Security

Assembly

PnP.Core.dll

Public interface to define a SharePoint User

public interface ISharePointUser : IDataModel<ISharePointUser>, IDataModelParent, IDataModelWithContext, ISupportModules<ISharePointUser>, IDataModelGet<ISharePointUser>, IDataModelLoad<ISharePointUser>, IDataModelDelete, ISharePointPrincipal, IQueryableDataModel

Inherited Members

IDataModel<ISharePointUser>.Requested

IDataModel<ISharePointUser>.HasValue(string)

IDataModel<ISharePointUser>.HasChanged(string)

IDataModel<ISharePointUser>.IsPropertyAvailable(Expression<Func<ISharePointUser, object>>)

IDataModel<ISharePointUser>.ArePropertiesAvailable(params Expression<Func<ISharePointUser, object>>[])

IDataModel<ISharePointUser>.EnsureProperties(params Expression<Func<ISharePointUser, object>>[])

IDataModel<ISharePointUser>.EnsurePropertiesAsync(params 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, params Expression<Func<ISharePointUser, object>>[])

IDataModelGet<ISharePointUser>.GetAsync(params Expression<Func<ISharePointUser, object>>[])

IDataModelLoad<ISharePointUser>.LoadBatchAsync(Batch, params Expression<Func<ISharePointUser, object>>[])

IDataModelLoad<ISharePointUser>.LoadAsync(params 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

Extension Methods

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, params 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>>)

Properties

AadObjectId

Id of the underlying graph object (if any)

string AadObjectId { get; set; }

Property Value

string

All

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

object All { get; }

Property Value

object

Department

Department of the user

string Department { get; set; }

Property Value

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.

string Expiration { get; }

Property Value

string

Groups

Returns the collection of ISharePointGroup for this user

ISharePointGroupCollection Groups { get; }

Property Value

ISharePointGroupCollection

IsEmailAuthenticationGuestUser

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

bool IsEmailAuthenticationGuestUser { get; }

Property Value

bool

IsShareByEmailGuestUser

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

bool IsShareByEmailGuestUser { get; }

Property Value

bool

IsSiteAdmin

Indicates whether the user is a site collection administrator

bool IsSiteAdmin { get; }

Property Value

bool

Mail

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

string Mail { get; set; }

Property Value

string

UserPrincipalName

User principle name (UPN) of the user

string UserPrincipalName { get; set; }

Property Value

string

Methods

AddRoleDefinitions(params string[])

Adds role definitions for this user

bool AddRoleDefinitions(params string[] names)

Parameters

names string[]

Returns

bool

AddRoleDefinitionsAsync(params string[])

Adds role definitions for this user

Task<bool> AddRoleDefinitionsAsync(params string[] names)

Parameters

names string[]

Returns

Task<bool>

AsGraphUser()

Returns this SharePoint user as a Graph user

IGraphUser AsGraphUser()

Returns

IGraphUser

AsGraphUserAsync()

Returns this SharePoint user as a Graph user

Task<IGraphUser> AsGraphUserAsync()

Returns

Task<IGraphUser>

GetRoleDefinitions()

Retrieves the role definitions for this user

IRoleDefinitionCollection GetRoleDefinitions()

Returns

IRoleDefinitionCollection

GetRoleDefinitionsAsync()

Retrieves the role definitions for this user

Task<IRoleDefinitionCollection> GetRoleDefinitionsAsync()

Returns

Task<IRoleDefinitionCollection>

RemoveRoleDefinitions(params string[])

Removes role definitions for this user

bool RemoveRoleDefinitions(params string[] names)

Parameters

names string[]

Returns

bool

RemoveRoleDefinitionsAsync(params string[])

Removes role definitions for this user

Task<bool> RemoveRoleDefinitionsAsync(params string[] names)

Parameters

names string[]

Returns

Task<bool>