Get-DbaDbUser

Want to see the source code for this command? Check out Get-DbaDbUser on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaDbUser.

Synopsis

Retrieves database user accounts and their associated login mappings from SQL Server databases

Description

Retrieves all database user accounts from one or more databases, showing their associated server logins, authentication types, and access states. This function is essential for security audits, user access reviews, and compliance reporting where you need to see who has database-level access and how their accounts are configured. You can filter results by specific users, logins, databases, or exclude system accounts to focus on custom user accounts that require regular review.

Syntax

Get-DbaDbUser
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [-ExcludeSystemUser]
    [[-User] <String[]>]
    [[-Login] <String[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaDbUser -SqlInstance sql2016

Gets all database users

Example: 2

PS C:\> Get-DbaDbUser -SqlInstance Server1 -Database db1

Gets the users for the db1 database

Example: 3

PS C:\> Get-DbaDbUser -SqlInstance Server1 -ExcludeDatabase db1

Gets the users for all databases except db1

Example: 4

PS C:\> Get-DbaDbUser -SqlInstance Server1 -ExcludeSystemUser

Gets the users for all databases that are not system objects, like 'dbo', 'guest' or 'INFORMATION_SCHEMA'

Example: 5

PS C:\> 'Sql1','Sql2/sqlexpress' | Get-DbaDbUser

Gets the users for the databases on Sql1 and Sql2/sqlexpress

Example: 6

PS C:\> Get-DbaDbUser -SqlInstance Server1 -Database db1 -User user1, user2

Gets the users 'user1' and 'user2' from the db1 database

Example: 7

PS C:\> Get-DbaDbUser -SqlInstance Server1 -Login login1, login2

Gets the users associated with the logins 'login1' and 'login2'

Required Parameters

-SqlInstance

The target SQL Server instance or instances

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

-Database

Specifies which databases to query for user accounts. Accepts multiple database names and supports wildcards.
Use this when you need to audit users in specific databases rather than scanning all databases on the instance.

-ExcludeDatabase

Specifies databases to skip when retrieving user accounts. Useful for excluding system databases or databases you don't manage.
Common practice is to exclude tempdb, model, or development databases when focusing on production user access reviews.

-ExcludeSystemUser

Excludes built-in system users like 'dbo', 'guest', 'INFORMATION_SCHEMA', and other system-created accounts.
Use this switch during security audits to focus only on custom user accounts that require regular access review and management.

-User

Filters results to specific database user names. Accepts multiple user names for targeted queries.
Use this when investigating specific user accounts or verifying permissions for particular users during access reviews or troubleshooting.

-Login

Filters results to database users associated with specific server logins. Shows which databases a login has user accounts in.
Essential for understanding a login's database-level access across the instance, especially during user access audits or when removing departing employees.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.