Custom User Attributes

Custom User Attributes allow you to add in custom pieces of information that belong to your user to add to the standard user attributes that are beyond standard SCIM fields.

For example, add a department, company car type, company phone type, etc. to your users. This allows you to specifically target users with these custom attributes that suit your business and needs.

Set up an audience, topic, feed, etc. that targets these users. You may need to send out campaigns notifying members on upcoming upgrades, updates, servicing, etc.

Technical Overview

Custom attributes must be passed as an array of { name, value } objects under the customAttributes field.

• customAttributes must be an array of objects, each with a name and value.
• Values must be strings (even for booleans or numbers).
• Custom attributes are case-sensitive and must be explicitly named.
• Sending invalid or improperly structured data will result in a 422 error.

Schema Reference

To view the structure of Firstup’s custom attributes, use: GET /scim/v2/Schemas/urn:SocialChorus:1.0:User

This endpoint returns the full definition of the urn:SocialChorus:1.0:User schema extension, including the customAttributes array and its format.

Endpoint

Add Custom Attributes

When creating a new user through the POST /scim/v2/users endpoint, you can include custom attributes that are specific to that user. These attributes can be anything you need, such as car type, phone model, or any other personalized data.

Syntax

Custom Attributes are a list of objects that belong to the urn:SocialChorus:1.0:User identifier.

Endpoint

Request Body Example

{
  "userName": "BBBTest",
  "schemas": [
    "urn:SocialChorus:1.0:User",
    "urn:SocialChorus:1.0:User"
  ],
  "name": {
    "givenName": "BBB",
    "familyName": "TestBBB"
  },
  "active": true,
  "urn:SocialChorus:1.0:User": {
    "customAttributes": [
      {"name": "car", "value": "Honda"},
      {"name": "phone", "value": "iPhone"}
    ]
  }
}

Update Custom Attributes (PATCH)

Endpoint

Request Body Example

{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "replace",
"path": "urn:SocialChorus:1.0:User.customAttributes",
"value": [
{ "name": "favorite_color", "value": "blue" },
{ "name": "certified", "value": "false" }
]
}
]
}

Refer to User Editing for further guidance and more examples.