User Class

The User object represents a SQL Server user.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.User

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class User _
    Inherits ScriptNameObjectBase _
    Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable,  _
    IAlterable, IRenamable, IExtendedProperties, IScriptable, IUserOptions,  _
    IDmfFacet
'Usage
Dim instance As User

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class User : ScriptNameObjectBase, ISfcSupportsDesignMode, 
    IObjectPermission, ICreatable, IDroppable, IAlterable, IRenamable, 
    IExtendedProperties, IScriptable, IUserOptions, IDmfFacet

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class User sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IAlterable, 
    IRenamable, IExtendedProperties, IScriptable, IUserOptions, IDmfFacet

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type User =  
    class 
        inherit ScriptNameObjectBase 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
        interface ICreatable 
        interface IDroppable 
        interface IAlterable 
        interface IRenamable 
        interface IExtendedProperties 
        interface IScriptable 
        interface IUserOptions 
        interface IDmfFacet 
    end

public final class User extends ScriptNameObjectBase implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IAlterable, IRenamable, IExtendedProperties, IScriptable, IUserOptions, IDmfFacet

The User type exposes the following members.

Constructors

	Name	Description
	User()	Initializes a new instance of the User class.
	User(Database, String)	Initializes a new instance of the User class on the specified database with the specified name.

Top

Properties

	Name	Description
	AsymmetricKey	Gets or sets the asymmetric key for the user.
	AuthenticationType	Gets a string value that describes the mechanism used to authenticate the user.
	Certificate	Gets or sets the certificate for the user.
	CreateDate	Gets the date and time when the database user was created.
	DateLastModified	Gets the date and time when the database user was last modified.
	DefaultLanguage	Gets or sets the default language for the user.
	DefaultSchema	Gets the default schema for the database user.
	Events	Gets the events that are associated with the database user.
	ExtendedProperties	Gets the extended properties of the database user.
	HasDBAccess	Gets the Boolean property that specifies whether the database user has access to the database.
	ID	Gets the ID value that uniquely identifies the database user.
	IsSystemObject	Gets the Boolean property that specifies whether the database user is a system object.
	Login	Gets the login that is associated with the database user.
	LoginType	Gets the type of login that is associated with the database user, such as whether it is a Windows group or a SQL Server standard login.
	Name	Gets or sets a String value that specifies the name of the user. (Overrides NamedSmoObject.Name.)
	Parent	Gets the Database object that is the parent of the User object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	Sid	Gets the security identification number (SID) value of the database user.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
	UserType	Gets or sets the type of user.

Top

Methods

	Name	Description
	AddToRole	Adds the database user to the specified role.
	Alter	Updates any User object property changes on the instance of Microsoft SQL Server.
	ChangePassword(SecureString)	Changes the user password.
	ChangePassword(String)	Changes the user password.
	ChangePassword(SecureString, SecureString)	Changes the user password.
	ChangePassword(String, String)	Changes the user password.
	Create()	Creates a database user on the instance of SQL Server as defined by the User object.
	Create(SecureString)	Creates a database user on the instance of SQL Server as defined by the User object with specified password using a secure string.
	Create(String)	Creates a database user on the instance of SQL Server as defined by the User object with specified password.
	Deny(ObjectPermissionSet, String)	Denies access to the specified permission for the specified grantee on the database user.
	Deny(ObjectPermissionSet, array<String[])	Denies access to the specified permission for the specified grantees on the database user.
	Deny(ObjectPermissionSet, String, Boolean)	Denies access to the specified permission for the specified grantee and other users whom the grantee granted access on the database user.
	Deny(ObjectPermissionSet, array<String[], Boolean)	Denies access to the specified permission for the specified grantees on the database user.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the user from the database.
	EnumObjectPermissions()	Enumerates a list of object permissions for the database user.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the database user.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the database user.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the database user.
	EnumOwnedObjects	Enumerates a list of object that the database user owns.
	EnumRoles	Enumerates a list of roles of which the database user is a member.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Grant(ObjectPermissionSet, String)	Grants access to the specified permission for the specified grantee on the database user.
	Grant(ObjectPermissionSet, array<String[])	Grants access to the specified permission for the specified grantees on the database user.
	Grant(ObjectPermissionSet, String, Boolean)	Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the database user.
	Grant(ObjectPermissionSet, array<String[], Boolean)	Grants access to the specified permission and the ability to grant access to other users for the specified grantees on the database user.
	Grant(ObjectPermissionSet, String, Boolean, String)	Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the database user.
	Grant(ObjectPermissionSet, array<String[], Boolean, String)	Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the database user under an assumed role.
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsMember	Verifies whether the database user is a member of the specified role.
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	MakeContained	Converts a login mapped user to a contained user with password using the sys.sp_copy_password_to_user stored procedure.
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	Rename	Renames the database user.
	Revoke(ObjectPermissionSet, String)	Revokes previously granted permissions from a grantee on the database user.
	Revoke(ObjectPermissionSet, array<String[])	Revokes previously granted permissions from a list of grantees on the database user.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes previously granted permissions from a grantee on the database user and any other users to whom the grantee has granted access. The grantee is also given the ability to revoke other users' access.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean)	Revokes previously granted permissions from the grantees on the database user and any other users to whom the grantees have granted access. The grantees are also given the ability to revoke other users' access.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)	Revokes previously granted permissions from a grantee on the database user and any other users to whom the grantee has granted access. The grantee is also given the ability to revoke other users' access under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String)	Revokes previously granted permissions from grantees on the database user and any other users to whom the grantees have granted access. The grantees are also given the ability to revoke other users' access under an assumed role.
	Script()	Generates a Transact-SQL script that can be used to re-create the database user.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the database user as specified by the script options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that specifies whether the user supports design mode.

Top

Remarks

To get User object properties, users can be a member of the public fixed server role.

To set User object properties, uses must have ALTER ANY USER permission on the database or be a member of the db_owner fixed database role.

To change the default schema, users must have ALTER permission on the specified user or be the owner of the user.

To create or drop a user, users must have ALTER ANY USER permission on the fixed server role or be a member of the db_owner fixed database role.

To grant, deny, or revoke permission on the specified user to other users, users must have CONTROL permission on the specified user.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Managing Users, Roles, and Logins

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

CREATE USER (Transact-SQL)