Export (0) Print
Expand All

Login Class

The Login object represents a SQL Server login account that has been granted access to the instance of SQL Server through Windows Authentication or SQL Server Authentication.

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

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

The Login type exposes the following members.

  NameDescription
Public methodLogin()Initializes a new instance of the Login class.
Public methodLogin(Server, String)Initializes a new instance of the Login class on the specified instance of SQL Server and with the specified name.
Top

  NameDescription
Public propertyAsymmetricKeyGets the asymmetric key associated with the login.
Public propertyCertificateGets the certificate associated with the login.
Public propertyCreateDateGets the date and time when the login account was created.
Public propertyCredentialGets the credential associated with the login.
Public propertyDateLastModifiedGets the date and time when the login account was last modified.
Public propertyDefaultDatabaseGets or sets the default database that the login account is assigned to after logging on to the instance of SQL Server.
Public propertyDenyWindowsLoginGets or sets the Boolean property value that specifies whether the login account has been granted or denied the ability to log on to the instance of SQL Server.
Public propertyEventsGets the events associated with the login account.
Public propertyHasAccessGets or sets the Boolean property value that specifies whether the SQL Server login account has access to the instance of SQL Server.
Public propertyIDGets the ID value that uniquely identifies the login account.
Public propertyIsDisabledGets or sets the Boolean property value that specifies whether the SQL Server login account is disabled.
Public propertyIsLockedGets the Boolean property value that specifies whether the login account has been locked out of the instance of SQL Server.
Public propertyIsPasswordExpiredGets the Boolean property value that specifies whether the password for the SQL Server login account has expired.
Public propertyIsSystemObjectGets or sets the Boolean property value that specifies whether the SQL Server login account is a system object.
Public propertyLanguageGets or sets the language required by the referenced login account for date formats and system messages.
Public propertyLanguageAliasGets the alias name used for the language that is required by the SQL Server login account.
Public propertyLoginTypeGets or sets the type of SQL Server login account.
Public propertyMustChangePasswordGets the Boolean property value that specifies whether the login account password must be changed when the user next logs on to the instance of SQL Server.
Public propertyNameGets or sets the name of the login. (Overrides NamedSmoObject.Name.)
Public propertyParentGets the Server object that is the parent of the Login object.
Public propertyPasswordExpirationEnabledGets the Boolean property value that specifies whether the password for the login account will automatically expire.
Public propertyPasswordHashAlgorithmGets or sets the hash algorithm used for the password.
Public propertyPasswordPolicyEnforcedGets the Boolean property value that specifies whether password policy is enforced for this login account.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertySidGets or sets the security identifier (SID) for the login account.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public propertyWindowsLoginAccessTypeGets the type of Windows logon access.
Top

  NameDescription
Public methodAddCredentialAdds a login credential.
Public methodAddToRoleAdds the login account to a SQL Server role.
Public methodAlterUpdates any Login object property changes on the login account on the instance of SQL Server.
Public methodChangePassword(String)Changes the password for the login account.
Public methodChangePassword(String, String)Changes the password for the login account.
Public methodChangePassword(String, Boolean, Boolean)Changes the password for the login account.
Public methodCreate()Creates a login account on the instance of SQL Server as defined by the Login object.
Public methodCreate(SecureString)Creates a login account on the instance of SQL Server as defined by the Login object.
Public methodCreate(String)Creates a login account on the instance of SQL Server as defined by the Login object.
Public methodCreate(SecureString, LoginCreateOptions)Creates a login account on the instance of SQL Server as defined by the Login object.
Public methodCreate(String, LoginCreateOptions)Creates a login account on the instance of SQL Server as defined by the Login object.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the login account.
Public methodDeny(ObjectPermissionSet, String[])Denies the specified set of permissions for the specified grantees on the logon.
Public methodDeny(ObjectPermissionSet, String, Boolean)Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the logon.
Public methodDeny(ObjectPermissionSet, String[], Boolean)Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the logon.
Public methodDisableDisables the login account.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the login account from the instance of SQL Server.
Public methodDropCredentialDrops a login credential.
Public methodEnableEnables the login account.
Public methodEnumAgentProxyAccountsEnumerates a list of agent proxy accounts in which the login account is participating.
Public methodEnumCredentialsReturns a string collection of credentials associated with a login.
Public methodEnumDatabaseMappingsEnumerates a list of login account mappings to databases and database users.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the login account.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the login account.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the login account.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the login account.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Public methodGetDatabaseUserGets the name of the user that the login account is mapped to in a specified database.
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the login account.
Public methodGrant(ObjectPermissionSet, String[])Grants the specified set of permissions to the specified grantees on the login account.
Public methodGrant(ObjectPermissionSet, String, Boolean)Grants access to the specified permission to the grantee and the ability to grant access to other users on the login account.
Public methodGrant(ObjectPermissionSet, String[], Boolean)Grants access to the specified permission to the grantees and the ability to grant access to other users on the login account.
Public methodGrant(ObjectPermissionSet, String, Boolean, String)Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the login account under an assumed role.
Public methodGrant(ObjectPermissionSet, String[], Boolean, String)Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the logon under an assumed role.
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodIsMemberReturns a Boolean value that specifies whether the login account is a member of a specified role.
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodListMembersReturns a list of the roles of which the login account is a member.
Public methodRefreshRefreshes the login credentials. (Overrides ScriptNameObjectBase.Refresh().)
Public methodRenameRenames the login account.
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the login account.
Public methodRevoke(ObjectPermissionSet, String[])Revokes a previously granted set of permissions from a list of grantees on the login account.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean)Revokes previously granted permissions from a grantee on the login account and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodRevoke(ObjectPermissionSet, String[], Boolean, Boolean)Revokes previously granted permissions from grantees on the login account and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean, String)Revokes previously granted permissions from a grantee on the login account and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodRevoke(ObjectPermissionSet, String[], Boolean, Boolean, String)Revokes previously granted permissions from grantees on the login account and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the login account.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the login account as specified by the script options.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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.)
Explicit interface implemetationPrivate methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode.IsDesignModeGets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
Top

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

To set Login object properties, users must have ALTER ANY LOGIN permissions on the server or be a member of the sysadmin fixed server role.

To create or drop a login, users must have ALTER ANY LOGIN permissions on the server or be a member of the sysadmin fixed server role.

To grant, deny, or revoke permission on the login to other users, users must have CONTROL permissions on the logon or be a member of the sysadmin or securityadmin fixed server roles.

To set the password on a login without providing an old password, users must be a member of the sysadmin fixed server role.

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft