SQL Server Database Users to Roles Mapping Report


By:   |   Updated: 2019-04-11   |   Comments (4)   |   Related: More > Security

Problem

Using SQL Server database roles, in my opinion, is the simplest security method to assign and manage user permissions. I think this is the most common method that Database Administrators (DBA) use to handle permissions using either fixed database roles or creating user-defined database roles. This comes from over two decades of doing SQL database administration work.

Traditionally SQL Server provides two types of database-level roles: fixed-database roles that are predefined in the database and user-defined database roles that you can create. The database roles are defined at the database level and exist on each database. When the DBA maps the logins to databases, he/she can also create members of these database roles that manage the security in the database.

To help illustrate the fixed database roles, below is an image that explains them (this is from Microsoft MSDN, https://docs.microsoft.com/en-us/sql/relational-databases/security/authentication-access/database-level-roles?view=sql-server-2017).

SQL Server Database Level Roles and Permissions

In SQL Server Management Studio (SSMS), when you click the user mapping tab, you can assign any database role in the database to a user, but you cannot see in a single screen all of the database roles assigned to each database user. In order to do that you must click on every user line and "collect" the database roles assigned to each user. Therefore, there is a need for a simple T-SQL tool that generates a "database users to database roles mapping", this tool should be able to map all the database roles or to focus on a single role.

Solution

My solution involves creating a simple T-SQL in-line table function that generates a users to database roles mapping. This function should be created and used in each application database.

The function gets one parameter containing the database role name. If the report is called to retrieve all database role mappings then it defaults to a value of '%' (meaning all values).

This function (dbo.dbRolesUsersMap) joins to (according to the system relationship model) three system tables:

sys.database_role_members s This system table returns one row on each member of each database role. Database users, application roles, and other database roles can be members of a database role
sys.database_principals This system table returns a row for each security principal in a SQL Server database
Sys.server_principals This system table Contains a row for every server-level principal

The function distinguishes between three main user types: SQL user, Windows user and Windows group. It focuses only on database user roles and filters out system and INFORMATION_SCHEMA roles from the result.

The function shows the following columns:

  1. The user type (Windows group / Windows user/ SQL user)
  2. The database user name
  3. The server login name associated with that user
  4. The assigned database role name

SQL Server Function to Show Users to Database Roles Mapping

SET ANSI_NULLS ON
GO

SET QUOTED_IDENTIFIER ON
GO

-- ================================================ 
-- Author:      Eli Leiba         
-- Create date: 24-03-2019            
-- Description: Simple Users to Database Roles mappings function           
-- ================================================
CREATE FUNCTION dbo.dbRolesUsersMap (@dbRole SYSNAME = '%')
RETURNS TABLE
AS
RETURN (
      SELECT 
        User_Type = 
           CASE mmbrp.[type] 
           WHEN 'G' THEN 'Windows Group' 
           WHEN 'S' THEN 'SQL User' 
           WHEN 'U' THEN 'Windows User' 
           END,
         Database_User_Name = mmbrp.[name],
         Login_Name = ul.[name],
         DB_Role = rolp.[name]
      FROM sys.database_role_members mmbr, -- The Role OR members associations table
         sys.database_principals rolp,     -- The DB Roles names table
         sys.database_principals mmbrp,    -- The Role members table (database users)
         sys.server_principals ul          -- The Login accounts table
      WHERE Upper (mmbrp.[type]) IN ( 'S', 'U', 'G' )
         -- No need for these system account types
         AND Upper (mmbrp.[name]) NOT IN ('SYS','INFORMATION_SCHEMA')
         AND rolp.[principal_id] = mmbr.[role_principal_id]
         AND mmbrp.[principal_id] = mmbr.[member_principal_id]
         AND ul.[sid] = mmbrp.[sid]
         AND rolp.[name] LIKE '%' + @dbRole + '%'
      )
GO

Sample Execution with the SQL Server In-Line Table Function

Generate the users to database roles mapping for the entire NorthwindTrainingDB database.

USE NorthwindTrainingDB
GO

SELECT * FROM dbo.dbRolesUsersMap (DEFAULT)
GO

Here are the results (on my server):

Sample Execution with the SQL Server In-Line Table Function

Generate only the users to database roles mapped to the db_ddlAdmin role in the NorthwindTrainingDB database.

USE NorthwindTrainingDB
GO

SELECT * FROM dbo.dbRolesUsersMap ('db_ddlAdmin')
GO			

Here are the results (on my server):

Results for DB-DDLAdmin
Next Steps
  • You can create and compile this simple function in each of your application databases and use it as a simple tool to generate a fast database user to database roles reports.
  • Note that the function is not limited to only the fix database roles. If user defined database roles exist and map to a user then it will show on the report, but its inner permission will be absent from the report.
  • The function was tested with for SQL Server 2014 and 2017, but it uses general SQL Server tables and functions so it should be compatible with SQL Server 2008 and above. The security system objects: sys.server_principals, sys.database_principals and sys.database_role_members all started with the SQL Server 2008 version.


Last Updated: 2019-04-11


get scripts

next tip button



About the author
MSSQLTips author Eli Leiba Eli Leiba is a senior application DBA, a teacher and a senior database consultant with 19 years of RDBMS experience.

View all my tips
Related Resources





Comments For This Article




Friday, July 17, 2020 - 3:52:25 AM - Arvi Laanemets Back To Top

I finaly got all database user roles for SQL Server instance - thanks to your code! The working code follows:

DECLARE @DBID int, @DBNAME VARCHAR(50), @INSTANCENAME VARCHAR(50)
DECLARE @GetDbUserOU VARCHAR(MAX), @SQL_SCRIPT VARCHAR(MAX)

SET @INSTANCENAME = CAST(ServerProperty('servername')AS VARCHAR(30))

TRUNCATE TABLE MyAdminDB.dbo.dummy_DbUserRoles

SELECT @DBID=MIN(database_id) FROM MyAdminDB.dbo.view_instance_databases

WHILE @DBID Is Not Null
BEGIN

SELECT @DBNAME=database_name FROM MyAdminDB.dbo.view_instance_databases WHERE database_id = @DBID

SET @GetDbUserOU = 
'
USE {DBNAME}

DECLARE @dbRole varchar(255)
SET @dbRole = ''%''

INSERT INTO MyAdminDB.dbo.dummy_DbUserRoles (InstanceName, DbName, LoginName, DbRole, DbUserName, DbUserType)
SELECT 
''' + @INSTANCENAME +''' AS InstanceName,
''' + @DBNAME +''' AS DbName,
Login_Name = ul.[name],
DB_Role = rolp.[name],
Database_User_Name = mmbrp.[name],
User_Type = 
CASE mmbrp.[type] 
WHEN ''G'' THEN ''Windows Group'' 
WHEN ''S'' THEN ''SQL User'' 
WHEN ''U'' THEN ''Windows User'' 
END
FROM 
sys.database_role_members mmbr, -- The Role OR members associations table
sys.database_principals rolp,     -- The DB Roles names table
sys.database_principals mmbrp,    -- The Role members table (database users)
sys.server_principals ul          -- The Login accounts table
WHERE 
Upper (mmbrp.[type]) IN ( ''S'', ''U'', ''G'' )
-- No need for these system account types
AND Upper (mmbrp.[name]) NOT IN (''SYS'',''INFORMATION_SCHEMA'')
AND rolp.[principal_id] = mmbr.[role_principal_id]
AND mmbrp.[principal_id] = mmbr.[member_principal_id]
AND ul.[sid] = mmbrp.[sid]
AND rolp.[name] LIKE ''%'' + @dbRole + ''%''
'
SET @SQL_SCRIPT = REPLACE(@GetDbUserOU, '{DBNAME}', @DBNAME)
EXECUTE (@SQL_SCRIPT)

SELECT @DBID=MIN(database_id) FROM MyAdminDB.dbo.view_instance_databases WHERE database_id > @DBID

END

TRUNCATE TABLE MyAdminDB.dbo.DbUserRoles

INSERT INTO MyAdminDB.dbo.DbUserRoles SELECT * FROM MyAdminDB.dbo.dummy_DbUserRoles

TRUNCATE TABLE MyAdminDB.dbo.dummy_DbUserRoles

Wednesday, July 08, 2020 - 4:55:05 AM - Arvi Laanemets Back To Top

How can I run this function with database name as parameter? E.g. I created the function in database 'utilities', and I call it from any databas on this SQL Server instance and ask database roles mapping for any database on this instance. The end goal is either to run a procedure which requeries roles mappings for all databases on instance, or when it is possible, then to create a recursive query, which does the same on one go.


Monday, December 23, 2019 - 10:36:30 AM - Daniel Back To Top

Thanks alot! one question, i can see i need to run this script on each database and list the users for that database. How can i change it so it lists all the database and users in the entire instance? 


Thursday, April 11, 2019 - 5:32:41 AM - Olu Back To Top

Brilliant! Very simple and very helpful. It will really help us to keep tabs on who has access to what



download


Recommended Reading

Enabling xp_cmdshell in SQL Server

Steps to Drop an Orphan SQL Server User when it owns a Schema or Role

Encrypting passwords for use with Python and SQL Server

Is your SQL Server environment ready for GDPR?

Understanding SQL Server fixed database roles





get free sql tips
agree to terms


Learn more about SQL Server tools