Get-DbaDbOrphanUser

Synopsis

Get orphaned users.

Description

An orphan user is defined by a user that does not have their matching login. (Login property = “”).

Syntax

Get-DbaDbOrphanUser
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaDbOrphanUser -SqlInstance localhost\sql2016

Finds all orphan users without matching Logins in all databases present on server ’localhost\sql2016’.

Example: 2

PS C:\> Get-DbaDbOrphanUser -SqlInstance localhost\sql2016 -SqlCredential $cred

Finds all orphan users without matching Logins in all databases present on server ’localhost\sql2016’. SQL Server authentication will be used in connecting to the server.

Example: 3

PS C:\> Get-DbaDbOrphanUser -SqlInstance localhost\sql2016 -Database db1

Finds orphan users without matching Logins in the db1 database present on server ’localhost\sql2016’.

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 check for orphaned users. Accepts database names, wildcards, or arrays.
Use this when you need to focus the orphaned user search on specific databases rather than checking all databases on the instance.

-ExcludeDatabase

Specifies databases to skip when checking for orphaned users. Useful for excluding system databases or databases under maintenance.
Commonly used to exclude tempdb, distribution, or databases where orphaned users are expected and acceptable.

-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.