Enabling the Import of Custom User Schema Attributes

To import data into your new schema attributes using a .csv file, you must first set column name values for the new attributes.

In this example, a new user attribute was created called employeeStatus. To set the column name value for this attribute so that you can import data to that attribute from a .csv file, internally map the attribute to idcsCsvAttributeNameMappings.

Example PATCH Request

The following request example shows how to set the column name value for the employeeStatus string custom attribute.

PATCH /admin/v1/Schemas/urn:ietf:params:scim:schemas:idcs:extension:custom:User
{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "add",
            "path": "attributes[name eq \"employeeStatus\"].idcsCsvAttributeNameMappings",
            "value": [
                {
                    "columnHeaderName": "Employee Status"
                }
            ]
        }
    ]
}

You can now import data using a .csv file that includes a column (with data) that is named Employee Status.

The following request example shows how to set a column name for a string array custom attribute named Favorite Colors whose values would be comma delimited in a .csv file.

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "add",
            "path": "attributes[name eq \"favoriteColors\"].idcsCsvAttributeNameMappings",
            "value": [
                {
                    "columnHeaderName": "Favorite Colors",
                    "multiValueDelimiter": ","
                }
            ]
        }
    ]
}

More Information

  • See Importing for the use case on importing user data using the Oracle Identity Cloud Service REST APIs.