Get-DSEntriesPermissions

2025-01-21

Get-DSEntriesPermissions

SYNOPSIS

Gets the permissions for all entries in a vault or for a specific entry

SYNTAX

VaultID (Default)

Get-DSEntriesPermissions [-VaultID] <guid> [-IncludePrincipalsName] [<CommonParameters>]

EntryID

Get-DSEntriesPermissions [-EntryID] <guid> [-IncludePrincipalsName] [<CommonParameters>]

VaultName

Get-DSEntriesPermissions [-VaultName] <string> [-IncludePrincipalsName] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Recursivly gets all permissions for all entries in a given vault or for a specific entry.

EXAMPLES

EXAMPLE 1

PS C:> Get-DSEntriesPermissions -VaultID $vaultID

Get all permisissions in the vault whose ID is stored in $vaultID.

EXAMPLE 2

PS C:> Get-DSEntriesPermissions -VaultName 'My Vault'

Get all permisissions in the vault name 'My Vault'.

EXAMPLE 3

PS C:> Get-DSEntriesPermissions -Entry $entryID

Get all permisissions for the entry whose ID is stored in $entryID.

PARAMETERS

-EntryID

ID of the entry

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: EntryID
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludePrincipalsName

Add a PrincipalsName field containing the name associated with the ids of the Principals field.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-VaultID

Id of the vault containing the entries

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: VaultID
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-VaultName

Name of the vault containing the entries. Case sensitive.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: VaultName
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Management.Automation.PSCustomObject

NOTES

For more information, type "Get-Help Get-DSEntriesPermissions -detailed". For technical information, type "Get-Help Get-DSEntriesPermissions -full".

RELATED LINKS