Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
100 changes: 50 additions & 50 deletions xml/System.IdentityModel.Claims/Claim.xml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
## Remarks
The Identity Model is a claims-based authorization system. Claims describe the capabilities associated with some entity in the system, often a user of that system. The set of claims associated with a given entity can be thought of as a key. The particular claims define the shape of that key; much like a physical key is used to open a lock in a door. In this way, claims are used to gain access to resources. Access to a given protected resource is determined by comparing the claims required to access that resource with the claims associated with the entity that attempts access.

A claim is the expression of a right with respect to a particular value. A right could be read, write, or possess. A value could be a database, a file, a mailbox, or a property. Claims also have a claim type. The combination of claim type and right provides the mechanism for capabilities being specified with respect to the value. For example, a claim of type `file` with the right `read` over the value `biography.doc` indicates that the entity with such a claim has read access to the file biography.doc. A claim of type name with the right <xref:System.IdentityModel.Claims.Rights.PossessProperty%2A> over the value `Martin` indicates that the entity with the claim possesses a `Name` property with the value `Martin`.
A claim is the expression of a right with respect to a particular value. A right could be read, write, or possess. A value could be a database, a file, a mailbox, or a property. Claims also have a claim type. The combination of claim type and right provides the mechanism for capabilities being specified with respect to the value. For example, a claim of type `file` with the right `read` over the value `biography.doc` indicates that the entity with such a claim has read access to the file biography.doc. A claim of type name with the right <xref:System.IdentityModel.Claims.Rights.PossessProperty> over the value `Martin` indicates that the entity with the claim possesses a `Name` property with the value `Martin`.

Although various claim types and rights are defined as part of Identity Model, the system is extensible. The various systems building on top of the Identity Model infrastructure can define claim types and rights as required.

Expand Down Expand Up @@ -157,7 +157,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.IdentityModel.Claims.Claim.ClaimType%2A> property can be one of the pre-defined claim types that are represented by the static properties of the <xref:System.IdentityModel.Claims.ClaimTypes> class.
The <xref:System.IdentityModel.Claims.Claim.ClaimType> property can be one of the pre-defined claim types that are represented by the static properties of the <xref:System.IdentityModel.Claims.ClaimTypes> class.

Claim types specify the type of claim that is being asserted, such as an email address.

Expand Down Expand Up @@ -210,9 +210,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.DenyOnlySid%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `sid` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.DenyOnlySid>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `sid` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>.|

]]></format>
</remarks>
Expand Down Expand Up @@ -263,9 +263,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.Dns%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `dns` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.Dns>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `dns` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>|

]]></format>
</remarks>
Expand Down Expand Up @@ -315,9 +315,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.Hash%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `hash` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.Hash>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `hash` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>.|

]]></format>
</remarks>
Expand Down Expand Up @@ -361,9 +361,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.Email%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `mailAddress` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.Email>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `mailAddress` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>.|

]]></format>
</remarks>
Expand Down Expand Up @@ -413,9 +413,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.Name%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `name` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.Name>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `name` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>.|

]]></format>
</remarks>
Expand Down Expand Up @@ -461,9 +461,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.Rsa%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `rsa` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.Rsa>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `rsa` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>.|

]]></format>
</remarks>
Expand Down Expand Up @@ -513,9 +513,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.Spn%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `spn` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.Spn>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `spn` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>.|

]]></format>
</remarks>
Expand Down Expand Up @@ -565,9 +565,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.Thumbprint%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `thumbprint` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.Thumbprint>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `thumbprint` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>.|

]]></format>
</remarks>
Expand Down Expand Up @@ -617,9 +617,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.Upn%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `upn` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.Upn>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `upn` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>.|

]]></format>
</remarks>
Expand Down Expand Up @@ -669,9 +669,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.Uri%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `uri` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.Uri>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `uri` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>.|

]]></format>
</remarks>
Expand Down Expand Up @@ -721,9 +721,9 @@

|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>|<xref:System.IdentityModel.Claims.ClaimTypes.Sid%2A>|
|<xref:System.IdentityModel.Claims.Claim.Resource%2A>|The value of the `sid` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right%2A>|<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.|
|<xref:System.IdentityModel.Claims.Claim.ClaimType>|<xref:System.IdentityModel.Claims.ClaimTypes.Sid>|
|<xref:System.IdentityModel.Claims.Claim.Resource>|The value of the `sid` parameter.|
|<xref:System.IdentityModel.Claims.Claim.Right>|<xref:System.IdentityModel.Claims.Rights.PossessProperty>.|

]]></format>
</remarks>
Expand Down Expand Up @@ -772,14 +772,14 @@
## Remarks
The <xref:System.IdentityModel.Claims.Claim> object this method creates has the property values shown in the following table.

<xref:System.IdentityModel.Claims.Claim.ClaimType%2A>
<xref:System.IdentityModel.Claims.ClaimTypes.X500DistinguishedName%2A>
<xref:System.IdentityModel.Claims.Claim.ClaimType>
<xref:System.IdentityModel.Claims.ClaimTypes.X500DistinguishedName>

