Class SchemaSubAttributes
A list specifying the contained attributes
Inherited Members
Namespace: Oci.IdentitydomainsService.Models
Assembly: OCI.DotNetSDK.Identitydomains.dll
Syntax
public class SchemaSubAttributesProperties
CanonicalValues
Declaration
[JsonProperty(PropertyName = "canonicalValues")]
public List<string> CanonicalValues { get; set; }Property Value
| Type | Description |
|---|---|
| List<string> | A collection of canonical values. Applicable Service Providers MUST specify the canonical types specified in the core schema specification--for example, \"work\", \"home\".
|
CaseExact
Declaration
[JsonProperty(PropertyName = "caseExact")]
public bool? CaseExact { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies if the String attribute is case-sensitive
|
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| string | Attribute's human-readable description
|
IdcsAddedSinceReleaseNumber
Declaration
[JsonProperty(PropertyName = "idcsAddedSinceReleaseNumber")]
public string IdcsAddedSinceReleaseNumber { get; set; }Property Value
| Type | Description |
|---|---|
| string | Indicates that the schema has been added since this release number
|
IdcsAddedSinceVersion
Declaration
[JsonProperty(PropertyName = "idcsAddedSinceVersion")]
public int? IdcsAddedSinceVersion { get; set; }Property Value
| Type | Description |
|---|---|
| int? | Indicates that the schema has been added since version
|
IdcsAttributeCacheable
Declaration
[JsonProperty(PropertyName = "idcsAttributeCacheable")]
public bool? IdcsAttributeCacheable { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \"attributesToGet\" while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.
|
IdcsAttributeMappable
Declaration
[JsonProperty(PropertyName = "idcsAttributeMappable")]
public bool? IdcsAttributeMappable { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP. If isSchemaMappable: false for the schema in which this attribute is defined, then this flag is ignored.
|
IdcsAuditable
Declaration
[JsonProperty(PropertyName = "idcsAuditable")]
public bool? IdcsAuditable { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies whether changes to this attribute value will be audited
|
IdcsCanonicalValueSourceDisplayAttrName
Declaration
[JsonProperty(PropertyName = "idcsCanonicalValueSourceDisplayAttrName")]
public string IdcsCanonicalValueSourceDisplayAttrName { get; set; }Property Value
| Type | Description |
|---|---|
| string | Display name for the canonical value attribute name.
|
IdcsCanonicalValueSourceFilter
Declaration
[JsonProperty(PropertyName = "idcsCanonicalValueSourceFilter")]
public string IdcsCanonicalValueSourceFilter { get; set; }Property Value
| Type | Description |
|---|---|
| string | Filter to use when getting canonical values for this schema attribute
|
IdcsCanonicalValueSourceKeyAttrName
Declaration
[JsonProperty(PropertyName = "idcsCanonicalValueSourceKeyAttrName")]
public string IdcsCanonicalValueSourceKeyAttrName { get; set; }Property Value
| Type | Description |
|---|---|
| string | Source key attribute for the canonical value.
|
IdcsCanonicalValueSourceResourceType
Declaration
[JsonProperty(PropertyName = "idcsCanonicalValueSourceResourceType")]
public string IdcsCanonicalValueSourceResourceType { get; set; }Property Value
| Type | Description |
|---|---|
| string | Specifies the Resource type to read from for dynamic canonical values
|
IdcsCanonicalValueSourceResourceTypeID
Declaration
[JsonProperty(PropertyName = "idcsCanonicalValueSourceResourceTypeID")]
public string IdcsCanonicalValueSourceResourceTypeID { get; set; }Property Value
| Type | Description |
|---|---|
| string | Specifies the Resource type ID to read from for dynamic canonical values
|
IdcsCsvAttributeName
Declaration
[JsonProperty(PropertyName = "idcsCsvAttributeName")]
public string IdcsCsvAttributeName { get; set; }Property Value
| Type | Description |
|---|---|
| string | The attribute that defines the CSV header name for import/export
|
IdcsDefaultValue
Declaration
[JsonProperty(PropertyName = "idcsDefaultValue")]
public string IdcsDefaultValue { get; set; }Property Value
| Type | Description |
|---|---|
| string | Specifies the default value for an attribute. The value must be one from canonicalValues if defined.
|
IdcsDeprecatedSinceReleaseNumber
Declaration
[JsonProperty(PropertyName = "idcsDeprecatedSinceReleaseNumber")]
public string IdcsDeprecatedSinceReleaseNumber { get; set; }Property Value
| Type | Description |
|---|---|
| string | Indicates that the schema has been deprecated since this release number
|
IdcsDeprecatedSinceVersion
Declaration
[JsonProperty(PropertyName = "idcsDeprecatedSinceVersion")]
public int? IdcsDeprecatedSinceVersion { get; set; }Property Value
| Type | Description |
|---|---|
| int? | Indicates that the schema has been deprecated since version
|
IdcsDisplayName
Declaration
[JsonProperty(PropertyName = "idcsDisplayName")]
public string IdcsDisplayName { get; set; }Property Value
| Type | Description |
|---|---|
| string | Specifies the user-friendly displayable attribute name or catalog key used for localization
|
IdcsDisplayNameMessageId
Declaration
[JsonProperty(PropertyName = "idcsDisplayNameMessageId")]
public string IdcsDisplayNameMessageId { get; set; }Property Value
| Type | Description |
|---|---|
| string | Localized schema attribute display name for use by UI client for displaying attribute labels
|
IdcsExcludeFromUpgradePatch
Declaration
[JsonProperty(PropertyName = "idcsExcludeFromUpgradePatch")]
public bool? IdcsExcludeFromUpgradePatch { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies whether the attribute should be excluded from the BulkApi patch generated by gradle task for upgrading OOTB resources.
|
IdcsFromTargetMapper
Declaration
[JsonProperty(PropertyName = "idcsFromTargetMapper")]
public string IdcsFromTargetMapper { get; set; }Property Value
| Type | Description |
|---|---|
| string | Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics
|
IdcsGenerated
Declaration
[JsonProperty(PropertyName = "idcsGenerated")]
public bool? IdcsGenerated { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies whether this attribute value was generated
|
IdcsIndirectRefResourceAttributes
Declaration
[JsonProperty(PropertyName = "idcsIndirectRefResourceAttributes")]
public List<string> IdcsIndirectRefResourceAttributes { get; set; }Property Value
| Type | Description |
|---|---|
| List<string> | Specifies the indirectly referenced Resources
|
IdcsInternal
Declaration
[JsonProperty(PropertyName = "idcsInternal")]
public bool? IdcsInternal { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies whether the schema attribute is for internal use only. Internal attributes are not exposed via REST. This attribute overrides mutability for create/update if the request is internal and the attribute internal flag is set to True. This attribute overrides the return attribute while building SCIM response attributes when both the request is internal and the schema attribute is internal.
|
IdcsMaxLength
Declaration
[JsonProperty(PropertyName = "idcsMaxLength")]
public int? IdcsMaxLength { get; set; }Property Value
| Type | Description |
|---|---|
| int? | Specifies the maximum length of this attribute
|
IdcsMaxValue
Declaration
[JsonProperty(PropertyName = "idcsMaxValue")]
public int? IdcsMaxValue { get; set; }Property Value
| Type | Description |
|---|---|
| int? | Specifies the maximum value of the integer attribute
|
IdcsMaxValuesReturned
Declaration
[JsonProperty(PropertyName = "idcsMaxValuesReturned")]
public int? IdcsMaxValuesReturned { get; set; }Property Value
| Type | Description |
|---|---|
| int? | SCIM++ Properties:
|
IdcsMinLength
Declaration
[JsonProperty(PropertyName = "idcsMinLength")]
public int? IdcsMinLength { get; set; }Property Value
| Type | Description |
|---|---|
| int? | Specifies the minimum length of this attribute
|
IdcsMinValue
Declaration
[JsonProperty(PropertyName = "idcsMinValue")]
public int? IdcsMinValue { get; set; }Property Value
| Type | Description |
|---|---|
| int? | Specifies the minimum value of the integer attribute
|
IdcsOneValueMustBeTrue
Declaration
[JsonProperty(PropertyName = "idcsOneValueMustBeTrue")]
public bool? IdcsOneValueMustBeTrue { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, ARM will ensure atleast one of the instances of CMVA has the attribute value set to true.
|
IdcsOnlyOneValueCanBeTrue
Declaration
[JsonProperty(PropertyName = "idcsOnlyOneValueCanBeTrue")]
public bool? IdcsOnlyOneValueCanBeTrue { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, specifies that the sub attribute value can be set to true on one and only one instance of the CMVA.
|
IdcsPii
Declaration
[JsonProperty(PropertyName = "idcsPii")]
public bool? IdcsPii { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies whether the attribute is PII (personal information). False by default for all attributes. If attribute with idcsPii = true, it's value must be obfuscated before it's written to the Oracle Identity Cloud Service system logs.
|
IdcsRefResourceAttributes
Declaration
[JsonProperty(PropertyName = "idcsRefResourceAttributes")]
public List<string> IdcsRefResourceAttributes { get; set; }Property Value
| Type | Description |
|---|---|
| List<string> | Specifies the directly referenced Resources
|
IdcsRequiresImmediateReadAfterWriteForAccessFlows
Declaration
[JsonProperty(PropertyName = "idcsRequiresImmediateReadAfterWriteForAccessFlows")]
public bool? IdcsRequiresImmediateReadAfterWriteForAccessFlows { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that the attribute value must be written to the home region and requires immediate read-after-write consistency for access flows initiated from a replica region.
|
IdcsRequiresWriteForAccessFlows
Declaration
[JsonProperty(PropertyName = "idcsRequiresWriteForAccessFlows")]
public bool? IdcsRequiresWriteForAccessFlows { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that the attribute value must be written to the home region for access flows initiated from a replica region.
|
IdcsReturnEmptyWhenNull
Declaration
[JsonProperty(PropertyName = "idcsReturnEmptyWhenNull")]
public bool? IdcsReturnEmptyWhenNull { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies if the attribute is required
|
IdcsRtsaHideAttribute
Declaration
[JsonProperty(PropertyName = "idcsRtsaHideAttribute")]
public bool? IdcsRtsaHideAttribute { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies if the attributes in this schema can be displayed externally
|
IdcsSanitize
Declaration
[JsonProperty(PropertyName = "idcsSanitize")]
public bool? IdcsSanitize { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies if the value of the attribute should be sanitized using OWASP library for HTML content
|
IdcsScimCompliant
Declaration
[JsonProperty(PropertyName = "idcsScimCompliant")]
public bool? IdcsScimCompliant { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Indicates if the attribute is scim compliant, default is true
|
IdcsSearchable
Declaration
[JsonProperty(PropertyName = "idcsSearchable")]
public bool? IdcsSearchable { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies whether this attribute can be included in a search filter
|
IdcsSensitive
Declaration
[JsonProperty(PropertyName = "idcsSensitive")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SchemaSubAttributes.IdcsSensitiveEnum? IdcsSensitive { get; set; }Property Value
| Type | Description |
|---|---|
| SchemaSubAttributes.IdcsSensitiveEnum? | Specifiees if the attribute should be encrypted or hashed
|
IdcsTargetAttributeName
Declaration
[JsonProperty(PropertyName = "idcsTargetAttributeName")]
public string IdcsTargetAttributeName { get; set; }Property Value
| Type | Description |
|---|---|
| string | Target attribute name that this attribute gets mapped to for persistence
|
IdcsTargetAttributeNameToMigrateFrom
Declaration
[JsonProperty(PropertyName = "idcsTargetAttributeNameToMigrateFrom")]
public string IdcsTargetAttributeNameToMigrateFrom { get; set; }Property Value
| Type | Description |
|---|---|
| string | Old Target attribute name from child table for CSVA attribute prior to migration. This maintains this attribute used to get mapped to for persistence
|
IdcsTargetNormAttributeName
Declaration
[JsonProperty(PropertyName = "idcsTargetNormAttributeName")]
public string IdcsTargetNormAttributeName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
IdcsTargetUniqueConstraintName
Declaration
[JsonProperty(PropertyName = "idcsTargetUniqueConstraintName")]
public string IdcsTargetUniqueConstraintName { get; set; }Property Value
| Type | Description |
|---|---|
| string | Target index name created for this attribute for performance
|
IdcsToTargetMapper
Declaration
[JsonProperty(PropertyName = "idcsToTargetMapper")]
public string IdcsToTargetMapper { get; set; }Property Value
| Type | Description |
|---|---|
| string | Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics
|
IdcsTrimStringValue
Declaration
[JsonProperty(PropertyName = "idcsTrimStringValue")]
public bool? IdcsTrimStringValue { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Trims any leading and trailing blanks from String values. Default is True.
|
IdcsValidateReference
Declaration
[JsonProperty(PropertyName = "idcsValidateReference")]
public bool? IdcsValidateReference { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Validate payload reference value during create, replace, and update. Default is True.
|
IdcsValuePersisted
Declaration
[JsonProperty(PropertyName = "idcsValuePersisted")]
public bool? IdcsValuePersisted { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies whether the sub-attribute of the Resource attribute is persisted
|
IdcsValuePersistedInOtherAttribute
Declaration
[JsonProperty(PropertyName = "idcsValuePersistedInOtherAttribute")]
public bool? IdcsValuePersistedInOtherAttribute { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, ARM should not validate the value of the attribute since it will be converted/migrated to another attribute internally by the manager which will build valid post, put, or patch payload, depending on the client requested operation
|
IdcsuiOrder
Declaration
[JsonProperty(PropertyName = "idcsuiOrder")]
public int? IdcsuiOrder { get; set; }Property Value
| Type | Description |
|---|---|
| int? | Metadata used by Oracle Identity Cloud Service UI to sequence the attributes displayed on the Account Form.
|
IdcsuiRegexp
Declaration
[JsonProperty(PropertyName = "idcsuiRegexp")]
public string IdcsuiRegexp { get; set; }Property Value
| Type | Description |
|---|---|
| string | Metadata used by Oracle Identity Cloud Service UI to validate the attribute values using regular expressions.
|
IdcsuiVisible
Declaration
[JsonProperty(PropertyName = "idcsuiVisible")]
public bool? IdcsuiVisible { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Metadata used by Oracle Identity Cloud Service UI to decide whether the attribute must be displayed on the Account Form.
|
IdcsuiWidget
Declaration
[JsonProperty(PropertyName = "idcsuiWidget")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SchemaSubAttributes.IdcsuiWidgetEnum? IdcsuiWidget { get; set; }Property Value
| Type | Description |
|---|---|
| SchemaSubAttributes.IdcsuiWidgetEnum? | Metadata used by Oracle Identity Cloud Service UI to render a widget for this attribute on the Account Form.
|
MultiValued
Declaration
[JsonProperty(PropertyName = "multiValued")]
public bool? MultiValued { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Indicates the attribute's plurality
|
Mutability
Declaration
[JsonProperty(PropertyName = "mutability")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SchemaSubAttributes.MutabilityEnum? Mutability { get; set; }Property Value
| Type | Description |
|---|---|
| SchemaSubAttributes.MutabilityEnum? | Specifies if the attribute is mutable
|
Name
Declaration
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| string | Attribute's name
|
ReferenceTypes
Declaration
[JsonProperty(PropertyName = "referenceTypes")]
public List<string> ReferenceTypes { get; set; }Property Value
| Type | Description |
|---|---|
| List<string> | The names of the Resource types that may be referenced--for example, User. This is only applicable for attributes that are of the \"reference\" data type.
|
Required
Declaration
[JsonProperty(PropertyName = "required")]
public bool? Required { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Specifies if the attribute is required
|
Returned
Declaration
[JsonProperty(PropertyName = "returned")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SchemaSubAttributes.ReturnedEnum? Returned { get; set; }Property Value
| Type | Description |
|---|---|
| SchemaSubAttributes.ReturnedEnum? | A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request
|
Type
Declaration
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SchemaSubAttributes.TypeEnum? Type { get; set; }Property Value
| Type | Description |
|---|---|
| SchemaSubAttributes.TypeEnum? | Attribute's data type--for example, String
|
Uniqueness
Declaration
[JsonProperty(PropertyName = "uniqueness")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SchemaSubAttributes.UniquenessEnum? Uniqueness { get; set; }Property Value
| Type | Description |
|---|---|
| SchemaSubAttributes.UniquenessEnum? | A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values. A server MAY reject an invalid value based on uniqueness by returning an HTTP response code of 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the Service Provider enforces. For example, a client could make a value unique while the server has a uniqueness of \"none\".
|