New-BrokerUniversalClaim
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>]
Description
Creates a new UniversalClaim object.
Examples
EXAMPLE 1
Creates a new UniversalClaim mapping
New-BrokerUniversalClaim -Claim AD:... -VirtualSid S-1-...1234 -DirectoryContext {..}
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: | None |
| 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.