Citrix Daas SDK

New-BrokerUser

August 9, 2024

Contributed by:

C C

Creates a new broker user object

Syntax

New-BrokerUser
   [-SID] <SecurityIdentifier>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

New-BrokerUser
   [-Name] <String>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The New-BrokerUser cmdlet creates a new broker object to represent a user identity (or the identity of a group of users). The object is created local to the PowerShell environment in which the cmdlet is run; no new user object is created in the broker configuration, unless the object is added to another broker object, such as a machine or a desktop. For details, see Add-BrokerUser.

The identity of the user or group must be specified using either the Name or SID parameter

Examples

EXAMPLE 1

Create a broker user object for the specified user.

$user = New-BrokerUser DOMAIN\UserName
<!--NeedCopy-->

EXAMPLE 2

Create a broker user object for the specified user.

$user = New-BrokerUser -SID S-1-5-23-1763203430-193137401-908696819-3450
<!--NeedCopy-->

Parameters

-SID

The SID of the user or group

Type:	SecurityIdentifier
Position:	2
Default value:	Null
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the user or group

Type:	String
Position:	2
Default value:	Null
Required:	True
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 cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.User

The broker user object

Notes

Typically, broker user objects are created implicitly using the

Add-BrokerUser cmdlet with a user name or SID.

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

New-BrokerUser

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

New-BrokerUser

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-SID

-Name

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.User

Notes

Related Links

In this article