Interface ISharePointUser
Public interface to define a SharePoint User
Assembly: PnP.Core.dll
Syntax
public interface ISharePointUser : IDataModel<ISharePointUser>, IDataModelParent, IDataModelWithContext, ISupportModules<ISharePointUser>, IDataModelGet<ISharePointUser>, IDataModelLoad<ISharePointUser>, IDataModelDelete, ISharePointPrincipal, IQueryableDataModel
Properties
Id of the underlying graph object (if any)
Declaration
string AadObjectId { get; set; }
Property Value
A special property used to add an asterisk to a $select statement
Declaration
Property Value
Declaration
string Department { get; set; }
Property Value
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
Declaration
ISharePointGroupCollection Groups { get; }
Property Value
Indicates whether the user is a guest user authenticated via an e-mail address
Declaration
bool IsEmailAuthenticationGuestUser { get; }
Property Value
Indicates whether the user is a guest user shared by e-mail
Declaration
bool IsShareByEmailGuestUser { get; }
Property Value
Indicates whether the user is a site collection administrator
Declaration
bool IsSiteAdmin { get; }
Property Value
E-mail address of the user.
SP REST property name: Email
Declaration
string Mail { get; set; }
Property Value
User principle name (UPN) of the user
Declaration
string UserPrincipalName { get; set; }
Property Value
Methods
Adds role definitions for this user
Declaration
bool AddRoleDefinitions(params string[] names)
Parameters
Returns
Adds role definitions for this user
Declaration
Task<bool> AddRoleDefinitionsAsync(params string[] names)
Parameters
Returns
Returns this SharePoint user as a Graph user
Declaration
Returns
Returns this SharePoint user as a Graph user
Declaration
Task<IGraphUser> AsGraphUserAsync()
Returns
Retrieves the role definitions for this user
Declaration
IRoleDefinitionCollection GetRoleDefinitions()
Returns
Retrieves the role definitions for this user
Declaration
Task<IRoleDefinitionCollection> GetRoleDefinitionsAsync()
Returns
Removes role definitions for this user
Declaration
bool RemoveRoleDefinitions(params string[] names)
Parameters
Returns
Removes role definitions for this user
Declaration
Task<bool> RemoveRoleDefinitionsAsync(params string[] names)
Parameters
Returns
Extension Methods