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

Set-AcctADAccountUserCert

August 3, 2023
Contributed by: 
C

Set userCertificate for the given Active Directory (AD) accounts.

Syntax


Set-AcctADAccountUserCert [-IdentityPoolName] <String> -ADAccountName <String[]> [-ADUserName <String>] [-ADPassword <SecureString>] [-Force] [-BatchSize <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-AcctADAccountUserCert [-IdentityPoolName] <String> -ADAccountSid <String[]> [-ADUserName <String>] [-ADPassword <SecureString>] [-Force] [-BatchSize <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-AcctADAccountUserCert [-IdentityPoolName] <String> -AllAccounts [-ADUserName <String>] [-ADPassword <SecureString>] [-Force] [-BatchSize <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-AcctADAccountUserCert -IdentityPoolUid <Guid> -ADAccountName <String[]> [-ADUserName <String>] [-ADPassword <SecureString>] [-Force] [-BatchSize <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-AcctADAccountUserCert -IdentityPoolUid <Guid> -ADAccountSid <String[]> [-ADUserName <String>] [-ADPassword <SecureString>] [-Force] [-BatchSize <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-AcctADAccountUserCert -IdentityPoolUid <Guid> -AllAccounts [-ADUserName <String>] [-ADPassword <SecureString>] [-Force] [-BatchSize <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to set the userCertificate attribute for given accounts in Active Directory (AD).

The user performing the operation in PowerShell must have sufficient privileges in AD to set the userCertificate attribute. If the current user does not have sufficient privileges, the ADUserName and ADPassword parameters may be used instead.

Parameters

Name Description Required? Pipeline Input Default Value
IdentityPoolName The name of the identity pool containing the accounts to have userCertificate set. true false  
ADAccountName The AD account name to be set with userCertificate.      
Active Directory accounts are accepted in the following formats: Fully qualified DN e.g. CN=MyComputer,OU=Computers,DC=MyDomain,DC=Com; UPN format e.g MyComputer@MyDomain.Com; Domain qualified e.g MyDomain\MyComputer. true false    
ADAccountSid The SID for the AD account to be set with userCertificate. true true (ByPropertyName)  
AllAccounts Indicates if all accounts should be set with userCertificate. true false false
IdentityPoolUid The unique identifier of the identity pool containing the accounts to have userCertificate set. true true (ByPropertyName)  
ADUserName The username for an AD user account with Write Permissions. This parameter must be used if the current user does not have the necessary privileges. false false  
ADPassword The matching password for an AD user account with Write Permissions. This parameter must be used if the current user does not have the necessary privileges. false false  
Force Indicates if accounts that are marked as ‘in-use’ can be set with userCertificate. false false false
BatchSize Specifies the number of accounts to set user certificate in one batch to AD Identity Service. false false 50
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  
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 Specifies the address of a Citrix Virtual Apps and Desktops controller that the PowerShell snap-in connects 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

Citrix.Adidentity.Sdk.Accountoperationsummary

The Set-AcctADAccountUserCert command returns an object with the following parameters:

  • SuccessfulAccountsCount <int> The number of accounts that were successfully set with userCertificate.

  • FailedAccountsCount <int> The number of accounts that were failed to set with userCertificate.

  • FailedAccounts <Citrix.ADIdentity.Sdk.AccountError[]> The list of accounts that failed to be set with userCertificate. Each one has the following parameters:

  • ADAccountName <string>

  • ADAccountSid <String>

  • ErrorReason <ADIdentityStatus> This can be one of the following: IdentityObjectNotFound IdentityObjectLocked IdentityObjectInUse IdentityPoolObjectNotFound ADServiceDatabaseError ADServiceDatabaseNotConfigured ADServiceStatusInvalidDb FailedToConnectToDomainController FailedToGenerateDeviceKeyPair FailedToAccessComputerAccountInAD

  • DiagnosticInformation <Exception> Any other error information

Notes

In the case of failure, the following errors can result.

  • PermissionDenied: The user does not have administrative rights to perform this operation.

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

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

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

  • CommunicationError: An error occurred while communicating with the service.

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

Examples

Example 1 


C:\PS>Set-AcctADAccountUserCert -IdentityPoolName MyPool -ADAccountName "Domain\account","Domain\account2"

          SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts

          -----------------------       -------------------    --------------

          2                         0    {}

<!--NeedCopy-->

Description

Set userCertificate for two accounts (account and account2) in the identity pool called “MyPool”.

Example 2 


C:\PS>Set-AcctADAccountUserCert -IdentityPoolName MyPool -ADAccountName "Domain\account","Domain\account2" -Force

            SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts

            -----------------------       -------------------    --------------

            2                         0    {}

<!--NeedCopy-->

Description

Set userCertificate for two accounts (account and account2) in the identity pool called “MyPool”. The accounts are set regardless of whether they are in the ‘inUse’ state or not.

Example 3 


C:\PS>Set-AcctADAccountUserCert -IdentityPoolName MyPool -ADAccountName "Domain\account","Domain\account2" -OutVariable result

            SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts

            -----------------------       -------------------    --------------

            1                                               1    {account2}

            C:\PS>$result[0].FailedAccounts

          ADAccountName                 ADAccountSid           ErrorReason

          -------------                 -------------          ------------

          Domain\account2               account2               IdentityObjectLocked

<!--NeedCopy-->

Description

Shows failure of setting of one of two accounts and how to retrieve the failure reason.

Example 4 


C:\PS>Set-AcctADAccountUserCert -IdentityPoolName MyPool -ADAccountSid S-1-5-21-1315084875-1285793635-2418178940-2685

            SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts

            -----------------------       -------------------    --------------

            1                                               0    {}

<!--NeedCopy-->

Description

Set userCertificate for one account (S-1-5-21-1315084875-1285793635-2418178940-2685) in the identity pool called “MyPool”.

Set-AcctADAccountUserCert
August 3, 2023
Contributed by: 
C
August 3, 2023
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.