Citrix Daas SDK

New-BrokerUniversalClaim

August 9, 2024

Contributed by:

C C

A claim can be an arbitrary string up to 450 characters in length. Each Claim is mapped to a Virtual SID. Virtual SIDs are generated by either taking a SHA256 hash of the claim, and storing the hash bytes in a SID format, or in the case of a SID string being used as a Claim, the SID is copied to the VirtualSid.

Syntax

New-BrokerUniversalClaim
   [-ADDirectoryContext <String>]
   -Claim <String>
   [-DirectoryContext] <String>
   [-UniversalClaimsTenantContext <String>]
   [-VirtualSid] <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Creates a new UniversalClaim object.

Examples

EXAMPLE 1

Creates a new UniversalClaim mapping

New-BrokerUniversalClaim -Claim AD:... -VirtualSid S-1-...1234 -DirectoryContext {..}
<!--NeedCopy-->

Parameters

-VirtualSid

The VirtualSid for this UniversalClaim mapping.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-Claim

The Claim for this UniversalClaim mapping.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-DirectoryContext

The DirectoryContext associated with this UniversalClaim mapping.

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-ADDirectoryContext

The AD DirectoryContext associated with this UniversalClaim mapping.

Type:	String
Position:	Named
Default value:	Null
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-UniversalClaimsTenantContext

The UnivesalClaimsTenantContext for this UniversalClaim mapping.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop 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

Input cannot be piped to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.UniversalClaim

Get-BrokerUniversalClaim returns an object for each matching broker UniversalClaim mapping.

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

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

New-BrokerUniversalClaim

Syntax

Description

Examples

EXAMPLE 1

Parameters

-VirtualSid

-Claim

-DirectoryContext

-ADDirectoryContext

-UniversalClaimsTenantContext

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.UniversalClaim

Related Links

In this article