Chat now with support
Chat with Support

Identity Manager Data Governance Edition 8.0 - IT Shop Resource Access Requests User Guide

Introduction Resource access requests Share creation requests Appendix: PowerShell commands About us

Adding the PowerShell snap-ins

Data Governance Edition comes with a Windows PowerShell snap-in for you to use to manage your environment.

If you installed Windows PowerShell on your computer after you installed the Data Governance server, you must register the cmdlets before you can start using them in Windows PowerShell.

To import the Data Governance Edition PowerShell module

  1. Open a Windows PowerShell window and type the following at the Windows PowerShell command prompt:

    Import-Module "<path>"

    Where <path> is the file path for the QAM.Client.PowerShell.dll assembly. By default, the <path> for the Data Governance server machine is "C:\Program Files\One Identity\One Identity Manager\QAM.Client.PowerShell.dll".

  2. To verify that the module was added, type the following at the Windows PowerShell command prompt:

    Get-Module -All

    The registered PowerShell modules are listed.

Note: Run the Set-QServiceConnection command before you can use any of the Data Governance Edition commands.

Adding the module automatically to new sessions

If you do not want to manually add the Data Governance Edition PowerShell module each time you start a new Windows PowerShell session, you can modify the Windows PowerShell profile file so that it is added automatically for you.

To add the Data Governance Edition PowerShell module automatically when you start a new Windows PowerShell session

  • Add the following line to the Windows PowerShell profile file (profile.ps1) file:

    Import-Module "<path>"

    The location of the Windows PowerShell profile file is as follows: WINDOWS\system32\windowspowershell\v1.0

Note: If you get the error message "...profile.ps1 cannot be loaded because the execution of scripts is disabled" the next time you start a new Windows PowerShell session, type the following at the Windows PowerShell command prompt:

Set-ExecutionPolicy RemoteSigned

Then, type the following at the Windows PowerShell command prompt to confirm that the execution policy has been changed:

Get-ExecutionPolicy RemoteSigned

Self-service request information

These PowerShell commands allow you to view information about the self-service request configuration.

For full parameter details and examples, click a command in the table or see the command help, using the Get-Help command.

Table 4: Self-service request information commands

Use this command

If you want to

Get-QSelfServiceClientConfiguration View the options available for self-service requests within the IT Shop.
Set-QSelfServiceClientConfiguration Set the options available for self-service requests within the IT Shop.
Get-QSelfServiceMethodsToSatisfyRequest View the group membership that is required to satisfy an access request.

Get-QSelfServiceClientConfiguration

Returns the options available for self-service requests within the IT Shop.

Syntax:

Get-QSelfServiceClientConfiguration [<CommonParameters>]

Examples:
Table 5: Examples
Example Description
Get-QSelfServiceClientConfiguration Returns the self-service client configuration information.
Details retrieved:
Table 6: Details retrieved
Detail Description
AllowNonPublishedGroups Indicates whether groups that have not been published to the IT Shop are allowed for self-service access requests.
AllowUnsynchronizedGroups Indicates whether groups that have not been synchronized with One Identity Manager are allowed for self-service access requests.
MaximumMethodsCount The maximum number of groups returned from a call to the Get-QSelfServiceMethodsToSatisfyRequest, which returns the groups that satisfy a resource access request.
EnableSelfServiceAccessRequest Indicates whether self-service access requests are enabled in the IT Shop.

Set-QSelfServiceClientConfiguration

Sets the options available for self-service requests within the IT Shop.

Syntax:

Set-QSelfServiceClientConfiguration [-MaximumMethodsCount] <Int32> [-EnableSelfServiceAccessRequest] <Boolean> [-AllowNonPublishedGroups] <Boolean> [-AllowUnsynchronizedGroups] <Boolean> [<CommonParameters>]

Table 7: Parameters
Parameter Description
MaximumMethodsCount Specify the maximum number of groups that are to be returned from a call to the GetMethodsToSatisfyRequest.
EnableSelfServiceAccessRequest

Specify whether self-service access requests are to be enabled in the IT Shop.

Valid values are:

  • 0: Disable self-service access requests
  • 1: Enable self-service access requests
AllowNonPublishedGroups

Specify whether groups that have not been published to the IT Shop are to be included in self-service access requests.

Valid values are:

  • 0: Unpublished groups will not be available for self-service access requests in the IT Shop.
  • 1: Unpublished groups will be available for self-service access requests in the IT Shop.
AllowUnsynchronizedGroups

Specify whether groups that have not been synchronized with One Identity Manager are to be included in self-service requests.

Valid values are:

  • 0: Unsynchronized groups will not be available for self-service access requests in the IT Shop.
  • 1: Unsynchronized groups will be available for self-service access requests in the IT Shop.
Examples:
Table 8: Examples
Example Description

Set-QSelfServiceClientConfiguration -MaximumMethodsCount 1 -EnableSelfServiceAccessRequest 1 -AllowNonPublishedGroups 1 -AllowUnsynchronizedGroups 1

Sets the self-service client configuration information:

  • Enabling self-service access requests
  • Making unpublished groups available for self-service access requests in the IT Shop
  • Making unsynchronized groups available for self-service access requests in the IT Shop
Related Documents