Get-DSADGroup

    2025-01-21

    Get-DSADGroup

    SYNOPSIS

    Get groups from a domain user PAM provider

    SYNTAX

    __AllParameterSets

    Get-DSADGroup [-ProviderID] <guid> [[-DN] <string>] [-AsJITSettings] [-AsLegacyResponse]
     [<CommonParameters>]
    

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get groups from a domain user PAM provider. It returns the groups of the oganizational unit specified by DN. If the DN parameter is not used, it will look at the root. It is not possible to fetch all groups directly. The data returned can be added to the JIT settings' authorized groups of the provider.

    EXAMPLES

    EXAMPLE

    PS C:> $getResponse = Get-DSPamProvider $provider = $getResponse | Where Label -eq 'MyDomainUserProvider' $desiredGroups = Get-DSADGroup -ProviderID $provider.ID -DN 'OU=Test,DC=mydomain,DC=loc' $provider.JitElevationSettings.AuthorizedGroups = $desiredGroups Update-DSPamProvider -InputObject $provider

    Add all groups of the 'Test' organizational unit in the JIT settings' authorized groups of the provider 'MyDomainUserProvider' and save the modification

    PARAMETERS

    -AsJITSettings

    Return the object as the JIT settings value. Useful it is not initialized in the provider.

    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: ''
    

    -AsLegacyResponse

    In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

    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: ''
    

    -DN

    Distinguished name of the container searched

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

    -ProviderID

    PAM Provider to obtain the domains from

    Type: System.Guid
    DefaultValue: ''
    SupportsWildcards: false
    ParameterValue: []
    Aliases: []
    ParameterSets:
    - Name: (All)
      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

    NOTES

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