Claim.CreateUpnClaim(String) Method

Definition

Namespace:

System.IdentityModel.Claims

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

Claim.cs

Creates a Claim object that represents the specified Universal Principal Name (UPN).

public:
 static System::IdentityModel::Claims::Claim ^ CreateUpnClaim(System::String ^ upn);

public static System.IdentityModel.Claims.Claim CreateUpnClaim (string upn);

static member CreateUpnClaim : string -> System.IdentityModel.Claims.Claim

Public Shared Function CreateUpnClaim (upn As String) As Claim

Parameters

upn

String

The UPN of the entity associated with this claim. This parameter must not be null. If this parameter is null, this method throws an ArgumentNullException exception.

Returns

Claim

The Claim object this method creates.

Exceptions

ArgumentNullException

The upn parameter is null.

Remarks

The Claim object this method creates has the property values shown in the following table.

Property	Value
ClaimType	Upn
Resource	The value of the upn parameter.
Right	PossessProperty.