Background

User attributes can be provisioned to users from your directory via the SCIM connection. However if you have user attributes you want to provision to users that are not available in your directory, you can use this API to provision them directly from your HRIS.

This API will put the attributes into a holding location they are not immediately applied to users. When the directory management report is run the values will be applied.

Authentication

This API supports both Basic Auth and HMAC authentication. You must use the method that corresponds to how your API key is configured.

Ensure your endpoint path matches your auth type (e.g., /basic for Basic Auth).

Request Body Schema

The request payload must be sent as application/json and contain a single userAttributes array.

Field	Type	Required	Description
`userAttributes`	`array`	Yes	An array of objects defining the users and attributes.
`userName`	`string`	Yes	The UPN for the user.
`attributes`	`object`	Yes	The map of attributes and values to be written.

Example attribute information:

"userAttributes": [
        {
            "attributes": {
                "department": "engineering",
                "costCenter": "cc-1234"
            },
            "userName": "jane.doe@example.com"
        }
    ]

Validation Rules

To ensure successful processing, your payload must adhere to the following rules:

Users must be provisioned before their attributes can be sent Usernames that cannot be found are skipped and reported back in the response body.

No duplicate emails the response will have an explicit result for each userAttributes entry, duplicate email entries in the request body is rejected with 400.

Process

Because this API applies attributes to existing users, the following process should be followed:

Provision users to Calven via SCIM

Configure attribute settings for your users

Apply extra attributes to users via this API

Run the directory management report to apply attributes to users

User Attributes Overview

Background#

Authentication#

Request Body Schema#

Example attribute information:#