Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
The Static Value SCIM2 Attribute Mapping may be used to generate SCIMv2 attributes with predefined static values, rather than deriving values from information in the source entry.
If this attribute mapping is declared to be single-valued, then the SCIMv2 representation of the attribute will be a single JSON string, Boolean, number, null, or object, based on the selected data type. If it is declared to be multivalued, then the SCIMv2 representation of the attribute will encapsulate the values in a JSON array (even if only a single value is specified).
The Static Value SCIM2 Attribute Mapping component inherits from the SCIM2 Attribute Mapping
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| scim-attribute-name | |
| attribute-usage | |
| failed-mapping-behavior | |
| always-patch-with-replace | |
| data-type | |
| value | |
| single-valued |
| Description | A description for this SCIM2 Attribute Mapping |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The name of the attribute as it appears in the SCIMv2 representation of an entry. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The way in which this attribute is expected to be used when synchronizing with a SCIMv2 server. |
| Default Value | None |
| Allowed Values | fetch - The attribute should be used to create the LDAP representation of an entry from the SCIMv2 representation of the entry. create-during-realtime-sync - The attribute should be included when creating an entry in the SCIMv2 server during realtime synchronization. create-during-resync - The attribute should be included when creating an entry in the SCIMv2 server during realtime synchronization. update-during-realtime-sync - The attribute should be included when applying changes to an existing entry in a SCIMv2 server during realtime synchronization. update-during-resync - The attribute should be included when applying changes to an existing entry in a SCIMv2 server during a resync. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The behavior the server should exhibit when an error is encountered while trying to map between the LDAP and SCIMv2 representations of an attribute (for example, if a value cannot be parsed in accordance with the expected syntax). |
| Default Value | reject |
| Allowed Values | reject - The associated synchronization operation will fail. ignore-entire-attribute - Processing for the associated synchronization operation will proceed as if the entire attribute had not been present in the entry. For multivalued attributes, this behavior indicates that the entire attribute will be ignored if any value cannot be mapped, even if other values in the attribute can be successfully mapped. ignore-individual-values - Processing for the associated synchronization operation will proceed as if any unmappable values do not exist in the entry. For single-valued attributes, and for multivalued attributes in which none of the values can be successfully mapped, then the behavior will be the same as for ignore-entire-attribute. For multivalued attributes in which some values can be successfully mapped but others cannot, processing will proceed as if only the mappable values were present and unmappable values will be ignored. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether to always use the "replace" operation type when updating this attribute in an existing SCIM entry with an HTTP PATCH operation. This property only applies to attribute mappings that allow a given SCIM attribute to have multiple values. The replace operation type will always be used for attribute mappings for single-valued attributes. By default, PATCH operations that alter an existing attribute in a SCIM entry will try to add or remove individual values when possible rather than replacing the entire set of values. However, in some cases, it may be desirable to always use the replace operation type. For example, some SCIMv2 servers may have special support for passwords such that they will allow clients to set passwords but will not allow retrieving them (whether in the clear or in an encoded form). In such cases, this property must be set to true because otherwise when updating a user's password, the server may try to add a new value rather than replacing the existing value. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The JSON data type for the resulting SCIMv2 values. |
| Default Value | None |
| Allowed Values | boolean - Indicates that the value should be presented as a JSON boolean. Exactly one value must be specified, and it must be either "true" or "false". null - Indicates that the value should be presented as a JSON null. In this case, no value should be specified. number - Indicates that each value should be presented as a JSON number. One or more values must be specified (although multiple values will only be allowed if the single-valued property has a value of false), and all values must represent valid JSON numbers. object - Indicates that each value should be presented as a JSON object, representing a complex SCIMv2 attribute. One or more values must be specified (although multiple values will only be allowed if the single-valued property has a value of false), and all values must represent valid JSON objects. string - Indicates that each value should be presented as a JSON string. One or more values must be specified (although multiple values will only be allowed if the single-valued property has a value of false). |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The static value or set of values to use for the resulting SCIMv2 attribute. All provided values must satisfy all appropriate constraints based on the specified data-type. Multiple values may only be provided if allowed by the data type, and if the single-valued property has a value of false. If the data-type property has a value of null, then no value may be specified. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the SCIMv2 attribute will be considered single-valued or multivalued. If this is set to true, then only a single value may be specified, and it will be presented as the appropriate JSON data type that will not be encapsulated in an array. If this is set to false, then multiple values may be specified if allowed by the configured data-type. The resulting SCIMv2 attribute will have its values encapsulated in a JSON array (even in cases where the data-type does not allow multiple values, including Boolean and null). |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured SCIM2 Attribute Mappings:
dsconfig list-scim2-attribute-mappings
[--property {propertyName}] ...
To view the configuration for an existing SCIM2 Attribute Mapping:
dsconfig get-scim2-attribute-mapping-prop
--mapping-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing SCIM2 Attribute Mapping:
dsconfig set-scim2-attribute-mapping-prop
--mapping-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Static Value SCIM2 Attribute Mapping:
dsconfig create-scim2-attribute-mapping
--mapping-name {name}
--type static-value
--set scim-attribute-name:{propertyValue}
--set attribute-usage:{propertyValue}
--set data-type:{propertyValue}
--set single-valued:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing SCIM2 Attribute Mapping:
dsconfig delete-scim2-attribute-mapping
--mapping-name {name}