User Class

 

The User object represents a SQL Server user.

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


<PhysicalFacetAttribute>
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>
Public NotInheritable Class User
	Inherits ScriptNameObjectBase
	Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable,
	IDroppable, IDropIfExists, IAlterable, IRenamable, IExtendedProperties,
	IScriptable, IUserOptions, IDmfFacet

NameDescription
System_CAPS_pubmethodUser()

Initializes a new instance of the User class.

System_CAPS_pubmethodUser(Database, String)

Initializes a new instance of the User class on the specified database with the specified name.

NameDescription
System_CAPS_pubpropertyAsymmetricKey

Gets or sets the asymmetric key for the user.

System_CAPS_pubpropertyAuthenticationType

Gets a string value that describes the mechanism used to authenticate the user.

System_CAPS_pubpropertyCertificate

Gets or sets the certificate for the user.

System_CAPS_pubpropertyCreateDate

Gets the date and time when the database user was created.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the database user was last modified.

System_CAPS_pubpropertyDefaultLanguage

Gets or sets the default language for the user.

System_CAPS_pubpropertyDefaultSchema

Gets the default schema for the database user.

System_CAPS_pubpropertyEvents

Gets the events that are associated with the database user.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyExtendedProperties

Gets the extended properties of the database user.

System_CAPS_pubpropertyHasDBAccess

Gets the Boolean property that specifies whether the database user has access to the database.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the database user.

System_CAPS_pubpropertyIsSystemObject

Gets the Boolean property that specifies whether the database user is a system object.

System_CAPS_pubpropertyLogin

Gets the login that is associated with the database user.

System_CAPS_pubpropertyLoginType

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.

System_CAPS_pubpropertyName

Gets or sets a String value that specifies the name of the user.(Overrides NamedSmoObject.Name.)

System_CAPS_pubpropertyParent

Gets the Database object that is the parent of the User object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertySid

Gets the security identification number (SID) value of the database user.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUserType

Gets or sets the type of user.

NameDescription
System_CAPS_pubmethodAddToRole(String)

Adds the database user to the specified role.

System_CAPS_pubmethodAlter()

Updates any User object property changes on the instance of Microsoft SQL Server. 

System_CAPS_pubmethodChangePassword(SecureString)

Changes the user password.

System_CAPS_pubmethodChangePassword(SecureString, SecureString)

Changes the user password.

System_CAPS_pubmethodChangePassword(String)

Changes the user password.

System_CAPS_pubmethodChangePassword(String, String)

Changes the user password.

System_CAPS_pubmethodCreate()

Creates a database user on the instance of SQL Server as defined by the User object.

System_CAPS_pubmethodCreate(SecureString)

Creates a database user on the instance of SQL Server as defined by the User object with specified password using a secure string.

System_CAPS_pubmethodCreate(String)

Creates a database user on the instance of SQL Server as defined by the User object with specified password.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String)

Denies access to the specified permission for the specified grantee on the database user.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String())

Denies access to the specified permission for the specified grantees on the database user.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String(), Boolean)

Denies access to the specified permission for the specified grantees on the database user.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the user from the database.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the database user.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet)

Enumerates a list of object permissions for a specified permission on the database user.

System_CAPS_pubmethodEnumObjectPermissions(String)

Enumerates a list of object permissions for a specified grantee on the database user.

System_CAPS_pubmethodEnumObjectPermissions(String, ObjectPermissionSet)

Enumerates a list of object permissions for a specified grantee and a specified permission on the database user.

System_CAPS_pubmethodEnumOwnedObjects()

Enumerates a list of object that the database user owns.

System_CAPS_pubmethodEnumRoles()

Enumerates a list of roles of which the database user is a member.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet, String)

Grants access to the specified permission for the specified grantee on the database user.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String())

Grants access to the specified permission for the specified grantees on the database user.

System_CAPS_pubmethodGrant(ObjectPermissionSet, 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.

System_CAPS_pubmethodGrant(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 under an assumed role.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsMember(String)

Verifies whether the database user is a member of the specified role.

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodMakeContained(Boolean, Boolean)

Converts a login mapped user to a contained user with password using the sys.sp_copy_password_to_user stored procedure.

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodRename(String)

Renames the database user.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String)

Revokes previously granted permissions from a grantee on the database user.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String())

Revokes previously granted permissions from a list of grantees on the database user.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, 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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, 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.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the database user.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the database user as specified by the script options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object())

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode.IsDesignMode

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.

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.

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

Return to top
Show: