Citrix Daas SDK

Reset-AcctIdentity

May 28, 2025

Contributed by:

Resets the given identity accounts in identity pool.

Syntax

Reset-AcctIdentity
     [-PrivilegedUserName <String>]
     [-PrivilegedUserPassword <SecureString>]
     [-Force]
     [-UseServiceAccount]
     [-LoggingId <Guid>]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Reset-AcctIdentity
     -IdentityAccountId <String[]>
     [-PrivilegedUserName <String>]
     [-PrivilegedUserPassword <SecureString>]
     [-Force]
     [-UseServiceAccount]
     [-LoggingId <Guid>]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Reset-AcctIdentity
     -IdentityAccountName <String[]>
     [-PrivilegedUserName <String>]
     [-PrivilegedUserPassword <SecureString>]
     [-Force]
     [-UseServiceAccount]
     [-LoggingId <Guid>]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Description

This provides the ability to reset identity accounts of the identity pool that behave abnormally. It resets “Tainted” accounts to “Available”.

If the current user does not have sufficient privileges to reset the identities, the PrivilegedUserName and PrivilegedUserPassword parameters must be used.

For the Hybrid Azure AD joined identity accounts, the userCertificate attributes will also be reset.

Examples

EXAMPLE 1

Resets the tainted accounts account and account2. After the reset operation, there are no more tainted accounts.

Get-AcctIdentity -State Tainted | Select-Object IdentityAccountName

IdentityAccountName
-------------
Domain\account
Domain\account2

Reset-AcctIdentity -IdentityAccountName "Domain\account","Domain\account2"

SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts
-----------------------       -------------------    --------------
2                         0    {}

Get-AcctIdentity -State Tainted
<!--NeedCopy-->

Parameters

-IdentityAccountName

The names of the identity accounts that are to be reset. AD based identity 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.

Type:	String[]
Aliases:	ADAccountName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentityAccountId

The ID(s) of the identity accounts that are to be reset. For AD based identity account, it should be SID

Type:	String[]
Aliases:	ADAccountSid
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName, ByValue)
Accept wildcard characters:	False

-PrivilegedUserName

The username for an user account in the identity provider (e.g., AD or Azure AD) with Write Permissions. This parameter must be used if the current user does not have the necessary privileges to modify accounts in identity provider.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PrivilegedUserPassword

The matching password for an user account in the identity provider (e.g., AD or Azure AD) with Write Permissions. This parameter must be used if the current user does not have the necessary privileges to modify accounts in identity provider.

Type:	SecureString
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Indicates whether accounts that are marked as ‘in-use’ can be reset or not.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseServiceAccount

Use the service account of IdentityPool to which the identity belongs to reset AD identity account.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

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

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

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

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.ADIdentity.Sdk.CommonAccountOperationSummary

The Reset-AcctIdentity command returns an object with the following parameters: SuccessfulAccountsCount <int>

The number of accounts that were repaired successfully.

FailedAccountsCount <int>

The number of accounts that were not repaired.

FailedAccounts <Citrix.ADIdentity.Sdk.IdentityError[]>

The list of accounts that failed to be repaired. Each one has the following parameters:

IdentityAccountName <string>

IdentityAccountId <String>

ErrorReason <ADIdentityStatus>

This can be one of the following

UnableToConvertDomain

IdentityNotLocatedInDomain

IdentityNotFound

IdentityObjectInUse

IdentityObjectLocked

ADServiceDatabaseError

ADServiceDatabaseNotConfigured

ADServiceStatusInvalidDb

FailedToConnectToDomainController

FailedToExecuteSearchInAD

FailedToAccessComputerAccountInAD

FailedToSetPasswordInAD

FailedToChangePasswordInAD

DiagnosticInformtion <Exception>

Any other error information

Notes

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

Error Codes

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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Reset-AcctIdentity

May 28, 2025

Contributed by:

May 28, 2025

Contributed by:

Reset-AcctIdentity

Syntax

Description

Examples

EXAMPLE 1

Parameters

-IdentityAccountName

-IdentityAccountId

-PrivilegedUserName

-PrivilegedUserPassword

-Force

-UseServiceAccount

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.ADIdentity.Sdk.CommonAccountOperationSummary

Notes

Related Links

In this article