Directory Server Documentation Index
Configuration Reference Home

SCIM Attribute Mapping

Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.

Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.

SCIM Attribute Mappings define a mapping between SCIM Resource Type attributes and LDAP attributes.

↓Relations to This Component
↓Properties
↓dsconfig Usage

Relations to This Component

The following components have a direct composition relation to SCIM Attribute Mappings:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ scim-resource-type-attribute  None
↓ ldap-attribute
↓ readable
↓ writable
↓ searchable

Basic Properties

scim-resource-type-attribute

Description
The attribute path of SCIM Resource Type attributes to be mapped. Examples of valid attribute paths are:
  • 'name' - Maps the 'name' core attribute.
  • 'urn:extension:organization' - Maps the 'organization' extended attribute from the schema extension 'urn:extension'.
  • '*' - Wildcard to map all core attributes that are not otherwise mapped.
  • 'urn:extension:*' - Wildcard to map all extended attributes from the schema extension 'urn:extension' that are not otherwise mapped.
  • 'addresses[type eq "preferred"].postalCode' - Maps the postalCode sub-attribute of the address core attribute where the sub-attribute type equals 'preferred'. Only the equality filter on the type sub-attribute is supported as the value filter.
When mapping from LDAP to SCIM Resource Type, wildcard mappings are performed first before the other mappings so the values from more specific mappings will have precedence when there is a conflict.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

ldap-attribute

Description
The LDAP attribute to be mapped, or the path to a specific field of an LDAP attribute with the JSON object attribute syntax. Examples:
  • 'name' - Maps the 'name' attribute.
  • 'name.last' - Maps only the last name field of the 'name' attribute.

Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

readable

Description
Specifies whether the mapping is used to map from LDAP attribute to SCIM Resource Type attribute in a read operation.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

writable

Description
Specifies that the mapping is used to map from SCIM Resource Type attribute to LDAP attribute in a write operation.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

searchable

Description
Specifies that the mapping is used to map from SCIM Resource Type attribute to LDAP attribute in a search filter.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured SCIM Attribute Mappings:

dsconfig list-scim-attribute-mappings
     [--property {propertyName}] ...

To view the configuration for an existing SCIM Attribute Mapping:

dsconfig get-scim-attribute-mapping-prop
     --mapping-name {name}
     --type-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing SCIM Attribute Mapping:

dsconfig set-scim-attribute-mapping-prop
     --mapping-name {name}
     --type-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new SCIM Attribute Mapping:

dsconfig create-scim-attribute-mapping
     --mapping-name {name}
     --type-name {name}
     --set scim-resource-type-attribute:{propertyValue}
     --set ldap-attribute:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing SCIM Attribute Mapping:

dsconfig delete-scim-attribute-mapping
     --mapping-name {name}
     --type-name {name}