Skip to content

sp-grantdbaccess-transact-sql.md

Latest commit

 

History

History
72 lines (55 loc) · 3.41 KB

sp-grantdbaccess-transact-sql.md

File metadata and controls

72 lines (55 loc) · 3.41 KB
description sp_grantdbaccess (Transact-SQL)
title sp_grantdbaccess (Transact-SQL) | Microsoft Docs
ms.custom
ms.date 06/10/2016
ms.prod sql
ms.prod_service database-engine
ms.reviewer
ms.technology system-objects
ms.topic reference
f1_keywords
sp_grantdbaccess
sp_grantdbaccess_TSQL
dev_langs
TSQL
helpviewer_keywords
sp_grantdbaccess
ms.assetid 3eb09513-03f1-42f8-9917-3a1f3a579bec
ms.author vanto
author VanMSFT

sp_grantdbaccess (Transact-SQL)

[!INCLUDE SQL Server]

Adds a database user to the current database.

Important

[!INCLUDEssNoteDepFutureAvoid] Use CREATE USER instead.

Topic link icon Transact-SQL Syntax Conventions

Syntax

sp_grantdbaccess [ @loginame = ] 'login'  
    [ , [ @name_in_db = ] 'name_in_db' [ OUTPUT ] ]

Arguments

[ @loginame = ] 'login_ ' Is the name of the Windows group, Windows login or [!INCLUDEssNoVersion] login to be mapped to the new database user. Names of Windows groups and Windows logins must be qualified with a Windows domain name in the form Domain\login; for example, LONDON\Joeb. The login cannot already be mapped to a user in the database. login is a sysname, with no default.

[ @name_in_db = ] 'name_in_db' [ OUTPUT] Is the name for the new database user. name_in_db is an OUTPUT variable with a data type of sysname, and a default of NULL. If not specified, login is used. If specified as an OUTPUT variable with a value of NULL, @name_in_db is set to login. name_in_db must not already exist in the current database.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_grantdbaccess calls CREATE USER, which supports additional options. For information about creating database users, see CREATE USER (Transact-SQL). To remove a database user from a database, use DROP USER.

sp_grantdbaccess cannot be executed within a user-defined transaction.

Permissions

Requires membership in the db_owner fixed database role or the db_accessadmin fixed database role.

Examples

The following example uses CREATE USER to add a database user for the Windows login Edmonds\LolanSo to the current database. The new user is named Lolan. This is the preferred method for creating a database user.

CREATE USER Lolan FOR LOGIN [Edmonds\LolanSo];  
GO

See Also

Security Stored Procedures (Transact-SQL)
CREATE USER (Transact-SQL)
DROP USER (Transact-SQL)
System Stored Procedures (Transact-SQL)