Attribute
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Name |
string | ➖ | The name of the attribute. | userName |
Type |
AttributeDataTypeJson | ➖ | This is used to denote the type of the attribute. | string |
MultiValued |
bool | ➖ | Indicates if the attribute is multivalued. | true |
Description |
string | ➖ | The description of the attribute. | This Attribute describes the property |
Required |
bool | ➖ | True indicates the attribute is required. | true |
CaseExact |
bool | ➖ | True indicates the attribute is case sensitive. | false |
Mutability |
MutabilityJson | ➖ | This is used to denote the mutability of the attribute. | writeOnly |
CanonicalValues |
List<string> | ➖ | The list of canonical values of the attribute. | |
Returned |
AttributeReturnedTypeJson | ➖ | This is used to denote the returned type of the attribute. | always |
Uniqueness |
AttributeUniquenessTypeJson | ➖ | This is used to denote the uniqueness type of the attribute. | global |
ReferenceTypes |
List<AttributeReferenceTypeJson> | ➖ | This is used to denote the reference type of the attribute. | |
SubAttributes |
List<AttributeJson> | ➖ | A collection of sub-attributes. Has the same structure as this attribute object. |