xp_grantlogin (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Grants a Windows group or user access to SQL Server.

Important

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Use CREATE LOGIN instead.

||
|-|
|Applies to: SQL Server ( SQL Server 2008 through current version).|

Topic link icon Transact-SQL Syntax Conventions

Syntax


xp_grantlogin {[@loginame = ] 'login'} [,[@logintype = ] 'logintype']  

Arguments

[ @loginame = ] 'login'
Is the name of the Windows user or group to be added. The Windows user or group must be qualified with a Windows domain name in the form Domain\User. login is sysname, with no default.

[ @logintype = ] 'logintype'
Is the security level of the login being granted access. logintype is varchar(5), with a default of NULL. Only admin can be specified. If admin is specified, login is granted access to SQL Server, and added as a member of the sysadmin fixed server role.

Return Code Values

0 (success) or 1 (failure)

Remarks

xp_grantlogin is now a system stored procedure instead of an extended stored procedure. xp_grantlogin calls sp_grantlogin and sp_addsrvrolemember.

Permissions

Requires membership in the securityadmin fixed server role. When changing the logintype, requires membership in the sysadmin fixed server role.

See Also

sp_denylogin (Transact-SQL)
sp_grantlogin (Transact-SQL)
System Stored Procedures (Transact-SQL)
General Extended Stored Procedures (Transact-SQL)
xp_enumgroups (Transact-SQL)
xp_loginconfig (Transact-SQL)
xp_logininfo (Transact-SQL)
sp_revokelogin (Transact-SQL)