Get-DbaUserPermission

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

Synopsis

Displays detailed permissions information for the server and database roles and securables.

Description

This command will display all server logins, server level securables, database logins and database securables.

DISA STIG implementors will find this command useful as it uses Permissions.sql provided by DISA.

Note that if you Ctrl-C out of this command and end it prematurely, it will leave behind a STIG schema in tempdb.

Syntax

Get-DbaUserPermission
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [-ExcludeSystemDatabase]
    [-IncludePublicGuest]
    [-IncludeSystemObjects]
    [-ExcludeSecurables]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaUserPermission -SqlInstance sql2008, sqlserver2012

Check server and database permissions for servers sql2008 and sqlserver2012.

Example: 2

PS C:\> Get-DbaUserPermission -SqlInstance sql2008 -Database TestDB

Check server and database permissions on server sql2008 for only the TestDB database

Example: 3

PS C:\> Get-DbaUserPermission -SqlInstance sql2008 -Database TestDB -IncludePublicGuest -IncludeSystemObjects

Check server and database permissions on server sql2008 for only the TestDB database,
including public and guest grants, and sys schema objects.

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

The database(s) to process - this list is auto-populated from the server. If unspecified, all databases will be processed.

-ExcludeDatabase

The database(s) to exclude - this list is auto-populated from the server

-ExcludeSystemDatabase

Allows you to suppress output on system databases

-IncludePublicGuest

Allows you to include output for public and guest grants.

-IncludeSystemObjects

Allows you to include output on sys schema objects.

-ExcludeSecurables

Allows you to exclude object-level permissions from the output, and only return role permission(s).

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