<xref:System.IdentityModel.Claims.Claim.Resource%2A>
<xref:System.IdentityModel.Claims.Claim.Resource>
The value of the `x500DistinguishedName` parameter.

<xref:System.IdentityModel.Claims.Claim.Right%2A>
<xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.
<xref:System.IdentityModel.Claims.Claim.Right>
<xref:System.IdentityModel.Claims.Rights.PossessProperty>.

]]></format>
</remarks>
Expand Down Expand Up @@ -821,7 +821,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
Use the value of the <xref:System.IdentityModel.Claims.Claim.DefaultComparer%2A> property to match any of the pre-defined claim types.
Use the value of the <xref:System.IdentityModel.Claims.Claim.DefaultComparer> property to match any of the pre-defined claim types.

]]></format>
</remarks>
Expand Down Expand Up @@ -867,16 +867,16 @@
<format type="text/markdown"><![CDATA[

## Remarks
This method overrides the <xref:System.Object.Equals%2A> method to provide equality comparisons for <xref:System.IdentityModel.Claims.Claim> objects. The comparison consists of three comparisons on the values of the <xref:System.IdentityModel.Claims.Claim.Right%2A>, <xref:System.IdentityModel.Claims.Claim.ClaimType%2A>, and <xref:System.IdentityModel.Claims.Claim.Resource%2A> properties. The comparison algorithm that is used on the <xref:System.IdentityModel.Claims.Claim.Resource%2A> property depends upon the value of the <xref:System.IdentityModel.Claims.Claim.ClaimType%2A> property. The following table details the comparison algorithm that is used for the specified claim type.
This method overrides the <xref:System.Object.Equals%2A> method to provide equality comparisons for <xref:System.IdentityModel.Claims.Claim> objects. The comparison consists of three comparisons on the values of the <xref:System.IdentityModel.Claims.Claim.Right>, <xref:System.IdentityModel.Claims.Claim.ClaimType>, and <xref:System.IdentityModel.Claims.Claim.Resource> properties. The comparison algorithm that is used on the <xref:System.IdentityModel.Claims.Claim.Resource> property depends upon the value of the <xref:System.IdentityModel.Claims.Claim.ClaimType> property. The following table details the comparison algorithm that is used for the specified claim type.

|Claim type|Comparison|
|----------------|----------------|
|<xref:System.IdentityModel.Claims.ClaimTypes.Dns%2A>|Case insensitive string comparison on the resource.|
|<xref:System.IdentityModel.Claims.ClaimTypes.Hash%2A>|Byte-by-byte comparison.|
|<xref:System.IdentityModel.Claims.ClaimTypes.Rsa%2A>|Byte-by-byte comparison on the Modulus and Exponent parts of the algorithm.|
|<xref:System.IdentityModel.Claims.ClaimTypes.Thumbprint%2A>|Byte-by-byte comparison.|
|<xref:System.IdentityModel.Claims.ClaimTypes.Upn%2A>|SID comparison.|
|<xref:System.IdentityModel.Claims.ClaimTypes.X500DistinguishedName%2A>|Normalized X.500 raw data comparison.|
|<xref:System.IdentityModel.Claims.ClaimTypes.Dns>|Case insensitive string comparison on the resource.|
|<xref:System.IdentityModel.Claims.ClaimTypes.Hash>|Byte-by-byte comparison.|
|<xref:System.IdentityModel.Claims.ClaimTypes.Rsa>|Byte-by-byte comparison on the Modulus and Exponent parts of the algorithm.|
|<xref:System.IdentityModel.Claims.ClaimTypes.Thumbprint>|Byte-by-byte comparison.|
|<xref:System.IdentityModel.Claims.ClaimTypes.Upn>|SID comparison.|
|<xref:System.IdentityModel.Claims.ClaimTypes.X500DistinguishedName>|Normalized X.500 raw data comparison.|

]]></format>
</remarks>
Expand Down Expand Up @@ -1001,7 +1001,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
Pre-defined values include <xref:System.IdentityModel.Claims.Rights.Identity%2A> and <xref:System.IdentityModel.Claims.Rights.PossessProperty%2A>.
Pre-defined values include <xref:System.IdentityModel.Claims.Rights.Identity> and <xref:System.IdentityModel.Claims.Rights.PossessProperty>.



Expand Down Expand Up @@ -1089,7 +1089,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The string that is returns contains the values of the <xref:System.IdentityModel.Claims.Claim.Right%2A> and <xref:System.IdentityModel.Claims.Claim.ClaimType%2A> properties.
The string that is returns contains the values of the <xref:System.IdentityModel.Claims.Claim.Right> and <xref:System.IdentityModel.Claims.Claim.ClaimType> properties.

]]></format>
</remarks>
Expand Down
Loading
Loading