Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Add-AcctIdentityPoolScope

March 11, 2024
Contributed by: 
C

Add the specified identity pool(s) to the given scope(s).

Syntax


Add-AcctIdentityPoolScope [-Scope] <String[]> -InputObject <IdentityPool[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Add-AcctIdentityPoolScope [-Scope] <String[]> -IdentityPoolUid <Guid[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Add-AcctIdentityPoolScope [-Scope] <String[]> -IdentityPoolName <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

The Add-AcctIdentityPoolScope command is used to associate one or more identity pool objects with given scope(s).

To add an identity pool to a scope you need permission to change the scopes of the identity pool and permission to add objects to all of the scopes you have specified.

When attempting to add an identity pool to a scope it is already associated with, no change will be made.

The identity pools may be specified using the unique identifier, name, or as a powershell object.

Parameters

Name Description Required? Pipeline Input Default Value
Scope Specifies the scopes to add the objects to. true false  
InputObject The identity pool objects to be added. true true (ByValue, ByPropertyName)  
IdentityPoolUid The unique identifier for the identity pools to be added. true true (ByValue, ByPropertyName)  
IdentityPoolName The name of the identity pools to be added. true true (ByValue, ByPropertyName)  
LoggingId Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the Client IP of the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

None

Notes

If the command fails, the following errors can be returned.

  • UnknownObject: One of the specified objects was not found.

  • ScopeNotFound: One of the specified scopes was not found.

  • DatabaseError: An error occurred in the service while attempting a database operation.

  • DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.

  • DataStoreException: An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.

  • PermissionDenied: You do not have permission to execute this command with the specified objects or scopes.

  • AuthorizationError: There was a problem communicating with the Citrix Delegated Administration Service.

  • ConfigurationLoggingError: The operation could not be performed because of a configuration logging error.

  • CommunicationError: There was a problem communicating with the remote service.

  • ExceptionThrown: An unexpected error occurred. For more details, see the Windows event logs on the controller or the Citrix Virtual Apps and Desktops logs.

Examples

Example 1 


c:\PS>Add-AcctIdentityPoolScope Finance -IdentityPoolUid 6702C5D0-C073-4080-A0EE-EC74CB537C52

<!--NeedCopy-->

Description

Adds a single identity pool to the ‘Finance’ scope.

Example 2 


c:\PS>Add-AcctIdentityPoolScope Finance,Marketing -IdentityPoolUid 6702C5D0-C073-4080-A0EE-EC74CB537C52

<!--NeedCopy-->

Description

Adds a single identity pool to the multiple scopes.

Example 3 


c:\PS>Get-AcctIdentityPool | Add-AcctIdentityPoolScope Finance

<!--NeedCopy-->

Description

Adds all visible identity pool objects to the ‘Finance’ scope.

Example 4 


c:\PS>Add-AcctIdentityPoolScope Finance -IdentityPoolName A\*

<!--NeedCopy-->

Description

Adds identity pool objects with a name starting with an ‘A’ to the ‘Finance’ scope.

Add-AcctIdentityPoolScope
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.