ClaimTypeDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Includes metadata about a claim type such as its name, whether it is required or static, validation regex, description, and value type information.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
extraProperties
required |
object | Extension data for custom properties.
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
id
required |
string (uuid) | Unique identifier of the claim type.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
name
required |
string | Unique name of the claim type (e.g., 'phone_number').
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
required
required |
boolean | True if a value for this claim type is required for users; otherwise false.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
isStatic
required |
boolean | True if the claim type is system-defined and cannot be deleted; otherwise false.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
regex
required |
string | Optional regular expression to validate the claim value.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
regexDescription
required |
string | Help text describing the validation rule/regex.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
description
required |
string | Short description of what the claim represents.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
valueType
required |
IdentityClaimValueType IdentityClaimValueType | The value type of the claim (e.g., String, Int, Boolean).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
valueTypeAsString
required |
string | String representation of the value type (useful for serialization).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
concurrencyStamp
required |
string | Concurrency token used to detect conflicting updates.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.